mirror of
https://github.com/jekyll/jekyll.git
synced 2026-04-28 03:01:03 -04:00
Compare commits
21 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e0d49e2c01 | ||
|
|
001ad63a60 | ||
|
|
c8ad29e459 | ||
|
|
981f4175fe | ||
|
|
d7e70c4751 | ||
|
|
628d62b4c6 | ||
|
|
610d461346 | ||
|
|
93a6ee6b7d | ||
|
|
bc1f5bb6e9 | ||
|
|
dc377aeaed | ||
|
|
35eb9dfd09 | ||
|
|
e159fb4b80 | ||
|
|
48f604fabd | ||
|
|
fce731ea45 | ||
|
|
b8cecdfd0e | ||
|
|
313ad449cd | ||
|
|
f4a1d9ce6a | ||
|
|
1f931b3e30 | ||
|
|
06a14739db | ||
|
|
622f37ecc8 | ||
|
|
0cdd14eb1e |
@@ -3,7 +3,6 @@ engines:
|
||||
enabled: false
|
||||
rubocop:
|
||||
enabled: true
|
||||
channel: rubocop-0-54
|
||||
|
||||
exclude_paths:
|
||||
- .codeclimate.yml
|
||||
@@ -29,8 +28,6 @@ exclude_paths:
|
||||
- test/**/*
|
||||
- vendor/**/*
|
||||
|
||||
- lib/jekyll/commands/serve/livereload_assets/livereload.js
|
||||
|
||||
ratings:
|
||||
paths:
|
||||
- lib/**/*.rb
|
||||
|
||||
86
.github/CODEOWNERS
vendored
86
.github/CODEOWNERS
vendored
@@ -1,86 +0,0 @@
|
||||
# The Jekyll project has 6 affinity teams, shown here: https://teams.jekyllrb.com/
|
||||
# They are as follows:
|
||||
#
|
||||
# 1. @jekyll/build
|
||||
# 2. @jekyll/documentation
|
||||
# 3. @jekyll/ecosystem
|
||||
# 4. @jekyll/performance
|
||||
# 5. @jekyll/stability
|
||||
# 6. @jekyll/windows
|
||||
#
|
||||
# Each of these teams has a mission. Wherever possible, GitHub should
|
||||
# automatically require review from these teams on the pieces of the
|
||||
# repository they maintain.
|
||||
|
||||
# @jekyll/documentation
|
||||
/docs/ @jekyll/documentation
|
||||
|
||||
# @jekyll/build
|
||||
/exe/ @jekyll/build
|
||||
/lib/jekyll.rb @jekyll/build
|
||||
/lib/jekyll/cleaner.rb @jekyll/build
|
||||
/lib/jekyll/collection.rb @jekyll/build
|
||||
/lib/jekyll/command.rb @jekyll/build
|
||||
/lib/jekyll/commands/ @jekyll/build
|
||||
/lib/jekyll/converter.rb @jekyll/build
|
||||
/lib/jekyll/converters/ @jekyll/build
|
||||
/lib/jekyll/convertible.rb @jekyll/build
|
||||
/lib/jekyll/document.rb @jekyll/build
|
||||
/lib/jekyll/drops/ @jekyll/build
|
||||
/lib/jekyll/entry_filter.rb @jekyll/build
|
||||
/lib/jekyll/errors.rb @jekyll/build
|
||||
/lib/jekyll/excerpt.rb @jekyll/build
|
||||
/lib/jekyll/filters/ @jekyll/build
|
||||
/lib/jekyll/filters.rb @jekyll/build
|
||||
/lib/jekyll/layout.rb @jekyll/build
|
||||
/lib/jekyll/liquid_extensions.rb @jekyll/build
|
||||
/lib/jekyll/liquid_renderer/ @jekyll/build
|
||||
/lib/jekyll/liquid_renderer.rb @jekyll/build
|
||||
/lib/jekyll/log_adapter.rb @jekyll/build
|
||||
/lib/jekyll/mime.types @jekyll/build
|
||||
/lib/jekyll/page.rb @jekyll/build
|
||||
/lib/jekyll/publisher.rb @jekyll/build
|
||||
/lib/jekyll/reader.rb @jekyll/build
|
||||
/lib/jekyll/readers/ @jekyll/build
|
||||
/lib/jekyll/regenerator.rb @jekyll/build
|
||||
/lib/jekyll/related_posts.rb @jekyll/build
|
||||
/lib/jekyll/renderer.rb @jekyll/build
|
||||
/lib/jekyll/site.rb @jekyll/build
|
||||
/lib/jekyll/static_file.rb @jekyll/build
|
||||
/lib/jekyll/stevenson.rb @jekyll/build
|
||||
/lib/jekyll/tags/ @jekyll/build
|
||||
/lib/jekyll/url.rb @jekyll/build
|
||||
/lib/jekyll/utils/ @jekyll/build
|
||||
/lib/jekyll/utils.rb @jekyll/build
|
||||
|
||||
# @jekyll/ecosystem
|
||||
/lib/jekyll/external.rb @jekyll/ecosystem
|
||||
/lib/jekyll/generator.rb @jekyll/ecosystem
|
||||
/lib/jekyll/hooks.rb @jekyll/ecosystem
|
||||
/lib/jekyll/plugin.rb @jekyll/ecosystem
|
||||
/lib/jekyll/plugin_manager.rb @jekyll/ecosystem
|
||||
/lib/jekyll/theme.rb @jekyll/ecosystem
|
||||
/lib/jekyll/theme_builder.rb @jekyll/ecosystem
|
||||
|
||||
# @jekyll/stability
|
||||
Gemfile @jekyll/stability
|
||||
*.gemspec @jekyll/stability
|
||||
.travis.yml @jekyll/stability
|
||||
appveyor.yml @jekyll/stability
|
||||
/lib/jekyll/configuration.rb @jekyll/stability
|
||||
/lib/jekyll/deprecator.rb @jekyll/stability
|
||||
/lib/jekyll/frontmatter_defaults.rb @jekyll/stability
|
||||
/lib/site_template @jekyll/stability
|
||||
/lib/theme_template @jekyll/stability
|
||||
/features/ @jekyll/stability
|
||||
/test/ @jekyll/stability
|
||||
|
||||
# Special cases
|
||||
.github/ @jekyll/affinity-team-captains
|
||||
CODE_OF_CONDUCT.markdown @jekyll/affinity-team-captains
|
||||
History.markdown @jekyll/affinity-team-captains
|
||||
LICENSE @jekyll/affinity-team-captains # This file should never change.
|
||||
README.markdown @jekyll/affinity-team-captains
|
||||
/lib/jekyll/version.rb @jekyll/affinity-team-captains
|
||||
/rake/ @jekyll/affinity-team-captains
|
||||
/script/ @jekyll/affinity-team-captains
|
||||
27
.github/CONTRIBUTING.markdown
vendored
27
.github/CONTRIBUTING.markdown
vendored
@@ -4,7 +4,10 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a
|
||||
|
||||
## Where to get help or report a problem
|
||||
|
||||
See [the support guidelines](https://jekyllrb.com/docs/support/)
|
||||
* If you have a question about using Jekyll, start a discussion on [Jekyll Talk](https://talk.jekyllrb.com).
|
||||
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository.
|
||||
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
|
||||
* More resources are listed on our [Help page](https://jekyllrb.com/help/).
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
@@ -25,7 +28,7 @@ Whether you're a developer, a designer, or just a Jekyll devotee, there are lots
|
||||
|
||||
* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
|
||||
|
||||
* Pull requests are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
|
||||
* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
|
||||
|
||||
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
|
||||
|
||||
@@ -111,37 +114,25 @@ If your contribution changes any Jekyll behavior, make sure to update the docume
|
||||
|
||||
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
|
||||
|
||||
* You can use the command `script/console` to start a REPL to explore the result of
|
||||
Jekyll's methods. It also provides you with helpful methods to quickly create a
|
||||
site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console)
|
||||
|
||||
## Running tests locally
|
||||
|
||||
### Test Dependencies
|
||||
|
||||
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
|
||||
|
||||
```sh
|
||||
script/bootstrap
|
||||
```
|
||||
<pre class="highlight"><code>$ script/bootstrap</code></pre>
|
||||
|
||||
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
|
||||
|
||||
```sh
|
||||
script/cibuild
|
||||
```
|
||||
<pre class="highlight"><code>$ script/cibuild</code></pre>
|
||||
|
||||
If you are only updating a file in `test/`, you can use the command:
|
||||
|
||||
```sh
|
||||
script/test test/blah_test.rb
|
||||
```
|
||||
<pre class="highlight"><code>$ script/test test/blah_test.rb</code></pre>
|
||||
|
||||
If you are only updating a `.feature` file, you can use the command:
|
||||
|
||||
```sh
|
||||
script/cucumber features/blah.feature
|
||||
```
|
||||
<pre class="highlight"><code>$ script/cucumber features/blah.feature</code></pre>
|
||||
|
||||
Both `script/test` and `script/cucumber` can be run without arguments to
|
||||
run its entire respective suite.
|
||||
|
||||
8
.github/ISSUE_TEMPLATE.md
vendored
8
.github/ISSUE_TEMPLATE.md
vendored
@@ -10,12 +10,14 @@
|
||||
a generic usage question, please consider asking your question at
|
||||
https://talk.jekyllrb.com where non-bug questions go.
|
||||
|
||||
Please make sure to mention an affinity team whose responsibilities
|
||||
most closely align with your issue.
|
||||
|
||||
Thanks!
|
||||
-->
|
||||
|
||||
- [ ] I believe this to be a bug, not a question about using Jekyll.
|
||||
- [ ] I updated to the latest Jekyll (or) if on GitHub Pages to the latest `github-pages`
|
||||
- [ ] I ran `jekyll doctor` to check my configuration
|
||||
- [ ] I read the CONTRIBUTION file at https://jekyllrb.com/docs/contributing/
|
||||
- [ ] This is a feature request.
|
||||
|
||||
@@ -48,7 +50,7 @@
|
||||
## My Reproduction Steps
|
||||
|
||||
<!--
|
||||
If this error occurred on GitHub Pages, please try to provide us with logs,
|
||||
If this error occured on GitHub Pages, please try to provide us with logs,
|
||||
and look at them yourself, to determine if this is an actual Jekyll bug. In
|
||||
the event you are unsure, file a ticket, however, when you do please provide
|
||||
the logs (strip them of personal information.)
|
||||
@@ -76,3 +78,5 @@
|
||||
The minimum should be personal information. Though we normally don't log
|
||||
anything like that so there should be no need to alter it.
|
||||
-->
|
||||
|
||||
/cc include any Jekyll affinity teams here (see https://teams.jekyllrb.com/ for more info)
|
||||
|
||||
20
.github/SUPPORT.markdown
vendored
20
.github/SUPPORT.markdown
vendored
@@ -1,20 +0,0 @@
|
||||
# Jekyll Support
|
||||
|
||||
## Getting Help
|
||||
|
||||
**Jekyll's issue tracker is not a support forum.**
|
||||
|
||||
If you're looking for support for Jekyll, there are a lot of options:
|
||||
|
||||
* Read [Jekyll Documentation](https://jekyllrb.com/docs/home/)
|
||||
* If you have a question about using Jekyll, start a discussion on [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll)
|
||||
* Chat with Jekyllers — Join [our Gitter channel](https://gitter.im/jekyll/jekyll) or [our IRC channel on Freenode](irc:irc.freenode.net/jekyll)
|
||||
|
||||
There are a bunch of helpful community members on these services that should be willing to point you in the right direction.
|
||||
|
||||
## Report a bug
|
||||
|
||||
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository — First [look for the plugin on rubygems](https://rubygems.org/) then click on the `Homepage` link to access the plugin repository.
|
||||
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
|
||||
|
||||
Happy Jekyllin'!
|
||||
44
.github/first-timers-issue-template.md
vendored
44
.github/first-timers-issue-template.md
vendored
@@ -1,44 +0,0 @@
|
||||
### 🆕🐥☝ First Timers Only.
|
||||
|
||||
This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝
|
||||
|
||||
[About First Timers Only](http://www.firsttimersonly.com/).
|
||||
|
||||
### 🤔 What you will need to know.
|
||||
|
||||
Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.
|
||||
|
||||
### 📋 Step by Step
|
||||
|
||||
- [ ] 👌 **Join the team**: Add yourself to a Jekyll affinity team.
|
||||
|
||||
Go to [teams.jekyllrb.com](https://teams.jekyllrb.com/) and join a team that best fits your interests. Once you click the link to join a team, you will soon receive an email inviting you to join the Jekyll organization.
|
||||
|
||||
- [ ] 🙋 **Claim this issue**: Comment below.
|
||||
|
||||
Leave a comment that you have claimed this issue.
|
||||
|
||||
- [ ] 📝 **Update** the file [$FILENAME]($BRANCH_URL) in the `$REPO` repository (press the little pen Icon) and edit the line as shown below.
|
||||
|
||||
|
||||
```diff
|
||||
$DIFF
|
||||
```
|
||||
|
||||
|
||||
- [ ] 💾 **Commit** your changes
|
||||
|
||||
- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request:
|
||||
|
||||
1. If you are familiar with the terminal or would like to learn it, [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) on how to send a pull request using the terminal.
|
||||
|
||||
2. You can [edit files directly in your browser](https://help.github.com/articles/editing-files-in-your-repository/)
|
||||
|
||||
- [ ] 🏁 **Done** Ask in comments for a review :)
|
||||
|
||||
### 🤔❓ Questions
|
||||
|
||||
Leave a comment below!
|
||||
|
||||
|
||||
This issue was created by [First-Timers-Bot](https://github.com/hoodiehq/first-timers-bot).
|
||||
6
.github/first-timers.yml
vendored
6
.github/first-timers.yml
vendored
@@ -1,6 +0,0 @@
|
||||
repository: jekyll
|
||||
labels:
|
||||
- good first issue
|
||||
- help-wanted
|
||||
- first-time-only
|
||||
template: .github/first-timers-issue-template.md
|
||||
135
.rubocop.yml
135
.rubocop.yml
@@ -1,48 +1,21 @@
|
||||
---
|
||||
|
||||
require:
|
||||
- ./rubocop/jekyll
|
||||
|
||||
Jekyll/NoPutsAllowed:
|
||||
Exclude:
|
||||
- rake/*.rake
|
||||
|
||||
AllCops:
|
||||
TargetRubyVersion: 2.3
|
||||
TargetRubyVersion: 2.0
|
||||
Include:
|
||||
- lib/**/*.rb
|
||||
- test/**/*.rb
|
||||
Exclude:
|
||||
- lib/jekyll/renderer.rb
|
||||
- bin/**/*
|
||||
- exe/**/*
|
||||
- benchmark/**/*
|
||||
- script/**/*
|
||||
- vendor/**/*
|
||||
- tmp/**/*
|
||||
Layout/AlignHash:
|
||||
EnforcedHashRocketStyle: table
|
||||
Layout/IndentationWidth:
|
||||
Severity: error
|
||||
Layout/IndentArray:
|
||||
EnforcedStyle: consistent
|
||||
Layout/IndentHash:
|
||||
EnforcedStyle: consistent
|
||||
Layout/MultilineMethodCallIndentation:
|
||||
EnforcedStyle: indented
|
||||
Layout/MultilineOperationIndentation:
|
||||
EnforcedStyle: indented
|
||||
Lint/NestedPercentLiteral:
|
||||
Exclude:
|
||||
- test/test_site.rb
|
||||
Layout/EmptyComment:
|
||||
Enabled: false
|
||||
Layout/EndAlignment:
|
||||
Lint/EndAlignment:
|
||||
Severity: error
|
||||
Lint/UnreachableCode:
|
||||
Severity: error
|
||||
Lint/Void:
|
||||
Exclude:
|
||||
- lib/jekyll/site.rb
|
||||
Lint/UselessAccessModifier:
|
||||
Enabled: false
|
||||
Metrics/AbcSize:
|
||||
Max: 21
|
||||
Metrics/BlockLength:
|
||||
@@ -50,26 +23,20 @@ Metrics/BlockLength:
|
||||
- test/**/*.rb
|
||||
- lib/jekyll/configuration.rb
|
||||
- rake/*.rake
|
||||
- jekyll.gemspec
|
||||
Metrics/ClassLength:
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb$/
|
||||
- !ruby/regexp /test\/.*.rb$/
|
||||
- lib/jekyll/document.rb
|
||||
- lib/jekyll/site.rb
|
||||
- lib/jekyll/commands/serve.rb
|
||||
- lib/jekyll/configuration.rb
|
||||
Max: 240
|
||||
Max: 300
|
||||
Metrics/CyclomaticComplexity:
|
||||
Exclude:
|
||||
- lib/jekyll/utils.rb
|
||||
- lib/jekyll/commands/serve.rb
|
||||
Max: 9
|
||||
Metrics/LineLength:
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb/
|
||||
- Rakefile
|
||||
- rake/*.rake
|
||||
- Gemfile
|
||||
Max: 100
|
||||
Max: 90
|
||||
Severity: warning
|
||||
Metrics/MethodLength:
|
||||
CountComments: false
|
||||
@@ -81,19 +48,6 @@ Metrics/ParameterLists:
|
||||
Max: 4
|
||||
Metrics/PerceivedComplexity:
|
||||
Max: 8
|
||||
Naming/FileName:
|
||||
Enabled: false
|
||||
Naming/HeredocDelimiterNaming:
|
||||
Exclude:
|
||||
- test/**/*.rb
|
||||
Naming/MemoizedInstanceVariableName:
|
||||
Exclude:
|
||||
- lib/jekyll/page_without_a_file.rb
|
||||
- lib/jekyll/drops/unified_payload_drop.rb
|
||||
- lib/jekyll/drops/site_drop.rb
|
||||
Naming/UncommunicativeMethodParamName:
|
||||
AllowedNames:
|
||||
- _
|
||||
Security/MarshalLoad:
|
||||
Exclude:
|
||||
- !ruby/regexp /test\/.*.rb$/
|
||||
@@ -102,34 +56,58 @@ Security/YAMLLoad:
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb/
|
||||
- !ruby/regexp /test\/.*.rb$/
|
||||
Style/AccessModifierDeclarations:
|
||||
Enabled: false
|
||||
Style/Alias:
|
||||
EnforcedStyle: prefer_alias_method
|
||||
Enabled: false
|
||||
Style/AlignArray:
|
||||
Enabled: false
|
||||
Style/AlignHash:
|
||||
EnforcedHashRocketStyle: table
|
||||
Style/AlignParameters:
|
||||
Enabled: false
|
||||
EnforcedStyle: with_fixed_indentation
|
||||
Style/AndOr:
|
||||
Severity: error
|
||||
Style/Attr:
|
||||
Enabled: false
|
||||
Style/BracesAroundHashParameters:
|
||||
Enabled: false
|
||||
Style/ClassAndModuleChildren:
|
||||
Exclude:
|
||||
- test/**/*.rb
|
||||
Style/FrozenStringLiteralComment:
|
||||
EnforcedStyle: always
|
||||
Enabled: false
|
||||
Style/Documentation:
|
||||
Enabled: false
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb$/
|
||||
Style/DoubleNegation:
|
||||
Enabled: false
|
||||
Style/FormatStringToken:
|
||||
Exclude:
|
||||
- lib/jekyll/utils/ansi.rb
|
||||
Style/EmptyLinesAroundAccessModifier:
|
||||
Enabled: false
|
||||
Style/EmptyLinesAroundModuleBody:
|
||||
Enabled: false
|
||||
Style/ExtraSpacing:
|
||||
AllowForAlignment: true
|
||||
Style/FileName:
|
||||
Enabled: false
|
||||
Style/FirstParameterIndentation:
|
||||
EnforcedStyle: consistent
|
||||
Style/GuardClause:
|
||||
Enabled: false
|
||||
Style/HashSyntax:
|
||||
EnforcedStyle: hash_rockets
|
||||
Severity: error
|
||||
Style/MixinUsage:
|
||||
Exclude:
|
||||
- test/helper.rb
|
||||
Style/IfUnlessModifier:
|
||||
Enabled: false
|
||||
Style/IndentArray:
|
||||
EnforcedStyle: consistent
|
||||
Style/IndentHash:
|
||||
EnforcedStyle: consistent
|
||||
Style/IndentationWidth:
|
||||
Severity: error
|
||||
Style/ModuleFunction:
|
||||
Enabled: false
|
||||
Style/MultilineMethodCallIndentation:
|
||||
EnforcedStyle: indented
|
||||
Style/MultilineOperationIndentation:
|
||||
EnforcedStyle: indented
|
||||
Style/MultilineTernaryOperator:
|
||||
Severity: error
|
||||
Style/PercentLiteralDelimiters:
|
||||
@@ -141,22 +119,27 @@ Style/PercentLiteralDelimiters:
|
||||
"%w": "()"
|
||||
"%W": "()"
|
||||
"%x": "()"
|
||||
Style/RedundantReturn:
|
||||
Enabled: false
|
||||
Style/RedundantSelf:
|
||||
Enabled: false
|
||||
Style/RegexpLiteral:
|
||||
EnforcedStyle: percent_r
|
||||
Style/RescueModifier:
|
||||
Enabled: false
|
||||
Style/SafeNavigation:
|
||||
Exclude:
|
||||
- lib/jekyll/document.rb
|
||||
Style/SignalException:
|
||||
EnforcedStyle: only_raise
|
||||
Style/SingleLineMethods:
|
||||
Enabled: false
|
||||
Style/SpaceAroundOperators:
|
||||
Enabled: false
|
||||
Style/SpaceInsideBrackets:
|
||||
Enabled: false
|
||||
Style/StringLiterals:
|
||||
EnforcedStyle: double_quotes
|
||||
Style/StringLiteralsInInterpolation:
|
||||
EnforcedStyle: double_quotes
|
||||
Style/SymbolArray:
|
||||
EnforcedStyle: brackets
|
||||
Style/TrailingCommaInArrayLiteral:
|
||||
EnforcedStyleForMultiline: consistent_comma
|
||||
Style/TrailingCommaInHashLiteral:
|
||||
Style/TrailingCommaInLiteral:
|
||||
EnforcedStyleForMultiline: consistent_comma
|
||||
Style/UnneededCapitalW:
|
||||
Enabled: false
|
||||
|
||||
16
.travis.yml
16
.travis.yml
@@ -5,19 +5,17 @@ language: ruby
|
||||
sudo: false
|
||||
|
||||
rvm:
|
||||
- &ruby1 2.5.1
|
||||
- &ruby2 2.4.4
|
||||
- &ruby3 2.3.7
|
||||
- &jruby jruby-9.1.16.0
|
||||
- &ruby1 2.3.3
|
||||
- &ruby2 2.2.6
|
||||
- &ruby3 2.1.9
|
||||
- &jruby jruby-9.1.7.0
|
||||
|
||||
matrix:
|
||||
include:
|
||||
- rvm: *ruby1
|
||||
env: TEST_SUITE=fmt
|
||||
name: "🤖️ Code Format"
|
||||
- rvm: *ruby1
|
||||
env: TEST_SUITE=default-site
|
||||
name: "🏠️ Default Site"
|
||||
exclude:
|
||||
- rvm: *jruby
|
||||
env: TEST_SUITE=cucumber
|
||||
@@ -30,7 +28,7 @@ branches:
|
||||
only:
|
||||
- master
|
||||
- themes
|
||||
- /*-stable/
|
||||
- 3.4-stable*
|
||||
|
||||
notifications:
|
||||
slack:
|
||||
@@ -51,7 +49,3 @@ addons:
|
||||
# regular test configuration
|
||||
after_success:
|
||||
- bundle exec codeclimate-test-reporter
|
||||
|
||||
before_install:
|
||||
- gem update --system
|
||||
- gem install bundler --version 1.16.2
|
||||
|
||||
@@ -1,46 +0,0 @@
|
||||
# Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting a project maintainer. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html][version]
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org/
|
||||
[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
@@ -1,10 +1,4 @@
|
||||
---
|
||||
title: Code of Conduct
|
||||
permalink: "/docs/code_of_conduct/"
|
||||
note: This file is autogenerated. Edit /CODE_OF_CONDUCT.markdown instead.
|
||||
redirect_from: "/conduct/index.html"
|
||||
editable: false
|
||||
---
|
||||
# Code of Conduct
|
||||
|
||||
As contributors and maintainers of this project, and in the interest of
|
||||
fostering an open and welcoming community, we pledge to respect all people who
|
||||
33
Gemfile
33
Gemfile
@@ -1,10 +1,11 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
source "https://rubygems.org"
|
||||
gemspec :name => "jekyll"
|
||||
|
||||
gem "rake", "~> 12.0"
|
||||
|
||||
# Dependency of jekyll-mentions. RubyGems in Ruby 2.1 doesn't shield us from this.
|
||||
gem "activesupport", "~> 4.2", :groups => [:test_legacy, :site] if RUBY_VERSION < "2.2.2"
|
||||
|
||||
group :development do
|
||||
gem "launchy", "~> 2.3"
|
||||
gem "pry"
|
||||
@@ -18,16 +19,14 @@ end
|
||||
|
||||
group :test do
|
||||
gem "codeclimate-test-reporter", "~> 1.0.5"
|
||||
gem "cucumber", "~> 3.0"
|
||||
gem "httpclient"
|
||||
gem "cucumber", "~> 2.1"
|
||||
gem "jekyll_test_plugin"
|
||||
gem "jekyll_test_plugin_malicious"
|
||||
gem "nokogiri", "~> 1.7"
|
||||
gem "nokogiri"
|
||||
gem "rspec"
|
||||
gem "rspec-mocks"
|
||||
gem "rubocop", "~> 0.57.2"
|
||||
gem "test-dependency-theme", :path => File.expand_path("test/fixtures/test-dependency-theme", __dir__)
|
||||
gem "test-theme", :path => File.expand_path("test/fixtures/test-theme", __dir__)
|
||||
gem "rubocop", "~> 0.47"
|
||||
gem "test-theme", :path => File.expand_path("./test/fixtures/test-theme", File.dirname(__FILE__))
|
||||
|
||||
gem "jruby-openssl" if RUBY_ENGINE == "jruby"
|
||||
end
|
||||
@@ -35,13 +34,14 @@ end
|
||||
#
|
||||
|
||||
group :test_legacy do
|
||||
if RUBY_PLATFORM =~ %r!cygwin!
|
||||
if RUBY_PLATFORM =~ %r!cygwin! || RUBY_VERSION.start_with?("2.2")
|
||||
gem "test-unit"
|
||||
end
|
||||
|
||||
gem "minitest"
|
||||
gem "minitest-profile"
|
||||
gem "minitest-reporters"
|
||||
gem "redgreen"
|
||||
gem "shoulda"
|
||||
gem "simplecov"
|
||||
end
|
||||
@@ -63,20 +63,21 @@ group :jekyll_optional_dependencies do
|
||||
gem "coderay", "~> 1.1.0"
|
||||
gem "jekyll-coffeescript"
|
||||
gem "jekyll-docs", :path => "../docs" if Dir.exist?("../docs") && ENV["JEKYLL_VERSION"]
|
||||
gem "jekyll-feed", "~> 0.9"
|
||||
gem "jekyll-feed"
|
||||
gem "jekyll-gist"
|
||||
gem "jekyll-paginate"
|
||||
gem "jekyll-redirect-from"
|
||||
gem "kramdown", "~> 1.14"
|
||||
gem "kramdown", "~> 1.9"
|
||||
gem "mime-types", "~> 3.0"
|
||||
gem "rdoc", "~> 6.0"
|
||||
gem "tomlrb", "~> 1.2"
|
||||
gem "rdoc", "~> 5.0"
|
||||
gem "toml", "~> 0.1.0"
|
||||
|
||||
platform :ruby, :mswin, :mingw, :x64_mingw do
|
||||
gem "classifier-reborn", "~> 2.2.0"
|
||||
gem "classifier-reborn", "~> 2.1.0"
|
||||
gem "liquid-c", "~> 3.0"
|
||||
gem "pygments.rb", "~> 1.0"
|
||||
gem "yajl-ruby", "~> 1.3"
|
||||
gem "pygments.rb", "~> 0.6.0"
|
||||
gem "rdiscount", "~> 2.0"
|
||||
gem "redcarpet", "~> 3.2", ">= 3.2.3"
|
||||
end
|
||||
|
||||
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||
|
||||
696
History.markdown
696
History.markdown
@@ -1,669 +1,8 @@
|
||||
## HEAD
|
||||
|
||||
* Textile is only supported through a converter plugin (#7003)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Release post for v3.8.0 (#6849)
|
||||
* Add Installation Instructions for Ubuntu (#6925)
|
||||
* add liquid tag jekyll-flickr (#6946)
|
||||
* Add 4.0 development post (#6934)
|
||||
* Updated copy - fixed casing of SaaS on resources page. (#6949)
|
||||
* WIP: Do not advise users to install Jekyll outside of Bundler (#6927)
|
||||
* Don't prompt for sudo when installing with Ubuntu WSL (#6781)
|
||||
* Fix typo (#6969)
|
||||
* Add version number for group_by_exp doc (#6956)
|
||||
* Update Windows install docs (#6926)
|
||||
* Remove documentation for using Redcarpet (#6990)
|
||||
* Updated nginx configuration for custom-404-page documentation (#6994)
|
||||
* List all static files variables (#7002)
|
||||
* Document that _drafts need to be contained within the custom collection directory (#6985)
|
||||
* proposed change for passive voice. (#7005)
|
||||
* added the CAT plugin to the plugin list (#7011)
|
||||
* Updated to supported version (#7031)
|
||||
* Clarify definition of 'draft' (#7037)
|
||||
* Listed the jekyll-target-blank plugin in plugins list. (#7046)
|
||||
* Typo (#7058)
|
||||
* Add Hints for some Improved Travis Config in Doc (#7049)
|
||||
* Added plugin json-get. (#7086)
|
||||
* Update travis-ci.md to point out "this is an example Gemfile" (#7089)
|
||||
* Adding `jekyll-info` plugin (#7091)
|
||||
* GitHub enables you to use themes from other repos (#7112)
|
||||
* Updates to CODE OF CONDUCT (v1.4.0) (#7105)
|
||||
* Instructions to view theme’s files under Linux (#7095)
|
||||
* add jekyll-xml-source (#7114)
|
||||
* Add the jekyll-firstimage filter plugin (#7127)
|
||||
* Use a real theme in the example (#7125)
|
||||
* Update docs about post creation (#7138)
|
||||
* Add DEV Community's Jekyll tag to community page (#7139)
|
||||
* Initialize upgrading doc for v4.0 (#7140)
|
||||
* Add version badge for date filters with ordinal (#7162)
|
||||
* Add closing tags for <a> (#7163)
|
||||
* Add TSV to list of supported _data files. (#7168)
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* use jekyll-compose if installed (#6932)
|
||||
* Memoize computing excerpt's relative_path (#6951)
|
||||
* Liquefied link tag (#6269)
|
||||
* Suggest re-running command with --trace on fail (#6551)
|
||||
* Update item_property to return numbers as numbers instead of strings (#6608)
|
||||
* Use .markdown for page templates (#7126)
|
||||
* Fix custom 404 page for GitHub pages (#7132)
|
||||
|
||||
### Major Enhancements
|
||||
|
||||
* Remove unused error class (#6511)
|
||||
* Drop support for Ruby 2.1 and 2.2 (#6560)
|
||||
* Add vendor folder to a newly installed site's .gitignore (#6968)
|
||||
* bump i18n (#6931)
|
||||
* We are not using Ruby 2.2 anymore (#6977)
|
||||
* Drop support for older versions of Rouge (#6978)
|
||||
* Remove support for Redcarpet (#6987)
|
||||
* Remove support for rdiscount (#6988)
|
||||
* Remove 'cache_dir' during `jekyll clean` (#7158)
|
||||
* Output Jekyll Version while debugging (#7173)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Remove unnecessary Jekyll::Page constant (#6770)
|
||||
* Loggers should accept both numbers and symbols (#6967)
|
||||
* Update instructions for releasing docs Gem (#6975)
|
||||
* yajl-ruby update to v1.4.0 (#6976)
|
||||
* Load Rouge for TestKramdown (#7007)
|
||||
* Useless privates removed (#6768)
|
||||
* Allow i18n v0.9.5 and higher (#7044)
|
||||
* Update Rubocop's config (#7050)
|
||||
* Remember to release docs gem (#7066)
|
||||
* Use assert_include (#7093)
|
||||
* Update rubocop version to 0.57.x ### -docs (#7078)
|
||||
* Example of CircleCI deployment through CircleCI v2 (#7024)
|
||||
* Fix Rubocop offences in test files (#7128)
|
||||
* fix up refute_equal call (#7133)
|
||||
* Fix incorrectly passed arguments to assert_equal (#7134)
|
||||
* Lock Travis to Bundler-1.16.2 (#7144)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add call to unused method `validate_options` in `commands/serve.rb` (#7122)
|
||||
|
||||
### feature
|
||||
|
||||
* Disable Liquid via front matter (#6824)
|
||||
* Do not process Liquid in post excerpt when disabled in front matter (#7146)
|
||||
|
||||
## 3.8.3 / 2018-06-05
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Fix --unpublished not affecting collection documents (#7027)
|
||||
|
||||
## 3.8.2 / 2018-05-18
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Update rubocop version (#7016)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add whitespace control to LIQUID_TAG_REGEX (#7015)
|
||||
|
||||
## 3.8.1 / 2018-05-01
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Fix rendering Liquid constructs in excerpts (#6945)
|
||||
* Liquify documents unless published == false (#6959)
|
||||
|
||||
## 3.8.0 / 2018-04-19
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* move duplicate code to a single private method (#6593)
|
||||
* Test against Ruby 2.5 on AppVeyor (#6668)
|
||||
* Replace simple regex with a native Ruby method (#6732)
|
||||
* Codeclimate: exclude livereload.js (#6776)
|
||||
* Add a cucumber feature to test link tag (#6777)
|
||||
* Fix theme gem feature (#6784)
|
||||
* Replace simple regex with equivalent Ruby methods (#6736)
|
||||
* Rewrite `script/rubyprof` as a Ruby script (#6813)
|
||||
* Add debug output to theme rendering (#5195)
|
||||
* fix minitest deprecation warning in test (#6839)
|
||||
* Memoize `Site#site_data` (#6809)
|
||||
* Memoize document output extension (#6814)
|
||||
* Access document permalink attribute efficiently (#6740)
|
||||
* Minimize array allocations in the `where` filter (#6860)
|
||||
* Bump JRuby (#6878)
|
||||
* Assert existence of <collection>.files (#6907)
|
||||
* Bump Rubocop to 0.54.x (#6915)
|
||||
* Regenerate unconditionally unless its an incremental build (#6917)
|
||||
* Centralize require statements (#6910)
|
||||
* Bump to Rubocop 0.55 (#6929)
|
||||
* Refactor private method `HighlightBlock#parse_options` (#6822)
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Two massive performance improvements for large sites (#6730)
|
||||
* Cache the list of documents to be written (#6741)
|
||||
* Allow Jekyll Doctor to detect stray posts dir (#6681)
|
||||
* Excerpt relative-path should match its path (#6597)
|
||||
* Remind user to resolve conflict in `jekyll new` with `--force` (#6801)
|
||||
* Memoize helper methods in site-cleaner (#6808)
|
||||
* Compute document's relative_path faster (#6767)
|
||||
* Create a single instance of PostReader per site (#6759)
|
||||
* Allow date filters to output ordinal days (#6773)
|
||||
* Change regex to sanitize and normalize filenames passed to LiquidRenderer (#6610)
|
||||
* Allow passing :strict_variables and :strict_filters options to Liquid's renderer (#6726)
|
||||
* Debug writing files during the build process (#6696)
|
||||
* Improve regex usage in `Tags::IncludeTag` (#6848)
|
||||
* Improve comment included in the starter index.md (#6916)
|
||||
* Store and retrieve converter instances for Jekyll::Filters via a hash (#6856)
|
||||
* Implement a cache within the `where` filter (#6868)
|
||||
* Store regexp in a constant (#6887)
|
||||
* Optimize computing filename in LiquidRenderer (#6841)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Adding the jekyll-algolia plugin to the list of plugins (#6737)
|
||||
* Added Premonition plugin to list of plugins (#6750)
|
||||
* Add document on releasing a new version (#6745)
|
||||
* Mention Talkyard, a new commenting system for Jekyll and others. (#6752)
|
||||
* Add 'jekyll-fontello' to plugins (#6757)
|
||||
* Install dh-autoreconf on Windows (#6765)
|
||||
* Fix common typos (#6764)
|
||||
* Fix documentation for `{{ page.excerpt }}` (#6779)
|
||||
* Update docs on permalink configuration (#6775)
|
||||
* Propose fix some typos (#6785)
|
||||
* Say hello to Jekyll's New Lead Developer (#6790)
|
||||
* Add reference to Liquid to plugin docs (#6794)
|
||||
* Draft a release post for v3.7.3 (#6803)
|
||||
* add missing step for gem-based theme conversion (#6802)
|
||||
* Update windows.md to explain an issue with jekyll new. (#6838)
|
||||
* Add Bundler Installation Instructions (#6828)
|
||||
* Docs: describe difference between tags and categories (#6882)
|
||||
* Add `jekyll-random` plugin to docs (#6833)
|
||||
* Fixed typo in description of categories and tags (#6896)
|
||||
* Add missing ul-tag (#6897)
|
||||
* doc: add liquid tag plugin jekyll-onebox for html previews (#6898)
|
||||
* Add `jekyll-w2m` to plugins (#6855)
|
||||
* Fix tutorials navigation HTML (#6919)
|
||||
* add Arch Linux instalation troubleshoot (#6782)
|
||||
* Docs: Install Jekyll on macOS (#6881)
|
||||
* Fix CodeClimate badges [ci skip] (#6930)
|
||||
* Update index.md (#6933)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Remove links to Gists (#6751)
|
||||
* Always load Google Fonts over HTTPS (#6792)
|
||||
* always load analytics.js over HTTPS (#6807)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Append appropriate closing tag to Liquid block in an excerpt ### -minor (#6724)
|
||||
* Bypass rendering via Liquid unless required (#6735)
|
||||
* Delegated methods after `private` keyword are meant to be private (#6819)
|
||||
* Improve handling non-default collection documents rendering and writing (#6795)
|
||||
* Fix passing multiline params to include tag when using the variable syntax (#6858)
|
||||
* `include_relative` tag should find related documents in collections gathered within custom `collections_dir` (#6818)
|
||||
* Handle liquid tags in excerpts robustly (#6891)
|
||||
* Allow front matter defaults to be applied properly to documents gathered under custom `collections_dir` (#6885)
|
||||
|
||||
## 3.7.3 / 2018-02-25
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Do not hardcode locale unless certainly necessary (#6791)
|
||||
|
||||
## 3.7.2 / 2018-01-25
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* CI: Test against Ruby 2.5.0 (#6664)
|
||||
* Bump rdoc to 6.0 (#6600)
|
||||
* Lint file and bump theme dependencies (#6698)
|
||||
* Write a Rubocop Cop to ensure no `#p` or `#puts` calls get committed to master. (#6615)
|
||||
* Remove redgreen gem (#6720)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Display latest version in header (#6676)
|
||||
* Update version in `config.yml` via YAML load / dump (#6677)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Fix: Add note about posts in context of collections_dir (#6680)
|
||||
* Update deploy-script in documentation (#6666)
|
||||
* Add note about naming of collections_dir (#6703)
|
||||
* Update installation.md (#6694)
|
||||
* Add `jekyll-html` to plugins. (#6654)
|
||||
* Update plugins.md (#6716)
|
||||
* Release v3.7.1 (#6695)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* inform that symlinks are not allowed in safe mode (#6670)
|
||||
* Glob scope path only if configured with a pattern (#6692)
|
||||
* Add gem "wdm" to all newly generated Gemfiles (#6711)
|
||||
* Fix timezone inconsistencies between different ruby version (#6697)
|
||||
* Refactor collections_dir feature for consistency (#6685)
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Require external library only if necessary (#6596)
|
||||
|
||||
## 3.7.0 / 2018-01-02
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Add LiveReload functionality to Jekyll. (#5142)
|
||||
* Add Utils::Internet.connected? to determine whether host machine has internet connection. (#5870)
|
||||
* Disable default layouts for Pages with a `layout: none` declaration (#6182)
|
||||
* Scope path glob (#6268)
|
||||
* Allow the user to set collections_dir to put all collections under one subdirectory (#6331)
|
||||
* Upgrade to Rouge 3 (#6381)
|
||||
* Allow URL filters to work directly with documents (#6478)
|
||||
* filter relative_url should keep absolute urls with scheme/authority (#6490)
|
||||
* `.sass-cache` doesn't *always* land in `options['source']` (#6500)
|
||||
* Allow plugins to modify the obsolete files. (#6502)
|
||||
* Add latin mode to `slugify` (#6509)
|
||||
* Log Kramdown warnings if log level is WARN (#6522)
|
||||
* Add an option to configure kramdown warning output (#6554)
|
||||
* Add `json` extension to list of directory indices (#6550)
|
||||
* Dependency: Bump jekyll-watch to 2.0 (#6589)
|
||||
* Remove paginate check (#6606)
|
||||
* update classifier-reborn to 2.2.0 (#6631)
|
||||
* Switch to an actively-maintained TOML parser. (#6652)
|
||||
* Do not coerce layout paths in theme-gem to the source directory (#6603)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Raise when theme root directory is not available (#6455)
|
||||
* Avoid block parser warning in SmartyPants (#6565)
|
||||
* Fail gracefully if "sass" gem cannot be loaded (#6573)
|
||||
* return correct file in dir if dir has same name as file (#6569)
|
||||
* Register reload hooks in Server#process (#6605)
|
||||
* Memoize path to metadata file (#6602)
|
||||
* Use `require_relative` to load Jekyll classes (#6609)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Added direct collection access to future collection item feature test(#6151)
|
||||
* add failing test for non-utf8 encoding (#6339)
|
||||
* Upgrade to Cucumber 3.0 (#6395)
|
||||
* Provide a better default hash for tracking liquid stats (#6417)
|
||||
* Add configuration for first-timers bot (#6431)
|
||||
* Do not linkify escaped characters as PRs in History (#6468)
|
||||
* Rely on jekyll-mentions for linking usernames (#6469)
|
||||
* Update first-timers-issue-template.md (#6472)
|
||||
* Enable `Lint/RescueWithoutErrorClass` Cop (#6482)
|
||||
* Clean up Rubocop config (#6495)
|
||||
* Use Gem to discover the location of bundler (#6499)
|
||||
* Remove unnecessary encoding comment (#6513)
|
||||
* Suggest using Rubocop to automatically fix errors (#6514)
|
||||
* Assert raising Psych::SyntaxError when`"strict_front_matter"=>true` (#6520)
|
||||
* Use Kernel#Array instead of explicit Array check (#6525)
|
||||
* RuboCop: Enable `Style/UnneededCapitalW` cop (#6526)
|
||||
* Refactor method to reduce ABC Metric size (#6529)
|
||||
* Remove parentheses around arguments to raise (#6532)
|
||||
* Use double-quotes around gem name (#6535)
|
||||
* Dependencies: upgrade to toml 0.2.0 (#6541)
|
||||
* Lock to cucumber 3.0.1 on Ruby 2.1 (#6546)
|
||||
* Bump JRuby version in Travis config (#6561)
|
||||
* Rescue from Psych::SyntaxError instead of SyntaxError after parsing YAML(#5828)
|
||||
* Drop forwarding to private methods by exposing those methods as public(#6577)
|
||||
* Upgrade pygments to v1.x (#5937)
|
||||
* Bump yajl-ruby (#6582)
|
||||
* Cleanup test_redcarpet.rb (#6584)
|
||||
* Add PageWithoutAFile class from jekyll plugins (#6556)
|
||||
* Cleanup LiveReloadReactor (#6607)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Add formester to the list of saas form backend (#6059)
|
||||
* GitHub Pages instructions (#6384)
|
||||
* Improve documentation for theme-gem installation (#6387)
|
||||
* Fix diff syntax-highlighting (#6388)
|
||||
* Update instructions (#6396)
|
||||
* Fix code-block highlighting in docs (#6398)
|
||||
* Filtering Posts with categories, tags, or other variables (#6399)
|
||||
* Fixes formatting on pre-formatted text. (#6405)
|
||||
* Added new tutorial to tutorials section on docs (#6406)
|
||||
* Updates (#6407)
|
||||
* Fix `collections_dir` example (#6408)
|
||||
* Renaming duplicate of "Scenario 6" to "Scenario 7" (#6411)
|
||||
* Mark `collection_dir` as unreleased (#6412)
|
||||
* Fix link to SUPPORT (#6415)
|
||||
* Fix list appearance by adding missing `ol` tag (#6421)
|
||||
* Explain how to override output collection index page (#6424)
|
||||
* Added github-cards to the list of plugins (#6425)
|
||||
* CoC violation correspondants (#6429)
|
||||
* Add a note about Liquid and syntax highlighting (#6466)
|
||||
* Remove `sudo` from macOS troubleshooting instructions (#6486)
|
||||
* Add a note on `:jekyll_plugins` group in the docs (#6488)
|
||||
* Updated custom-404-page.md (#6489)
|
||||
* Fix a few minor issues in the docs (#6494)
|
||||
* Add jekyll-pwa-plugin (#6533)
|
||||
* Remove Jekyll-Smartify from plugins directory (#6548)
|
||||
* Updated Jekyll-Pug listing to include official website (#6555)
|
||||
* Remove link to severely outdated asset plugin (#6613)
|
||||
* Default time zone depends upon server (#6617)
|
||||
* Add `disqus-for-jekyll` to plugins. (#6618)
|
||||
* Update "Requirements" for Ruby version (#6623)
|
||||
* Fix: Update link to i18n_filter plugin (#6638)
|
||||
* Correct WordPress capitalization (#6645)
|
||||
* Add Tweetsert, Stickyposts, Paginate::Content (#6651)
|
||||
* Post: Jekyll 3.7.0 released (#6634)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Add special styling for code-blocks run in shell (#6389)
|
||||
* Add post about diversity (#6447)
|
||||
* Update list of files excluded from Docs site (#6457)
|
||||
* Update site History (#6460)
|
||||
* Add default twitter card image (#6476)
|
||||
* Update normalize.css to v7.0.0 (#6491)
|
||||
* Optimize images (#6519)
|
||||
* Back to original main navigation (#6544)
|
||||
* Styles: mobile-docs select element (#6545)
|
||||
* Search with DocSearch by @Algolia (#6557)
|
||||
* Site header redesign (#6567)
|
||||
* Move logo above site navigation on small screens (#6570)
|
||||
* Docs: Include version badge for latest features (#6574)
|
||||
* Use version-badge on an existing feature intro (#6575)
|
||||
* Add jekyll-category-pages plugin (#6632)
|
||||
* Improve docs styling for code to be run in shell (#6641)
|
||||
* Fix permalink icon markup in news-item layout (#6639)
|
||||
|
||||
## 3.6.2 / 2017-10-21
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Update Rubocop to 0.51.0 (#6444)
|
||||
* Add test for layout as string (#6445)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Problematic UTF+bom files (#6322)
|
||||
* Always treat `data.layout` as a string (#6442)
|
||||
|
||||
## 3.6.1 / 2017-10-20
|
||||
|
||||
### Documentation
|
||||
|
||||
* Doc y_day in docs/permalinks (#6244)
|
||||
* Update frontmatter.md (#6371)
|
||||
* Elaborate on excluding items from processing (#6136)
|
||||
* Style lists in tables (#6379)
|
||||
* Remove duplicate "available" (#6380)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Bump rubocop to use `v0.50.x` (#6368)
|
||||
|
||||
## 3.6.0 / 2017-09-21
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Ignore final newline in folded YAML string (#6054)
|
||||
* Add URL checks to Doctor (#5760)
|
||||
* Fix serving files that clash with directories (#6222) (#6231)
|
||||
* Bump supported Ruby version to `>= 2.1.0` (#6220)
|
||||
* set `LiquidError#template_name` for errors in included file (#6206)
|
||||
* Access custom config array throughout session (#6200)
|
||||
* Add support for Rouge 2, in addition to Rouge 1 (#5919)
|
||||
* Allow `yield` to logger methods & bail early on no-op messages (#6315)
|
||||
* Update mime-types. (#6336)
|
||||
* Use a Schwartzian transform with custom sorting (#6342)
|
||||
* Alias `Drop#invoke_drop` to `Drop#[]` (#6338)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* `Deprecator`: fix typo for `--serve` command (#6229)
|
||||
* `Reader#read_directories`: guard against an entry not being a directory (#6226)
|
||||
* kramdown: symbolize keys in-place (#6247)
|
||||
* Call `to_s` on site.url before attempting to concatenate strings (#6253)
|
||||
* Enforce Style/FrozenStringLiteralComment (#6265)
|
||||
* Update theme-template README to note 'assets' directory (#6257)
|
||||
* Memoize the return value of `Document#url` (#6266)
|
||||
* delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6273)
|
||||
* Fix `Drop#key?` so it can handle a nil argument (#6281)
|
||||
* Guard against type error in absolute url (#6280)
|
||||
* Mutable drops should fallback to their own methods when a mutation isn't present (#6350)
|
||||
* Skip adding binary files as posts (#6344)
|
||||
* Don't break if bundler is not installed (#6377)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Fix a typo in `custom-404-page.md` (#6218)
|
||||
* Docs: fix links to issues in History.markdown (#6255)
|
||||
* Update deprecated gems key to plugins. (#6262)
|
||||
* Fixes minor typo in post text (#6283)
|
||||
* Execute build command using bundle. (#6274)
|
||||
* name unification - buddy details (#6317)
|
||||
* name unification - application index (#6318)
|
||||
* trim and relocate plugin info across docs (#6311)
|
||||
* update Jekyll's README (#6321)
|
||||
* add SUPPORT file for GitHub (#6324)
|
||||
* Rename CODE_OF_CONDUCT to show in banner (#6325)
|
||||
* Docs : illustrate page.id for a collection's document (#6329)
|
||||
* Docs: post's date can be overriden in YAML front matter (#6334)
|
||||
* Docs: `site.url` behavior on development and production environments (#6270)
|
||||
* Fix typo in site.url section of variables.md :-[ (#6337)
|
||||
* Docs: updates (#6343)
|
||||
* Fix precedence docs (#6346)
|
||||
* add note to contributing docs about `script/console` (#6349)
|
||||
* Docs: Fix permalink example (#6375)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Adding DevKit helpers (#6225)
|
||||
* Customizing url in collection elements clarified (#6264)
|
||||
* Plugins is the new gems (#6326)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Strip unnecessary leading whitespace in template (#6228)
|
||||
* Users should be installing patch versions. (#6198)
|
||||
* Fix tests (#6240)
|
||||
* Define path with `__dir__` (#6087)
|
||||
* exit site.process sooner (#6239)
|
||||
* make flakey test more robust (#6277)
|
||||
* Add a quick test for DataReader (#6284)
|
||||
* script/backport-pr: commit message no longer includes the `#` (#6289)
|
||||
* Add Add CODEOWNERS file to help automate reviews. (#6320)
|
||||
* Fix builds on codeclimate (#6333)
|
||||
* Bump rubies on Travis (#6366)
|
||||
|
||||
## 3.5.2 / 2017-08-12
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Backport #6281 for v3.5.x: Fix `Drop#key?` so it can handle a nil argument (#6288)
|
||||
* Backport #6280 for v3.5.x: Guard against type error in `absolute_url` (#6287)
|
||||
* Backport #6266 for v3.5.x: Memoize the return value of `Document#url` (#6301)
|
||||
* Backport #6273 for v3.5.x: delegate `StaticFile#to_json` to `StaticFile#to_liquid` (#6302)
|
||||
* Backport #6226 for v3.5.x: `Reader#read_directories`: guard against an entry not being a directory (#6304)
|
||||
* Backport #6247 for v3.5.x: kramdown: symbolize keys in-place (#6303)
|
||||
|
||||
## 3.5.1 / 2017-07-17
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Use Warn for deprecation messages (#6192)
|
||||
* site template: Use plugins key instead of gems (#6045)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Backward compatiblize URLFilters module (#6163)
|
||||
* Static files contain front matter default keys when `to_liquid`'d (#6162)
|
||||
* Always normalize the result of the `relative_url` filter (#6185)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Update reference to trouble with OS X/macOS (#6139)
|
||||
* added BibSonomy plugin (#6143)
|
||||
* add plugins for multiple page pagination (#6055)
|
||||
* Update minimum Ruby version in installation.md (#6164)
|
||||
* Add information about finding a collection in `site.collections` (#6165)
|
||||
* Add `{% raw %}` to Liquid example on site (#6179)
|
||||
* Added improved Pug plugin - removed 404 Jade plugin (#6174)
|
||||
* Linking the link (#6210)
|
||||
* Small correction in documentation for includes (#6193)
|
||||
* Fix docs site page margin (#6214)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Add jekyll doctor to GitHub Issue Template (#6169)
|
||||
* Test with Ruby 2.4.1-1 on AppVeyor (#6176)
|
||||
* set minimum requirement for jekyll-feed (#6184)
|
||||
|
||||
## 3.5.0 / 2017-06-18
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Upgrade to Liquid v4 (#4362)
|
||||
* Convert StaticFile liquid representation to a Drop & add front matter defaults support to StaticFiles (#5871)
|
||||
* Add support for Tab-Separated Values data files (`*.tsv`) (#5985)
|
||||
* Specify version constraint in subcommand error message. (#5974)
|
||||
* Add a template for custom 404 page (#5945)
|
||||
* Require `runtime_dependencies` of a Gem-based theme from its `.gemspec` file (#5914)
|
||||
* Don't raise an error if URL contains a colon (#5889)
|
||||
* Date filters should never raise an exception (#5722)
|
||||
* add `plugins` config key as replacement for `gems` (#5130)
|
||||
* create configuration from options only once in the boot process (#5487)
|
||||
* Add option to fail a build with front matter syntax errors (#5832)
|
||||
* Disable default layouts for documents with a `layout: none` declaration (#5933)
|
||||
* In `jekyll new`, make copied site template user-writable (#6072)
|
||||
* Add top-level `layout` liquid variable to Documents (#6073)
|
||||
* Address reading non-binary static files in themes (#5918)
|
||||
* Allow filters to sort & select based on subvalues (#5622)
|
||||
* Add strip_index filter (#6075)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Install troubleshooting on Ubuntu (#5817)
|
||||
* Add Termux section on troubleshooting (#5837)
|
||||
* fix ial css classes in theme doc (#5876)
|
||||
* Update installation.md (#5880)
|
||||
* Update Aerobatic docs (#5883)
|
||||
* Add note to collections doc on hard-coded collections. (#5882)
|
||||
* Makes uri_escape template docs more specific. (#5887)
|
||||
* Remove duplicate footnote_nr from default config (#5891)
|
||||
* Fixed tutorial for publishing gem to include repo. (#5900)
|
||||
* update broken links (#5905)
|
||||
* Fix typo in contribution information (#5910)
|
||||
* update plugin repo URL to reflect repo move (#5916)
|
||||
* Update exclude array in configuration.md (#5947)
|
||||
* Fixed path in "Improve this page" link in Tutorials section (#5951)
|
||||
* Corrected permalink (#5949)
|
||||
* Included more details about adding defaults to static files (#5971)
|
||||
* Create buddyworks (#5962)
|
||||
* added (buddyworks) to ci list (#5965)
|
||||
* Add a tutorial on serving custom Error 404 page (#5946)
|
||||
* add custom 404 to tutorial navigation (#5978)
|
||||
* Add link to order of interpretation tutorial in Tutorials nav (#5952)
|
||||
* Document Jekyll's Philosophy (#5792)
|
||||
* Require Ruby > 2.1.0 (#5983)
|
||||
* Fix broken link (#5994)
|
||||
* Default options for script/proof (#5995)
|
||||
* Mention Bash on Ubuntu on Windows (#5960)
|
||||
* Document `--unpublished` flag introduced in 91e9ecf (#5959)
|
||||
* Update upgrading.md to mention usage of `bundle update` (#5604)
|
||||
* Fix missing quotation mark (#6002)
|
||||
* New tutorial: Convert an HTML site to Jekyll (#5881)
|
||||
* Revamp Permalink section (#5912)
|
||||
* Fixup tutorial on creating theme from existing HTML templates (#6006)
|
||||
* Standardise on "URLs" without apostrophe in docs (#6018)
|
||||
* Added txtpen in tutorial (#6021)
|
||||
* fix typo using past participle (#6026)
|
||||
* changed formatting to fit the style of the documentation (#6027)
|
||||
* doc fix typo word usage (#6028)
|
||||
* corrected reference to layout in index.md (#6032)
|
||||
* (Minor) Update MathJax CDN (#6013)
|
||||
* Add MvvmCross to samples (#6035)
|
||||
* Update travis-ci.md to correct procedure (#6043)
|
||||
* fix sentence in documentation (#6048)
|
||||
* rephrase a sentence in posts.md to be more direct (#6049)
|
||||
* Compress Website Sass output (#6009)
|
||||
* doc correct spelling error (#6050)
|
||||
* adjusted date-format in sitemap (#6053)
|
||||
* Typo fix (welcomed change -> welcome change). (#6070)
|
||||
* Fixed documentation inconsistency (#6068)
|
||||
* Add own plugin -> Jekyll Brand Social Wall (#6064)
|
||||
* Added plugin jekyll-analytics (#6042)
|
||||
* Use more precise language when explaining links (#6078)
|
||||
* Update plugins.md (#6088)
|
||||
* windows 10 tutorial (#6100)
|
||||
* Explain how to override theme styles (#6107)
|
||||
* updated Bash on Ubuntu on Windows link in tutorial (#6111)
|
||||
* Fix wording in `_docs/templates.md` links section (#6114)
|
||||
* Update windows.md (#6115)
|
||||
* Added windows to docs.yml (#6109)
|
||||
* Be more specific on what to upload (#6119)
|
||||
* Remove Blank Newlines from "Jekyll on Windows" Page (#6126)
|
||||
* Link the troubleshooting page in the quickstart page (#6134)
|
||||
* add documentation about the "pinned" label (#6147)
|
||||
* docs(JekyllOnWindows): Add a new Installation way (#6141)
|
||||
* corrected windows.md (#6149)
|
||||
* Refine documentation for Windows (#6153)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Rubocop: add missing comma (#5835)
|
||||
* Appease classifier-reborn (#5934)
|
||||
* Allow releases & development on `*-stable` branches (#5926)
|
||||
* Add script/backport-pr (#5925)
|
||||
* Prefer .yaml over .toml (#5966)
|
||||
* Fix Appveyor with DST-aware cucumber steps (#5961)
|
||||
* Use Rubocop v0.47.1 till we're ready for v0.48 (#5989)
|
||||
* Test against Ruby 2.4.0 (#5687)
|
||||
* rubocop: lib/jekyll/renderer.rb complexity fixes (#5052)
|
||||
* Use yajl-ruby 1.2.2 (now with 2.4 support) (#6007)
|
||||
* Bump Rubocop to v0.48 (#5997)
|
||||
* doc use example.com (#6031)
|
||||
* fix typo (#6040)
|
||||
* Fix CI (#6044)
|
||||
* Remove `ruby RUBY_VERSION` from generated Gemfile (#5803)
|
||||
* Test if hidden collections output a document with a future date (#6103)
|
||||
* Add test for uri_escape on reserved characters (#6086)
|
||||
* Allow you to specify the rouge version via an environment variable for testing (#6138)
|
||||
* Bump Rubocop to 0.49.1 (#6093)
|
||||
* Lock nokogiri to 1.7.x for Ruby 2.1 (#6140)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Corrected date for version 3.4.0 (#5842)
|
||||
* Add the correct year to the 3.4.0 release date (#5858)
|
||||
* Add documentation about order of interpretation (#5834)
|
||||
* Documentation on how to build navigation (#5698)
|
||||
* Navigation has been moved out from docs (#5927)
|
||||
* Make links in sidebar for current page more prominent (#5820)
|
||||
* Update normalize.css to v6.0.0 (#6008)
|
||||
* Docs: rename `gems` to `plugins` (#6082)
|
||||
* plugins -> gems (#6110)
|
||||
* Document difference between cgi_escape and uri_escape #5970 (#6081)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Exclude Gemfile by default (#5860)
|
||||
* Convertible#validate_permalink!: ensure the return value of `data["permalink"]` is a string before asking if it is empty (#5878)
|
||||
* Allow abbreviated post dates (#5920)
|
||||
* Remove dependency on include from default about.md (#5903)
|
||||
* Allow colons in `uri_escape` filter (#5957)
|
||||
* Re-surface missing public methods in `Jekyll::Document` (#5975)
|
||||
* absolute_url should not mangle URL if called more than once (#5789)
|
||||
* patch URLFilters to prevent `//` (#6058)
|
||||
* add test to ensure variables work in `where_exp` condition (#5315)
|
||||
* Read explicitly included dot-files in collections. (#6092)
|
||||
* Default `baseurl` to `nil` instead of empty string (#6137)
|
||||
* Filters#time helper: Duplicate time before calling #localtime. (#5996)
|
||||
|
||||
## 3.4.5 / 2017-06-30
|
||||
|
||||
* Backport #6185 for v3.4.x: Always normalize the result of the `relative_url` filter (#6186)
|
||||
|
||||
## 3.4.4 / 2017-06-17
|
||||
## 3.4.4 / 2016-06-17
|
||||
|
||||
* Backport #6137 for v3.4.x: Default `baseurl` to `nil` instead of empty string (#6146)
|
||||
|
||||
@@ -673,13 +12,14 @@
|
||||
|
||||
## 3.4.2 / 2017-03-09
|
||||
|
||||
* Backport #5871 for v3.4.x: Convert StaticFile liquid representation to a Drop & add front matter defaults support to StaticFiles (#5940)
|
||||
* Backport #5871 for v3.4.x: Convert StaticFile liquid representation to
|
||||
a Drop & add front matter defaults support to StaticFiles (#5940)
|
||||
|
||||
## 3.4.1 / 2017-03-02
|
||||
|
||||
* Backport #5920 for v3.4.x: Allow abbreviated post dates (#5924)
|
||||
|
||||
## 3.4.0 / 2017-01-27
|
||||
## 3.4.0 / 2016-01-27
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
@@ -708,7 +48,7 @@
|
||||
* Switch to `https` when possible. (#5611)
|
||||
* Update `_font-awesome.scss` to move .woff file before .ttf (#5614)
|
||||
* Update documentation on updating FontAwesome Iconset (#5655)
|
||||
* Use defaults for docs and news-items (#5744)
|
||||
* [site] Use defaults for docs and news-items (#5744)
|
||||
* Sort gems in `docs/_config.yml` (#5746)
|
||||
* Add missing class (#5791)
|
||||
* Improve template docs (#5694)
|
||||
@@ -769,7 +109,7 @@
|
||||
* Update quickstart.md (#5758)
|
||||
* Correct minor typo (#5764)
|
||||
* Fix a markdown link to look properly on the web (#5769)
|
||||
* Info about the help command usage (#5312)
|
||||
* [docs] Info about the help command usage (#5312)
|
||||
* Add missing merge labels for jekyllbot (#5753)
|
||||
* Fix broken links in documentation (#5736)
|
||||
* Docs: add `match_regex` and `replace_regex` filters (#5799)
|
||||
@@ -901,10 +241,10 @@
|
||||
* Site: exclude README.md and .gitignore (#5304)
|
||||
* Add link to Staticman (#5224)
|
||||
* Update url for OpenShift (#5320)
|
||||
* Add help for missing static_file e.g. on heroku (#5334)
|
||||
* [docs] add help for missing static_file e.g. on heroku (#5334)
|
||||
* Add a line about updating theme-gems in the docs (#5318)
|
||||
* Explain how to copy a theme's files (#5335)
|
||||
* .md as default extension in examples (#5316)
|
||||
* [docs] .md as default extension in examples (#5316)
|
||||
* Fix small typo in docs (#5347)
|
||||
* Add missing period to sentence in first paragraph. (#5372)
|
||||
* added jekyll-spotify plugin (#5369)
|
||||
@@ -913,7 +253,7 @@
|
||||
* Add documentation for `relative_url` and `absolute_url` (#5405)
|
||||
* Bugfix on logo in JSON-LD (#5421)
|
||||
* Fix Travis.ci documentation (#5413)
|
||||
* Update documentation regarding `bundle install` after `jekyll new` (#5428)
|
||||
* [docs] Update documentation regarding `bundle install` after `jekyll new` (#5428)
|
||||
* Replace classic box-sizing reset with inheritance reset (#5411)
|
||||
* Update Wikipedia YAML list link (#5452)
|
||||
* Add Jekyll 3.3 release post (#5442)
|
||||
@@ -923,9 +263,9 @@
|
||||
* Update appveyor.yml and fix optional deps for Ruby x64 (#5180)
|
||||
* Improve tests for Jekyll::PluginManager (#5167)
|
||||
* Update Ruby versions in travis.yml (#5221)
|
||||
* Avoid installing unnecessary gems for site testing (#5272)
|
||||
* Avoid installing unecessary gems for site testing (#5272)
|
||||
* Proposal: Affinity teams and their captains (#5273)
|
||||
* Replace duplicate with positive local test in issue template (#5286)
|
||||
* Replace duplicate with postive local test in issue template (#5286)
|
||||
* Update AppVeyor config. (#5240)
|
||||
* Execute jekyll from clone instead of defined binary when running 'script/default-site' (#5295)
|
||||
* rubocop: lib/jekyll/document.rb complexity fixes (#5045)
|
||||
@@ -969,7 +309,7 @@
|
||||
* Allow collections to have documents that have no file extension (#4545)
|
||||
* Add size property to `group_by` result (#4557)
|
||||
* Site Template: Removed unnecessary nesting from `_base.scss` (#4637)
|
||||
* Adding a debug log statement for skipped future documents. (#4558)
|
||||
* Adding a debug log statment for skipped future documents. (#4558)
|
||||
* Site Template: Changed main `<div>` to `<main>` and added accessibility info (#4636)
|
||||
* Add array support to `where` filter (#4555)
|
||||
* 'jekyll clean': also remove .sass-cache (#4652)
|
||||
@@ -978,7 +318,7 @@
|
||||
* Add `show_dir_listing` option for serve command and fix index file names (#4533)
|
||||
* Site Template: write a Gemfile which is educational to the new site (#4542)
|
||||
* Site template: add explanation of site variables in the example `_config.yml` (#4704)
|
||||
* Adds `link` Liquid tag to make generation of URLs easier (#4624)
|
||||
* Adds `link` Liquid tag to make generation of URL's easier (#4624)
|
||||
* Allow static files to be symlinked in unsafe mode or non-prod environments (#4640)
|
||||
* Add `:after_init` hook & add `Site#config=` to make resetting config easy (#4703)
|
||||
* DocumentDrop: add `#<=>` which sorts by date (falling back to path) (#4741)
|
||||
@@ -1217,7 +557,7 @@
|
||||
* Fix broken links to the Code of Conduct (#4436)
|
||||
* Upgrade notes: mention trailing slash in permalink; fixes #4440 (#4455)
|
||||
* Add hooks to the plugin categories toc (#4463)
|
||||
* Jekyll 3 requires newer version of Ruby. (#4461)
|
||||
* [add note] Jekyll 3 requires newer version of Ruby. (#4461)
|
||||
* Fix typo in upgrading docs (#4473)
|
||||
* Add note about upgrading documentation on jekyllrb.com/help/ (#4484)
|
||||
* Update Rake link (#4496)
|
||||
@@ -1278,14 +618,14 @@
|
||||
* utils/drops: update Drop to support `Utils.deep_merge_hashes` (#4289)
|
||||
* Make sure jekyll/drops/drop is loaded first. (#4292)
|
||||
* Convertible/Page/Renderer: use payload hash accessor & setter syntax for backwards-compatibility (#4311)
|
||||
* Drop: fix hash setter precedence (#4312)
|
||||
* Drop: fix hash setter precendence (#4312)
|
||||
* utils: `has_yaml_header?` should accept files with extraneous spaces (#4290)
|
||||
* Escape html from site.title and page.title in site template (#4307)
|
||||
* Allow custom file extensions if defined in `permalink` YAML front matter (#4314)
|
||||
* Fix deep_merge_hashes! handling of drops and hashes (#4359)
|
||||
* Page should respect output extension of its permalink (#4373)
|
||||
* Disable auto-regeneration when running server detached (#4376)
|
||||
* Drop#: only use public_send for keys in the content_methods array (#4388)
|
||||
* Drop#[]: only use public_send for keys in the content_methods array (#4388)
|
||||
* Extract title from filename successfully when no date. (#4195)
|
||||
|
||||
### Development Fixes
|
||||
@@ -1687,7 +1027,7 @@
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Add @alfredxing to the @jekyll/core team. :tada: (#3218)
|
||||
* Add `@alfredxing` to the `@jekyll/core` team. :tada: (#3218)
|
||||
* Document the `-q` option for the `build` and `serve` commands (#3149)
|
||||
* Fix some minor typos/flow fixes in documentation website content (#3165)
|
||||
* Add `keep_files` to configuration documentation (#3162)
|
||||
@@ -1761,7 +1101,7 @@
|
||||
* Fix Rouge's RedCarpet plugin interface integration (#2951)
|
||||
* Remove `--watch` from the site template blog post since it defaults to watching in in 2.4.0 (#2922)
|
||||
* Fix code for media query mixin in site template (#2946)
|
||||
* Allow post URLs to have `.htm` extensions (#2925)
|
||||
* Allow post URL's to have `.htm` extensions (#2925)
|
||||
* `Utils.slugify`: Don't create new objects when gsubbing (#2997)
|
||||
* The jsonify filter should deep-convert to Liquid when given an Array. (#3032)
|
||||
* Apply `jsonify` filter to Hashes deeply and effectively (#3063)
|
||||
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2008-2018 Tom Preston-Werner and Jekyll contributors
|
||||
Copyright (c) 2008-2017 Tom Preston-Werner and Jekyll contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
@@ -3,13 +3,13 @@
|
||||
[][ruby-gems]
|
||||
[][travis]
|
||||
[][appveyor]
|
||||
[][codeclimate]
|
||||
[][coverage]
|
||||
[][coverage]
|
||||
[][codeclimate]
|
||||
[][gemnasium]
|
||||
[][hakiri]
|
||||
[](#backers)
|
||||
[](#sponsors)
|
||||
|
||||
[ruby-gems]: https://rubygems.org/gems/jekyll
|
||||
[gemnasium]: https://gemnasium.com/jekyll/jekyll
|
||||
[codeclimate]: https://codeclimate.com/github/jekyll/jekyll
|
||||
[coverage]: https://codeclimate.com/github/jekyll/jekyll/coverage
|
||||
[hakiri]: https://hakiri.io/github/jekyll/jekyll/master
|
||||
@@ -22,11 +22,9 @@ Jekyll is a simple, blog-aware, static site generator perfect for personal, proj
|
||||
|
||||
Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.
|
||||
|
||||
See: https://jekyllrb.com/philosophy
|
||||
## Having trouble with OS X El Capitan?
|
||||
|
||||
## Having trouble?
|
||||
|
||||
See: https://jekyllrb.com/docs/troubleshooting/
|
||||
See: https://jekyllrb.com/docs/troubleshooting/#jekyll-amp-mac-os-x-1011
|
||||
|
||||
## Getting Started
|
||||
|
||||
@@ -39,13 +37,13 @@ See: https://jekyllrb.com/docs/troubleshooting/
|
||||
## Code of Conduct
|
||||
|
||||
In order to have a more open and welcoming community, Jekyll adheres to a
|
||||
[code of conduct](CODE_OF_CONDUCT.markdown) adapted from the Ruby on Rails code of
|
||||
[code of conduct](CONDUCT.markdown) adapted from the Ruby on Rails code of
|
||||
conduct.
|
||||
|
||||
Please adhere to this code of conduct in any interactions you have in the
|
||||
Jekyll community. It is strictly enforced on all official Jekyll
|
||||
repositories, websites, and resources. If you encounter someone violating
|
||||
these terms, please let one of our [core team members](https://jekyllrb.com/team/#core-team) know and we will address it as soon as possible.
|
||||
these terms, please let a maintainer ([@parkr](https://github.com/parkr), [@envygeeks](https://github.com/envygeeks), [@mattr-](https://github.com/mattr-), or [@alfredxing](https://github.com/alfredxing)) know and we will address it as soon as possible.
|
||||
|
||||
## Diving In
|
||||
|
||||
@@ -56,28 +54,6 @@ these terms, please let one of our [core team members](https://jekyllrb.com/team
|
||||
* Use the built-in [Liquid Extensions](https://jekyllrb.com/docs/templates/) to make your life easier
|
||||
* Use custom [Plugins](https://jekyllrb.com/docs/plugins/) to generate content specific to your site
|
||||
|
||||
## Credits
|
||||
|
||||
### Contributors
|
||||
|
||||
This project exists thanks to all the people who contribute.
|
||||
<a href="graphs/contributors"><img src="https://opencollective.com/jekyll/contributors.svg?width=890&button=false" /></a>
|
||||
|
||||
### Backers
|
||||
|
||||
Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/jekyll#backer)
|
||||
|
||||
<a href="https://opencollective.com/jekyll#backers" target="_blank"><img src="https://opencollective.com/jekyll/backers.svg?width=890" /></a>
|
||||
|
||||
### Sponsors
|
||||
|
||||
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor!](https://opencollective.com/jekyll#sponsor)
|
||||
|
||||
<a href="https://opencollective.com/jekyll/sponsor/0/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/0/avatar.svg" /></a>
|
||||
<a href="https://opencollective.com/jekyll/sponsor/1/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/1/avatar.svg" /></a>
|
||||
<a href="https://opencollective.com/jekyll/sponsor/2/website" target="_blank"><img src="https://opencollective.com/jekyll/sponsor/2/avatar.svg" /></a>
|
||||
|
||||
|
||||
## License
|
||||
|
||||
See the [LICENSE](https://github.com/jekyll/jekyll/blob/master/LICENSE) file.
|
||||
|
||||
22
Rakefile
22
Rakefile
@@ -1,12 +1,10 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "rubygems"
|
||||
require "rake"
|
||||
require "rdoc"
|
||||
require "date"
|
||||
require "yaml"
|
||||
|
||||
$LOAD_PATH.unshift File.expand_path("lib", __dir__)
|
||||
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
|
||||
require "jekyll/version"
|
||||
|
||||
Dir.glob("rake/**.rake").each { |f| import f }
|
||||
@@ -46,13 +44,19 @@ def normalize_bullets(markdown)
|
||||
end
|
||||
|
||||
def linkify_prs(markdown)
|
||||
markdown.gsub(%r!(?<\!&)#(\d+)!) do |word|
|
||||
markdown.gsub(%r!#(\d+)!) do |word|
|
||||
"[#{word}]({{ site.repository }}/issues/#{word.delete("#")})"
|
||||
end
|
||||
end
|
||||
|
||||
def linkify_users(markdown)
|
||||
markdown.gsub(%r!(@\w+)!) do |username|
|
||||
"[#{username}](https://github.com/#{username.delete("@")})"
|
||||
end
|
||||
end
|
||||
|
||||
def linkify(markdown)
|
||||
linkify_prs(markdown)
|
||||
linkify_users(linkify_prs(markdown))
|
||||
end
|
||||
|
||||
def liquid_escape(markdown)
|
||||
@@ -66,11 +70,11 @@ def custom_release_header_anchors(markdown)
|
||||
_, major, minor, patch = *release_notes.match(header_regexp)
|
||||
release_notes
|
||||
.gsub(header_regexp, "\\0\n{: #v\\1-\\2-\\3}")
|
||||
.gsub(section_regexp) { |section| "#{section}\n{: ##{slugify(section)}-v#{major}-#{minor}-#{patch}}" }
|
||||
.gsub(section_regexp) { |section| "#{section}\n{: ##{sluffigy(section)}-v#{major}-#{minor}-#{patch}}" }
|
||||
end.join("\n## ")
|
||||
end
|
||||
|
||||
def slugify(header)
|
||||
def sluffigy(header)
|
||||
header.delete("#").strip.downcase.gsub(%r!\s+!, "-")
|
||||
end
|
||||
|
||||
@@ -95,14 +99,14 @@ def siteify_file(file, overrides_front_matter = {})
|
||||
abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exist?(file)
|
||||
title = begin
|
||||
File.read(file).match(%r!\A# (.*)$!)[1]
|
||||
rescue NoMethodError
|
||||
rescue
|
||||
File.basename(file, ".*").downcase.capitalize
|
||||
end
|
||||
slug = File.basename(file, ".markdown").downcase
|
||||
front_matter = {
|
||||
"title" => title,
|
||||
"permalink" => "/docs/#{slug}/",
|
||||
"note" => "This file is autogenerated. Edit /#{file} instead.",
|
||||
"note" => "This file is autogenerated. Edit /#{file} instead."
|
||||
}.merge(overrides_front_matter)
|
||||
contents = "#{front_matter.to_yaml}---\n\n#{content_for(file)}"
|
||||
File.write("#{docs_folder}/_docs/#{slug}.md", contents)
|
||||
|
||||
20
appveyor.yml
20
appveyor.yml
@@ -16,17 +16,19 @@ install:
|
||||
environment:
|
||||
BUNDLE_WITHOUT: "benchmark:site:development"
|
||||
matrix:
|
||||
- RUBY_FOLDER_VER: "25"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "25"
|
||||
TEST_SUITE: "cucumber"
|
||||
- RUBY_FOLDER_VER: "25"
|
||||
TEST_SUITE: "default-site"
|
||||
- RUBY_FOLDER_VER: "25-x64"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "24"
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "cucumber"
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "fmt"
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "default-site"
|
||||
- RUBY_FOLDER_VER: "23-x64"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "22"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "21"
|
||||
TEST_SUITE: "test"
|
||||
|
||||
test_script:
|
||||
|
||||
@@ -1,101 +0,0 @@
|
||||
#!/usr/bin/env ruby
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "liquid"
|
||||
require "benchmark/ips"
|
||||
|
||||
# Test if processing content string without any Liquid constructs, via Liquid,
|
||||
# is slower than checking whether constructs exist ( using `String#include?` )
|
||||
# and return-ing the "plaintext" content string as is..
|
||||
#
|
||||
# Ref: https://github.com/jekyll/jekyll/pull/6735
|
||||
|
||||
# Sample contents
|
||||
WITHOUT_LIQUID = <<-TEXT.freeze
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce auctor libero at
|
||||
pharetra tempus. Etiam bibendum magna et metus fermentum, eu cursus lorem
|
||||
mattis. Curabitur vel dui et lacus rutrum suscipit et eget neque.
|
||||
|
||||
Nullam luctus fermentum est id blandit. Phasellus consectetur ullamcorper
|
||||
ligula, at finibus eros laoreet id. Etiam sit amet est in libero efficitur
|
||||
tristique. Ut nec magna augue. Quisque ut fringilla lacus, ac dictum enim.
|
||||
Aliquam vel ornare mauris. Suspendisse ornare diam tempor nulla facilisis
|
||||
aliquet. Sed ultrices placerat ultricies.
|
||||
TEXT
|
||||
|
||||
WITH_LIQUID = <<-LIQUID.freeze
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce auctor libero at
|
||||
pharetra tempus. {{ author }} et metus fermentum, eu cursus lorem
|
||||
mattis. Curabitur vel dui et lacus rutrum suscipit et eget neque.
|
||||
|
||||
Nullam luctus fermentum est id blandit. Phasellus consectetur ullamcorper
|
||||
ligula, {% if author == "Jane Doe" %} at finibus eros laoreet id. {% else %}
|
||||
Etiam sit amet est in libero efficitur.{% endif %}
|
||||
tristique. Ut nec magna augue. Quisque ut fringilla lacus, ac dictum enim.
|
||||
Aliquam vel ornare mauris. Suspendisse ornare diam tempor nulla facilisis
|
||||
aliquet. Sed ultrices placerat ultricies.
|
||||
LIQUID
|
||||
|
||||
WITH_JUST_LIQUID_VAR = <<-LIQUID.freeze
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce auctor libero at
|
||||
pharetra tempus. et metus fermentum, eu cursus lorem, ac dictum enim.
|
||||
mattis. Curabitur vel dui et lacus rutrum suscipit et {{ title }} neque.
|
||||
|
||||
Nullam luctus fermentum est id blandit. Phasellus consectetur ullamcorper
|
||||
ligula, at finibus eros laoreet id. Etiam sit amet est in libero efficitur.
|
||||
tristique. Ut nec magna augue. {{ author }} Quisque ut fringilla lacus
|
||||
Aliquam vel ornare mauris. Suspendisse ornare diam tempor nulla facilisis
|
||||
aliquet. Sed ultrices placerat ultricies.
|
||||
LIQUID
|
||||
|
||||
SUITE = {
|
||||
:"plain text" => WITHOUT_LIQUID,
|
||||
:"tags n vars" => WITH_LIQUID,
|
||||
:"just vars" => WITH_JUST_LIQUID_VAR,
|
||||
}.freeze
|
||||
|
||||
# Mimic how Jekyll's LiquidRenderer would process a non-static file, with
|
||||
# some dummy payload
|
||||
def always_liquid(content)
|
||||
Liquid::Template.error_mode = :warn
|
||||
Liquid::Template.parse(content, :line_numbers => true).render(
|
||||
"author" => "John Doe",
|
||||
"title" => "FooBar"
|
||||
)
|
||||
end
|
||||
|
||||
# Mimic how the proposed change would first execute a couple of checks and
|
||||
# proceed to process with Liquid if necessary
|
||||
def conditional_liquid(content)
|
||||
return content if content.nil? || content.empty?
|
||||
return content unless content.include?("{%") || content.include?("{{")
|
||||
always_liquid(content)
|
||||
end
|
||||
|
||||
# Test https://github.com/jekyll/jekyll/pull/6735#discussion_r165499868
|
||||
# ------------------------------------------------------------------------
|
||||
def check_with_regex(content)
|
||||
!content.to_s.match?(%r!{[{%]!)
|
||||
end
|
||||
|
||||
def check_with_builtin(content)
|
||||
content.include?("{%") || content.include?("{{")
|
||||
end
|
||||
|
||||
SUITE.each do |key, text|
|
||||
Benchmark.ips do |x|
|
||||
x.report("regex-check - #{key}") { check_with_regex(text) }
|
||||
x.report("builtin-check - #{key}") { check_with_builtin(text) }
|
||||
x.compare!
|
||||
end
|
||||
end
|
||||
# ------------------------------------------------------------------------
|
||||
|
||||
# Let's roll!
|
||||
SUITE.each do |key, text|
|
||||
Benchmark.ips do |x|
|
||||
x.report("always thru liquid - #{key}") { always_liquid(text) }
|
||||
x.report("conditional liquid - #{key}") { conditional_liquid(text) }
|
||||
x.compare!
|
||||
end
|
||||
end
|
||||
@@ -1,29 +0,0 @@
|
||||
#!/usr/bin/env ruby
|
||||
# frozen_string_literal: true
|
||||
|
||||
require 'benchmark/ips'
|
||||
require 'jekyll'
|
||||
require 'json'
|
||||
|
||||
DATA = {"foo"=>"bar", "alpha"=>{"beta"=>"gamma"}, "lipsum"=>["lorem", "ipsum", "dolor"]}
|
||||
|
||||
def local_require
|
||||
require 'json'
|
||||
JSON.pretty_generate(DATA)
|
||||
end
|
||||
|
||||
def global_require
|
||||
JSON.pretty_generate(DATA)
|
||||
end
|
||||
|
||||
def graceful_require
|
||||
Jekyll::External.require_with_graceful_fail("json")
|
||||
JSON.pretty_generate(DATA)
|
||||
end
|
||||
|
||||
Benchmark.ips do |x|
|
||||
x.report("local-require") { local_require }
|
||||
x.report("global-require") { global_require }
|
||||
x.report("graceful-require") { graceful_require }
|
||||
x.compare!
|
||||
end
|
||||
@@ -1,33 +0,0 @@
|
||||
#!/usr/bin/env ruby
|
||||
|
||||
# -------------------------------------------------------------------
|
||||
# Benchmarking changes in https://github.com/jekyll/jekyll/pull/6767
|
||||
# -------------------------------------------------------------------
|
||||
|
||||
require 'benchmark/ips'
|
||||
require 'pathutil'
|
||||
|
||||
DOC_PATH = File.join(File.expand_path(__dir__), "_puppies", "rover.md")
|
||||
COL_PATH = File.join(File.expand_path(__dir__), "_puppies")
|
||||
|
||||
|
||||
def pathutil_relative
|
||||
Pathutil.new(DOC_PATH).relative_path_from(COL_PATH).to_s
|
||||
end
|
||||
|
||||
def native_relative
|
||||
DOC_PATH.sub("#{COL_PATH}/", "")
|
||||
end
|
||||
|
||||
if pathutil_relative == native_relative
|
||||
Benchmark.ips do |x|
|
||||
x.report("pathutil") { pathutil_relative }
|
||||
x.report("native") { native_relative }
|
||||
x.compare!
|
||||
end
|
||||
else
|
||||
print "PATHUTIL: "
|
||||
puts pathutil_relative
|
||||
print "NATIVE: "
|
||||
puts native_relative
|
||||
end
|
||||
@@ -1,26 +0,0 @@
|
||||
#!/usr/bin/env ruby
|
||||
|
||||
require "benchmark/ips"
|
||||
|
||||
PATH = "/../../..../...//.....//lorem/ipsum//dolor///sit.xyz"
|
||||
|
||||
def sanitize_with_regex
|
||||
"/" + PATH.gsub(%r!/{2,}!, "/").gsub(%r!\.+/|\A/+!, "")
|
||||
end
|
||||
|
||||
def sanitize_with_builtin
|
||||
"/#{PATH}".gsub("..", "/").gsub("./", "").squeeze("/")
|
||||
end
|
||||
|
||||
if sanitize_with_regex == sanitize_with_builtin
|
||||
Benchmark.ips do |x|
|
||||
x.report("sanitize w/ regexes") { sanitize_with_regex }
|
||||
x.report("sanitize w/ builtin") { sanitize_with_builtin }
|
||||
x.compare!
|
||||
end
|
||||
else
|
||||
puts "w/ regexes: #{sanitize_with_regex}"
|
||||
puts "w/ builtin: #{sanitize_with_builtin}"
|
||||
puts ""
|
||||
puts "Thank you. Do try again :("
|
||||
end
|
||||
@@ -1,115 +0,0 @@
|
||||
#!/usr/bin/env ruby
|
||||
# frozen_string_literal: true
|
||||
#
|
||||
# The Ruby documentation for #sort_by describes what's called a Schwartzian transform:
|
||||
#
|
||||
# > A more efficient technique is to cache the sort keys (modification times in this case)
|
||||
# > before the sort. Perl users often call this approach a Schwartzian transform, after
|
||||
# > Randal Schwartz. We construct a temporary array, where each element is an array
|
||||
# > containing our sort key along with the filename. We sort this array, and then extract
|
||||
# > the filename from the result.
|
||||
# > This is exactly what sort_by does internally.
|
||||
#
|
||||
# The well-documented efficiency of sort_by is a good reason to use it. However, when a property
|
||||
# does not exist on an item being sorted, it can cause issues (no nil's allowed!)
|
||||
# In Jekyll::Filters#sort_input, we extract the property in each iteration of #sort,
|
||||
# which is quite inefficient! How inefficient? This benchmark will tell you just how, and how much
|
||||
# it can be improved by using the Schwartzian transform. Thanks, Randall!
|
||||
|
||||
require 'benchmark/ips'
|
||||
require 'minitest'
|
||||
require File.expand_path("../lib/jekyll", __dir__)
|
||||
|
||||
def site
|
||||
@site ||= Jekyll::Site.new(
|
||||
Jekyll.configuration("source" => File.expand_path("../docs", __dir__))
|
||||
).tap(&:reset).tap(&:read)
|
||||
end
|
||||
|
||||
def site_docs
|
||||
site.collections["docs"].docs.dup
|
||||
end
|
||||
|
||||
def sort_by_property_directly(docs, meta_key)
|
||||
docs.sort! do |apple, orange|
|
||||
apple_property = apple[meta_key]
|
||||
orange_property = orange[meta_key]
|
||||
|
||||
if !apple_property.nil? && !orange_property.nil?
|
||||
apple_property <=> orange_property
|
||||
elsif !apple_property.nil? && orange_property.nil?
|
||||
-1
|
||||
elsif apple_property.nil? && !orange_property.nil?
|
||||
1
|
||||
else
|
||||
apple <=> orange
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def schwartzian_transform(docs, meta_key)
|
||||
docs.collect! { |d|
|
||||
[d[meta_key], d]
|
||||
}.sort! { |apple, orange|
|
||||
if !apple[0].nil? && !orange[0].nil?
|
||||
apple.first <=> orange.first
|
||||
elsif !apple[0].nil? && orange[0].nil?
|
||||
-1
|
||||
elsif apple[0].nil? && !orange[0].nil?
|
||||
1
|
||||
else
|
||||
apple[-1] <=> orange[-1]
|
||||
end
|
||||
}.collect! { |d| d[-1] }
|
||||
end
|
||||
|
||||
# Before we test efficiency, do they produce the same output?
|
||||
class Correctness
|
||||
include Minitest::Assertions
|
||||
|
||||
require "pp"
|
||||
define_method :mu_pp, &:pretty_inspect
|
||||
|
||||
attr_accessor :assertions
|
||||
|
||||
def initialize(docs, property)
|
||||
@assertions = 0
|
||||
@docs = docs
|
||||
@property = property
|
||||
end
|
||||
|
||||
def assert!
|
||||
assert sort_by_property_directly(@docs, @property).is_a?(Array), "sort_by_property_directly must return an array"
|
||||
assert schwartzian_transform(@docs, @property).is_a?(Array), "schwartzian_transform must return an array"
|
||||
assert_equal sort_by_property_directly(@docs, @property),
|
||||
schwartzian_transform(@docs, @property)
|
||||
puts "Yeah, ok, correctness all checks out for property #{@property.inspect}"
|
||||
end
|
||||
end
|
||||
|
||||
Correctness.new(site_docs, "redirect_from".freeze).assert!
|
||||
Correctness.new(site_docs, "title".freeze).assert!
|
||||
|
||||
# First, test with a property only a handful of documents have.
|
||||
Benchmark.ips do |x|
|
||||
x.config(time: 10, warmup: 5)
|
||||
x.report('sort_by_property_directly with sparse property') do
|
||||
sort_by_property_directly(site_docs, "redirect_from".freeze)
|
||||
end
|
||||
x.report('schwartzian_transform with sparse property') do
|
||||
schwartzian_transform(site_docs, "redirect_from".freeze)
|
||||
end
|
||||
x.compare!
|
||||
end
|
||||
|
||||
# Next, test with a property they all have.
|
||||
Benchmark.ips do |x|
|
||||
x.config(time: 10, warmup: 5)
|
||||
x.report('sort_by_property_directly with non-sparse property') do
|
||||
sort_by_property_directly(site_docs, "title".freeze)
|
||||
end
|
||||
x.report('schwartzian_transform with non-sparse property') do
|
||||
schwartzian_transform(site_docs, "title".freeze)
|
||||
end
|
||||
x.compare!
|
||||
end
|
||||
1
docs/.gitignore
vendored
1
docs/.gitignore
vendored
@@ -2,4 +2,3 @@ _site/
|
||||
*.swp
|
||||
pkg/
|
||||
test/
|
||||
.idea/
|
||||
@@ -27,6 +27,9 @@ sitemap: false
|
||||
<li>
|
||||
<a href="/news/">News</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/community/">Community</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/help/">Help</a>
|
||||
</li>
|
||||
|
||||
@@ -1,48 +1,56 @@
|
||||
---
|
||||
version: 3.8.3
|
||||
markdown: kramdown
|
||||
highlighter: rouge
|
||||
|
||||
gauges_id: 503c5af6613f5d0f19000027
|
||||
google_analytics_id: UA-50755011-1
|
||||
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
|
||||
|
||||
repository: https://github.com/jekyll/jekyll
|
||||
help_url: https://github.com/jekyll/jekyll-help
|
||||
|
||||
timezone: America/Los_Angeles
|
||||
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
path: "_docs"
|
||||
type: "docs"
|
||||
values:
|
||||
layout: "docs"
|
||||
-
|
||||
scope:
|
||||
path: "_posts"
|
||||
type: "posts"
|
||||
values:
|
||||
layout: "news_item"
|
||||
|
||||
|
||||
collections:
|
||||
docs:
|
||||
permalink: /:collection/:path/
|
||||
output: true
|
||||
posts:
|
||||
permalink: /news/:year/:month/:day/:title/
|
||||
output: true
|
||||
|
||||
name: Jekyll • Simple, blog-aware, static sites
|
||||
description: Transform your plain text into static websites and blogs
|
||||
url: https://jekyllrb.com
|
||||
repository: https://github.com/jekyll/jekyll
|
||||
timezone: America/Los_Angeles
|
||||
|
||||
twitter:
|
||||
username: jekyllrb
|
||||
logo: "/img/logo-2x.png"
|
||||
google_analytics_id: UA-50755011-1
|
||||
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
|
||||
collections:
|
||||
docs:
|
||||
permalink: "/:collection/:path/"
|
||||
output: true
|
||||
posts:
|
||||
permalink: "/news/:year/:month/:day/:title/"
|
||||
output: true
|
||||
tutorials:
|
||||
output: true
|
||||
defaults:
|
||||
- scope:
|
||||
path: _docs
|
||||
type: docs
|
||||
values:
|
||||
layout: docs
|
||||
- scope:
|
||||
path: _posts
|
||||
type: posts
|
||||
values:
|
||||
layout: news_item
|
||||
image: "/img/twitter-card.png"
|
||||
plugins:
|
||||
- jekyll-avatar
|
||||
- jekyll-feed
|
||||
- jekyll-mentions
|
||||
- jekyll-redirect-from
|
||||
- jekyll-seo-tag
|
||||
- jekyll-sitemap
|
||||
- jemoji
|
||||
sass:
|
||||
style: compressed
|
||||
|
||||
logo: /img/logo-2x.png
|
||||
|
||||
gems:
|
||||
- jekyll-avatar
|
||||
- jekyll-feed
|
||||
- jekyll-mentions
|
||||
- jekyll-redirect-from
|
||||
- jekyll-seo-tag
|
||||
- jekyll-sitemap
|
||||
- jemoji
|
||||
|
||||
exclude:
|
||||
- ".gitignore"
|
||||
- CNAME
|
||||
- icomoon-selection.json
|
||||
- readme.md
|
||||
- .gitignore
|
||||
- README.md
|
||||
|
||||
@@ -3,7 +3,6 @@
|
||||
- home
|
||||
- quickstart
|
||||
- installation
|
||||
- windows
|
||||
- usage
|
||||
- structure
|
||||
- configuration
|
||||
|
||||
@@ -1,15 +0,0 @@
|
||||
- name: Forestry.io
|
||||
image: /img/forestry-logo.png
|
||||
url: https://forestry.io
|
||||
width: 140
|
||||
height: 30
|
||||
- name: CloudCannon
|
||||
image: /img/cloudcannon-logo.png
|
||||
url: https://cloudcannon.com
|
||||
width: 75
|
||||
height: 30
|
||||
- name: Siteleaf
|
||||
image: /img/siteleaf-logo.png
|
||||
url: https://siteleaf.com
|
||||
width: 40
|
||||
height: 50
|
||||
@@ -1,13 +0,0 @@
|
||||
- title: Tutorials
|
||||
tutorials:
|
||||
- home
|
||||
- video-walkthroughs
|
||||
- navigation
|
||||
- orderofinterpretation
|
||||
- custom-404-page
|
||||
- convert-site-to-jekyll
|
||||
- using-jekyll-with-bundler
|
||||
|
||||
#- title: Another section
|
||||
# tutorials:
|
||||
# - sample
|
||||
@@ -53,7 +53,7 @@ sass:
|
||||
The Sass converter will default the `sass_dir` configuration option to
|
||||
`_sass`.
|
||||
|
||||
[example-sass]: https://github.com/jekyll/jekyll-sass-converter/tree/master/docs
|
||||
[example-sass]: https://github.com/jekyll/jekyll-sass-converter/tree/master/example
|
||||
|
||||
<div class="note info">
|
||||
<h5>The <code>sass_dir</code> is only used by Sass</h5>
|
||||
@@ -88,6 +88,6 @@ To enable Coffeescript in Jekyll 3.0 and up you must
|
||||
* Ensure that your `_config.yml` is up-to-date and includes the following:
|
||||
|
||||
```yaml
|
||||
plugins:
|
||||
gems:
|
||||
- jekyll-coffeescript
|
||||
```
|
||||
|
||||
@@ -46,21 +46,6 @@ defaults:
|
||||
layout: page
|
||||
```
|
||||
|
||||
<div class="note">
|
||||
<h5>Gather your collections {%- include docs_version_badge.html version="3.7.0" -%}</h5>
|
||||
|
||||
<p>You can optionally specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>.</p>
|
||||
|
||||
<p>Then Jekyll will look in <code>my_collections/_books</code> for the <code>books</code> collection, and
|
||||
in <code>my_collections/_recipes</code> for the <code>recipes</code> collection.</p>
|
||||
</div>
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Be sure to move drafts and posts into custom collections directory</h5>
|
||||
|
||||
<p>If you specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>, then you will need to move your <code>_drafts</code> and <code>_posts</code> directory to <code>my_collections/_drafts</code> and <code>my_collections/_posts</code>. Note that, the name of your collections directory cannot start with an underscore (`_`).</p>
|
||||
</div>
|
||||
|
||||
### Step 2: Add your content {#step2}
|
||||
|
||||
Create a corresponding folder (e.g. `<source>/_my_collection`) and add
|
||||
@@ -93,20 +78,6 @@ For example, if you have `_my_collection/some_subdir/some_doc.md`,
|
||||
it will be rendered using Liquid and the Markdown converter of your
|
||||
choice and written out to `<dest>/my_collection/some_subdir/some_doc.html`.
|
||||
|
||||
If you wish a specific page to be shown when accessing `/my_collection/`,
|
||||
simply add `permalink: /my_collection/index.html` to a page.
|
||||
To list items from the collection, on that page or any other, you can use:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% for item in site.my_collection %}
|
||||
<h2>{{ item.title }}</h2>
|
||||
<p>{{ item.description }}</p>
|
||||
<p><a href="{{ item.url }}">{{ item.title }}</a></p>
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
<div class="note info">
|
||||
<h5>Don't forget to add YAML for processing</h5>
|
||||
<p>
|
||||
@@ -118,75 +89,18 @@ To list items from the collection, on that page or any other, you can use:
|
||||
|
||||
## Configuring permalinks for collections {#permalinks}
|
||||
|
||||
If you wish to specify a custom pattern for the URLs where your Collection pages
|
||||
will reside, you may do so with the [`permalink` property](../permalinks/):
|
||||
You can customize the [Permalinks](../permalinks/) for your collection's documents by setting `permalink` property in the collection's configuration as follows:
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
my_collection:
|
||||
output: true
|
||||
permalink: /:collection/:name
|
||||
permalink: /awesome/:path/:title.:output_ext
|
||||
```
|
||||
|
||||
### Examples
|
||||
In this example, the collection documents will the have the URL of `awesome` followed by the path to the document and its file extension.
|
||||
|
||||
For a collection with the following source file structure,
|
||||
|
||||
```
|
||||
_my_collection/
|
||||
└── some_subdir
|
||||
└── some_doc.md
|
||||
```
|
||||
|
||||
each of the following `permalink` configurations will produce the document structure shown below it.
|
||||
|
||||
* **Default**
|
||||
Same as `permalink: /:collection/:path`.
|
||||
|
||||
```
|
||||
_site/
|
||||
├── my_collection
|
||||
│ └── some_subdir
|
||||
│ └── some_doc.html
|
||||
...
|
||||
```
|
||||
* `permalink: pretty`
|
||||
Same as `permalink: /:collection/:path/`.
|
||||
|
||||
```
|
||||
_site/
|
||||
├── my_collection
|
||||
│ └── some_subdir
|
||||
│ └── some_doc
|
||||
│ └── index.html
|
||||
...
|
||||
```
|
||||
* `permalink: /doc/:path`
|
||||
|
||||
```
|
||||
_site/
|
||||
├── doc
|
||||
│ └── some_subdir
|
||||
│ └── some_doc.html
|
||||
...
|
||||
```
|
||||
* `permalink: /doc/:name`
|
||||
|
||||
```
|
||||
_site/
|
||||
├── doc
|
||||
│ └── some_doc.html
|
||||
...
|
||||
```
|
||||
* `permalink: /:name`
|
||||
|
||||
```
|
||||
_site/
|
||||
├── some_doc.html
|
||||
...
|
||||
```
|
||||
|
||||
### Template Variables
|
||||
Collections have the following template variables available for permalinks:
|
||||
|
||||
<div class="mobile-side-scroller">
|
||||
<table>
|
||||
@@ -199,7 +113,7 @@ each of the following `permalink` configurations will produce the document struc
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:collection</code></p>
|
||||
<p><code>collection</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Label of the containing collection.</p>
|
||||
@@ -207,7 +121,7 @@ each of the following `permalink` configurations will produce the document struc
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:path</code></p>
|
||||
<p><code>path</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Path to the document relative to the collection's directory.</p>
|
||||
@@ -215,7 +129,7 @@ each of the following `permalink` configurations will produce the document struc
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:name</code></p>
|
||||
<p><code>name</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The document's base filename, with every sequence of spaces
|
||||
@@ -224,37 +138,107 @@ each of the following `permalink` configurations will produce the document struc
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:title</code></p>
|
||||
<p><code>title</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
The <code>:title</code> template variable will take the
|
||||
<code>slug</code> <a href="/docs/frontmatter/">front matter</a>
|
||||
variable value if any is present in the document; if none is
|
||||
defined then <code>:title</code> will be equivalent to
|
||||
<code>:name</code>, aka the slug generated from the filename.
|
||||
</p>
|
||||
<p>The document's lowercase title (as defined in its <a href="/docs/frontmatter/">front matter</a>), with every sequence of spaces and non-alphanumeric characters replaced by a hyphen. If the document does not define a title in its <a href="/docs/frontmatter/">front matter</a>, this is equivalent to <code>name</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:output_ext</code></p>
|
||||
<p><code>output_ext</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Extension of the output file. (Included by default and usually unnecessary.)</p>
|
||||
<p>Extension of the output file.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
## Permalink examples for collections
|
||||
|
||||
Depending on how you declare the permalinks in your configuration file, the permalinks and paths get written differently in the `_site` folder. A few examples will help clarify the options.
|
||||
|
||||
Let's say your collection is called `apidocs` with `doc1.md` in your collection. `doc1.md` is grouped inside a folder called `mydocs`. Your project's source directory for the collection looks this:
|
||||
|
||||
```
|
||||
├── \_apidocs
|
||||
│ └── mydocs
|
||||
│ └── doc1.md
|
||||
```
|
||||
|
||||
Based on this scenario, here are a few permalink options.
|
||||
|
||||
**Permalink configuration 1**: [Nothing configured] <br/>
|
||||
**Output**:
|
||||
|
||||
```
|
||||
├── apidocs
|
||||
│ └── mydocs
|
||||
│ └── doc1.html
|
||||
```
|
||||
|
||||
**Permalink configuration 2**: `/:collection/:path/:title:output_ext` <br/>
|
||||
**Output**:
|
||||
|
||||
```
|
||||
├── apidocs
|
||||
│ └── mydocs
|
||||
│ └── doc1.html
|
||||
```
|
||||
|
||||
**Permalink configuration 3**: No collection permalinks configured, but `pretty` configured for pages/posts. <br/>
|
||||
**Output**:
|
||||
|
||||
```
|
||||
├── apidocs
|
||||
│ └── mydocs
|
||||
│ └── doc1
|
||||
│ └── index.html
|
||||
```
|
||||
|
||||
**Permalink configuration 4**: `/awesome/:path/:title.html` <br/>
|
||||
**Output**:
|
||||
|
||||
```
|
||||
├── awesome
|
||||
│ └── mydocs
|
||||
│ └── doc1.html
|
||||
```
|
||||
|
||||
**Permalink configuration 5**: `/awesome/:path/:title/` <br/>
|
||||
**Output**:
|
||||
|
||||
```
|
||||
├── awesome
|
||||
│ └── mydocs
|
||||
│ └── doc1
|
||||
│ └── index.html
|
||||
```
|
||||
|
||||
**Permalink configuration 6**: `/awesome/:title.html` <br/>
|
||||
**Output**:
|
||||
|
||||
```
|
||||
├── awesome
|
||||
│ └── doc1.html
|
||||
```
|
||||
|
||||
**Permalink configuration 7**: `:title.html`
|
||||
**Output**:
|
||||
|
||||
```
|
||||
├── doc1.html
|
||||
```
|
||||
|
||||
## Liquid Attributes
|
||||
|
||||
### Collections
|
||||
|
||||
Each collection is accessible as a field on the `site` variable. For example, if
|
||||
you want to access the `albums` collection found in `_albums`, you'd use
|
||||
`site.albums`.
|
||||
`site.albums`.
|
||||
|
||||
Each collection is itself an array of documents (e.g., `site.albums` is an array of documents, much like `site.pages` and
|
||||
`site.posts`). See the table below for how to access attributes of those documents.
|
||||
@@ -337,31 +321,6 @@ you specified in your `_config.yml` (if present) and the following information:
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>A Hard-Coded Collection</h5>
|
||||
<p>In addition to any collections you create yourself, the
|
||||
<code>posts</code> collection is hard-coded into Jekyll. It exists whether
|
||||
you have a <code>_posts</code> directory or not. This is something to note
|
||||
when iterating through <code>site.collections</code> as you may need to
|
||||
filter it out.</p>
|
||||
<p>You may wish to use filters to find your collection:
|
||||
<code>{% raw %}{{ site.collections | where: "label", "myCollection" | first }}{% endraw %}</code></p>
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Collections and Time</h5>
|
||||
<p>Except for documents in hard-coded default collection <code>posts</code>, all documents in collections
|
||||
you create, are accessible via Liquid irrespective of their assigned date, if any, and therefore renderable.
|
||||
</p>
|
||||
<p>However documents are attempted to be written to disk only if the concerned collection
|
||||
metadata has <code>output: true</code>. Additionally, future-dated documents are only written if
|
||||
<code>site.future</code> <em>is also true</em>.
|
||||
</p>
|
||||
<p>More fine-grained control over documents being written to disk can be exercised by setting
|
||||
<code>published: false</code> (<em><code>true</code> by default</em>) in the document's front matter.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
### Documents
|
||||
|
||||
@@ -486,7 +445,7 @@ works:
|
||||
|
||||
Every album in the collection could be listed on a single page with a template:
|
||||
|
||||
```liquid
|
||||
```html
|
||||
{% raw %}
|
||||
{% for album in site.albums %}
|
||||
<h2>{{ album.title }}</h2>
|
||||
|
||||
@@ -108,7 +108,7 @@ class="flag">flags</code> (specified on the command-line) that control them.
|
||||
<a href="https://en.wikipedia.org/wiki/Tz_database">IANA Time Zone
|
||||
Database</a> is valid, e.g. <code>America/New_York</code>. A list of all
|
||||
available values can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">
|
||||
here</a>. When serving on a local machine, the default time zone is set by your operating system. But when served on a remote host/server, the default time zone depends on the server's setting or location.
|
||||
here</a>. The default is the local time zone, as set by your operating system.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
@@ -305,18 +305,6 @@ class="flag">flags</code> (specified on the command-line) that control them.
|
||||
<p><code class="flag">--profile</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="setting">
|
||||
<td>
|
||||
<p class="name"><strong>Strict Front Matter</strong></p>
|
||||
<p class="description">
|
||||
Cause a build to fail if there is a YAML syntax error in a page's front matter.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p><code class="option">strict_front_matter: BOOL</code></p>
|
||||
<p><code class="flag">--strict_front_matter</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -518,7 +506,7 @@ defaults:
|
||||
-
|
||||
scope:
|
||||
path: ""
|
||||
type: "pages"
|
||||
type: "posts"
|
||||
values:
|
||||
layout: "my-site"
|
||||
-
|
||||
@@ -530,7 +518,7 @@ defaults:
|
||||
author: "Mr. Hyde"
|
||||
```
|
||||
|
||||
With these defaults, all pages would use the `my-site` layout. Any html files that exist in the `projects/` folder will use the `project` layout, if it exists. Those files will also have the `page.author` [liquid variable](../variables/) set to `Mr. Hyde`.
|
||||
With these defaults, all posts would use the `my-site` layout. Any html files that exist in the `projects/` folder will use the `project` layout, if it exists. Those files will also have the `page.author` [liquid variable](../variables/) set to `Mr. Hyde`.
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
@@ -549,39 +537,11 @@ defaults:
|
||||
In this example, the `layout` is set to `default` inside the
|
||||
[collection](../collections/) with the name `my_collection`.
|
||||
|
||||
### Glob patterns in Front Matter defaults
|
||||
|
||||
It is also possible to use glob patterns (currently limited to patterns that contain `*`) when matching defaults. For example, it is possible to set specific layout for each `special-page.html` in any subfolder of `section` folder. {%- include docs_version_badge.html version="3.7.0" -%}
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
my_collection:
|
||||
output: true
|
||||
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
path: "section/*/special-page.html"
|
||||
values:
|
||||
layout: "specific-layout"
|
||||
```
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Globbing and Performance</h5>
|
||||
<p>
|
||||
Please note that globbing a path is known to have a negative effect on
|
||||
performance and is currently not optimized, especially on Windows.
|
||||
Globbing a path will increase your build times in proportion to the size
|
||||
of the associated collection directory.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
### Precedence
|
||||
|
||||
Jekyll will apply all of the configuration settings you specify in the `defaults` section of your `_config.yml` file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.
|
||||
|
||||
You can see that in the second to last example above. First, we set the default page layout to `my-site`. Then, using a more specific path, we set the default layout for pages in the `projects/` path to `project`. This can be done with any value that you would set in the page or post front matter.
|
||||
You can see that in the second to last example above. First, we set the default layout to `my-site`. Then, using a more specific path, we set the default layout for files in the `projects/` path to `project`. This can be done with any value that you would set in the page or post front matter.
|
||||
|
||||
Finally, if you set defaults in the site configuration by adding a `defaults` section to your `_config.yml` file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:
|
||||
|
||||
@@ -630,25 +590,23 @@ file or on the command-line.
|
||||
|
||||
```yaml
|
||||
# Where things are
|
||||
source: .
|
||||
destination: ./_site
|
||||
collections_dir: .
|
||||
plugins_dir: _plugins
|
||||
layouts_dir: _layouts
|
||||
data_dir: _data
|
||||
includes_dir: _includes
|
||||
source: .
|
||||
destination: ./_site
|
||||
plugins_dir: _plugins
|
||||
layouts_dir: _layouts
|
||||
data_dir: _data
|
||||
includes_dir: _includes
|
||||
collections:
|
||||
posts:
|
||||
output: true
|
||||
|
||||
# Handling Reading
|
||||
safe: false
|
||||
include: [".htaccess"]
|
||||
exclude: ["Gemfile", "Gemfile.lock", "node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
|
||||
keep_files: [".git", ".svn"]
|
||||
encoding: "utf-8"
|
||||
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
|
||||
strict_front_matter: false
|
||||
safe: false
|
||||
include: [".htaccess"]
|
||||
exclude: ["node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
|
||||
keep_files: [".git", ".svn"]
|
||||
encoding: "utf-8"
|
||||
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
|
||||
|
||||
# Filtering Content
|
||||
show_drafts: null
|
||||
@@ -658,7 +616,7 @@ unpublished: false
|
||||
|
||||
# Plugins
|
||||
whitelist: []
|
||||
plugins: []
|
||||
gems: []
|
||||
|
||||
# Conversion
|
||||
markdown: kramdown
|
||||
@@ -684,9 +642,7 @@ verbose: false
|
||||
defaults: []
|
||||
|
||||
liquid:
|
||||
error_mode: warn
|
||||
strict_filters: false
|
||||
strict_variables: false
|
||||
error_mode: warn
|
||||
|
||||
# Markdown Processors
|
||||
rdiscount:
|
||||
@@ -696,14 +652,14 @@ redcarpet:
|
||||
extensions: []
|
||||
|
||||
kramdown:
|
||||
auto_ids: true
|
||||
entity_output: as_char
|
||||
toc_levels: 1..6
|
||||
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
||||
input: GFM
|
||||
hard_wrap: false
|
||||
footnote_nr: 1
|
||||
show_warnings: false
|
||||
auto_ids: true
|
||||
footnote_nr: 1
|
||||
entity_output: as_char
|
||||
toc_levels: 1..6
|
||||
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
||||
input: GFM
|
||||
hard_wrap: false
|
||||
footnote_nr: 1
|
||||
```
|
||||
|
||||
## Liquid Options
|
||||
@@ -715,14 +671,6 @@ options are
|
||||
- `warn` --- Output a warning on the console for each error.
|
||||
- `strict` --- Output an error message and stop the build.
|
||||
|
||||
You can also configure Liquid's renderer to catch non-assigned variables and
|
||||
non-existing filters by setting `strict_variables` and / or `strict_filters`
|
||||
to `true` respectively. {% include docs_version_badge.html version="3.8.0" %}
|
||||
|
||||
Do note that while `error_mode` configures Liquid's parser, the `strict_variables`
|
||||
and `strict_filters` options configure Liquid's renderer and are consequently,
|
||||
mutually exclusive.
|
||||
|
||||
## Markdown Options
|
||||
|
||||
The various Markdown renderers supported by Jekyll sometimes have extra options
|
||||
|
||||
@@ -1,62 +0,0 @@
|
||||
---
|
||||
title: "Buddy"
|
||||
---
|
||||
|
||||
[Buddy][buddy-homepage] is a [Docker][docker-homepage]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][github-homepage], [Bitbucket][bitbucket-homepage], and [GitLab][gitlab-homepage] repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project.
|
||||
|
||||
[buddy-homepage]: https://buddy.works
|
||||
[docker-homepage]: https://www.docker.com/
|
||||
[github-homepage]: https://github.com
|
||||
[bitbucket-homepage]: https://bitbucket.org/
|
||||
[gitlab-homepage]: https://gitlab.com
|
||||
|
||||
## 1. Getting started
|
||||
|
||||
1. Log in at [https://buddy.works][buddy-homepage] with your GitHub/Bitbucket account or email
|
||||
2. Choose your Git provider and select or push your Jekyll Project
|
||||
3. Create a new pipeline and set the trigger mode to 'On every push'
|
||||
4. Add and configure the Jekyll action and save the pipeline
|
||||
|
||||
## 2. How it works
|
||||
|
||||
Whenever you make a push to the selected branch, the Jekyll action runs `jekyll build` in an isolated [Jekyll Docker image][jekyll-docker-image]. The output is generated to the `/filesystem` directory, and can be further deployed to FTP/SFTP and IaaS services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server.
|
||||
|
||||

|
||||
|
||||
[jekyll-docker-image]: https://hub.docker.com/r/jekyll/jekyll/
|
||||
|
||||
## 3. Using YAML for configuration
|
||||
|
||||
If you prefer configuration as code over GUI, you can generate a `buddy.yml` that will create a pipeline with the Jekyll action once you push it to the target branch:
|
||||
|
||||
```yaml
|
||||
- pipeline: "Build and Deploy Jekyll site"
|
||||
trigger_mode: "ON_EVERY_PUSH"
|
||||
ref_name: "master"
|
||||
actions:
|
||||
- action: "Execute: jekyll build"
|
||||
type: "BUILD"
|
||||
docker_image_name: "jekyll/jekyll"
|
||||
docker_image_tag: "latest"
|
||||
execute_commands:
|
||||
- "chown jekyll:jekyll $WORKING_DIR"
|
||||
- "jekyll build"
|
||||
```
|
||||
|
||||
## 4. Setting up on-premises server
|
||||
|
||||
The self-hosted version of Buddy can be installed on any type of server supporting Docker, including [Linux][bw-linux], [Mac][bw-mac], [AWS EC2][bw-aws-ec2], [DigitalOcean][bw-digitalocean], and [Microsoft Azure][bw-azure].
|
||||
|
||||
[bw-linux]: https://buddy.works/knowledge/standalone/installation-linux
|
||||
[bw-mac]: https://buddy.works/knowledge/standalone/installation-mac-osx
|
||||
[bw-aws-ec2]: https://buddy.works/knowledge/standalone/installation-amazon-ec2
|
||||
[bw-digitalocean]: https://buddy.works/knowledge/standalone/installation-digitalocean
|
||||
[bw-azure]: https://buddy.works/knowledge/standalone/installation-azure
|
||||
|
||||
## 5. Questions?
|
||||
|
||||
This entire guide is open-source. Go ahead and [edit it][jekyll-docs-ci-buddy] if you want to expand it or have a fix or [ask for help][jekyll-help] if you run into trouble and need assistance. Buddy also has an [online community][buddy-forum] for help.
|
||||
|
||||
[jekyll-docs-ci-buddy]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md
|
||||
[jekyll-help]: https://jekyllrb.com/help/
|
||||
[buddy-forum]: http://forum.buddy.works/
|
||||
@@ -25,7 +25,7 @@ The easiest way to manage dependencies for a Jekyll project (with or without Cir
|
||||
|
||||
[4]: http://bundler.io/gemfile.html
|
||||
|
||||
```ruby
|
||||
```yaml
|
||||
source 'https://rubygems.org'
|
||||
|
||||
ruby '2.4.0'
|
||||
@@ -40,7 +40,7 @@ CircleCI detects when `Gemfile` is present is will automatically run `bundle ins
|
||||
|
||||
The most basic test that can be run is simply seeing if `jekyll build` actually works. This is a blocker, a dependency if you will, for other tests you might run on the generate site. So we'll run Jekyll, via Bundler, in the `dependencies` phase.
|
||||
|
||||
```yaml
|
||||
```
|
||||
dependencies:
|
||||
post:
|
||||
- bundle exec jekyll build
|
||||
@@ -61,9 +61,9 @@ test:
|
||||
|
||||
## Complete Example circle.yml File
|
||||
|
||||
When you put it all together, here's an example of what that `circle.yml` file could look like in v1:
|
||||
When you put it all together, here's an example of what that `circle.yml` file could look like:
|
||||
|
||||
```yaml
|
||||
```
|
||||
machine:
|
||||
environment:
|
||||
NOKOGIRI_USE_SYSTEM_LIBRARIES: true # speeds up installation of html-proofer
|
||||
@@ -83,75 +83,6 @@ deployment:
|
||||
- rsync -va --delete ./_site username@my-website:/var/html
|
||||
```
|
||||
|
||||
for CircleCI v2, a Docker-based system which new projects will follow, set the `S3_BUCKET_NAME` environment variable (an example of the required config file is shown below).
|
||||
|
||||
```yaml
|
||||
defaults: &defaults
|
||||
working_directory: ~/repo
|
||||
version: 2
|
||||
jobs:
|
||||
build:
|
||||
<<: *defaults
|
||||
docker:
|
||||
- image: circleci/ruby:2.5
|
||||
environment:
|
||||
BUNDLE_PATH: ~/repo/vendor/bundle
|
||||
steps:
|
||||
- checkout
|
||||
- restore_cache:
|
||||
keys:
|
||||
- rubygems-v1-{% raw %}{{ checksum "Gemfile.lock" }}{% endraw %}
|
||||
- rubygems-v1-fallback
|
||||
- run:
|
||||
name: Bundle Install
|
||||
command: bundle check || bundle install
|
||||
- run:
|
||||
name: HTMLProofer tests
|
||||
command: |
|
||||
bundle exec htmlproofer ./_site \
|
||||
--allow-hash-href \
|
||||
--check-favicon \
|
||||
--check-html \
|
||||
--disable-external
|
||||
- save_cache:
|
||||
key: rubygems-v1-{% raw %}{{ checksum "Gemfile.lock" }}{% endraw %}
|
||||
paths:
|
||||
- vendor/bundle
|
||||
- run:
|
||||
name: Jekyll build
|
||||
command: bundle exec jekyll build
|
||||
- persist_to_workspace:
|
||||
root: ./
|
||||
paths:
|
||||
- _site
|
||||
deploy:
|
||||
<<: *defaults
|
||||
docker:
|
||||
- image: circleci/python:3.6.3
|
||||
environment:
|
||||
S3_BUCKET_NAME: <<YOUR BUCKET NAME HERE>>
|
||||
steps:
|
||||
- attach_workspace:
|
||||
at: ./
|
||||
- run:
|
||||
name: Install AWS CLI
|
||||
command: pip install awscli --upgrade --user
|
||||
- run:
|
||||
name: Upload to s3
|
||||
command: ~/.local/bin/aws s3 sync ./_site s3://$S3_BUCKET_NAME/ --delete --acl public-read
|
||||
workflows:
|
||||
version: 2
|
||||
test-deploy:
|
||||
jobs:
|
||||
- build
|
||||
- deploy:
|
||||
requires:
|
||||
- build
|
||||
filters:
|
||||
branches:
|
||||
only: master
|
||||
```
|
||||
|
||||
## Questions?
|
||||
|
||||
This entire guide is open-source. Go ahead and [edit it][7] if you have a fix or [ask for help][8] if you run into trouble and need some help. CircleCI also has an [online community][9] for help.
|
||||
|
||||
@@ -7,4 +7,3 @@ Continuous Integration (CI) enables you to publish your Jekyll generated website
|
||||
|
||||
* [Travis CI](travis-ci)
|
||||
* [CircleCI](circleci)
|
||||
* [Buddy](buddyworks)
|
||||
|
||||
@@ -15,9 +15,10 @@ Enabling Travis builds for your GitHub repository is pretty simple:
|
||||
|
||||
1. Go to your profile on travis-ci.org: https://travis-ci.org/profile/username
|
||||
2. Find the repository for which you're interested in enabling builds.
|
||||
3. Flick the repository switch on so that it turns blue.
|
||||
3. Click the slider on the right so it says "ON" and is a dark grey.
|
||||
4. Optionally configure the build by clicking on the gear icon. Further
|
||||
configuration happens via your `.travis.yml` file. More details below.
|
||||
configuration happens in your `.travis.yml` file. More details on that
|
||||
below.
|
||||
|
||||
## 2. The Test Script
|
||||
|
||||
@@ -49,7 +50,7 @@ Some options can be specified via command-line switches. Check out the
|
||||
For example to avoid testing external sites, use this command:
|
||||
|
||||
```sh
|
||||
bundle exec htmlproofer ./_site --disable-external
|
||||
$ bundle exec htmlproofer ./_site --disable-external
|
||||
```
|
||||
|
||||
### The HTML Proofer Library
|
||||
@@ -76,7 +77,7 @@ with Ruby and requires RubyGems to install, we use the Ruby language build
|
||||
environment. Below is a sample `.travis.yml` file, followed by
|
||||
an explanation of each line.
|
||||
|
||||
**Note:** You will need a Gemfile as well, [Travis will automatically install](https://docs.travis-ci.com/user/languages/ruby/#Dependency-Management) the dependencies based on the referenced gems. Here is an example `Gemfile` with two referenced gems, "jekyll" and "html-proofer":
|
||||
**Note:** You will need a Gemfile as well, [Travis will automatically install](https://docs.travis-ci.com/user/languages/ruby/#Dependency-Management) the dependencies based on the referenced gems:
|
||||
|
||||
```ruby
|
||||
source "https://rubygems.org"
|
||||
@@ -90,7 +91,7 @@ Your `.travis.yml` file should look like this:
|
||||
```yaml
|
||||
language: ruby
|
||||
rvm:
|
||||
- 2.4.1
|
||||
- 2.3.3
|
||||
|
||||
before_script:
|
||||
- chmod +x ./script/cibuild # or do this locally and commit
|
||||
@@ -110,12 +111,6 @@ env:
|
||||
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
|
||||
|
||||
sudo: false # route your build to the container-based infrastructure for a faster build
|
||||
|
||||
cache: bundler # caching bundler gem packages will speed up build
|
||||
|
||||
# Optional: disable email notifications about the outcome of your builds
|
||||
notifications:
|
||||
email: false
|
||||
```
|
||||
|
||||
Ok, now for an explanation of each line:
|
||||
@@ -129,13 +124,12 @@ access to Bundler, RubyGems, and a Ruby runtime.
|
||||
|
||||
```yaml
|
||||
rvm:
|
||||
- 2.4.1
|
||||
- 2.3.3
|
||||
```
|
||||
|
||||
RVM is a popular Ruby Version Manager (like rbenv, chruby, etc). This
|
||||
directive tells Travis the Ruby version to use when running your test
|
||||
script. Use a [version which is pre-installed on the Travis build docker][5]
|
||||
image to speed up the build.
|
||||
script.
|
||||
|
||||
```yaml
|
||||
before_script:
|
||||
@@ -217,23 +211,6 @@ does need `sudo` access, modify the line to `sudo: required`.
|
||||
sudo: false
|
||||
```
|
||||
|
||||
To speed up the build, you should cache the gem packages created by `bundler`.
|
||||
Travis has a pre-defined [cache strategy for this tool][6] which should have
|
||||
all the default configs to do exactly that.
|
||||
|
||||
```yaml
|
||||
cache: bundler
|
||||
```
|
||||
|
||||
Optionally, if you are not interested in the build email notifications you
|
||||
can disable them with this configuration. Travis supports a wide array of
|
||||
notification services, you may find [another one more useful (e.g. slack)][7].
|
||||
|
||||
```yaml
|
||||
notifications:
|
||||
email: false
|
||||
```
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
**Travis error:** *"You are trying to install in deployment mode after changing
|
||||
@@ -251,6 +228,3 @@ fix or [ask for help][4] if you run into trouble and need some help.
|
||||
|
||||
[3]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/travis-ci.md
|
||||
[4]: https://jekyllrb.com/help/
|
||||
[5]: https://docs.travis-ci.com/user/languages/ruby/#Specifying-Ruby-versions-and-implementations
|
||||
[6]: https://docs.travis-ci.com/user/caching/#Caching-directories-(Bundler%2C-dependencies)
|
||||
[7]: https://docs.travis-ci.com/user/notifications/
|
||||
|
||||
@@ -8,7 +8,10 @@ Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is a
|
||||
|
||||
## Where to get help or report a problem
|
||||
|
||||
See [the support guidelines](https://jekyllrb.com/docs/support/)
|
||||
* If you have a question about using Jekyll, start a discussion on [Jekyll Talk](https://talk.jekyllrb.com).
|
||||
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository.
|
||||
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
|
||||
* More resources are listed on our [Help page](https://jekyllrb.com/help/).
|
||||
|
||||
## Ways to contribute
|
||||
|
||||
@@ -29,7 +32,7 @@ Whether you're a developer, a designer, or just a Jekyll devotee, there are lots
|
||||
|
||||
* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
|
||||
|
||||
* Pull requests are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
|
||||
* Pull request are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
|
||||
|
||||
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
|
||||
|
||||
@@ -115,37 +118,25 @@ If your contribution changes any Jekyll behavior, make sure to update the docume
|
||||
|
||||
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
|
||||
|
||||
* You can use the command `script/console` to start a REPL to explore the result of
|
||||
Jekyll's methods. It also provides you with helpful methods to quickly create a
|
||||
site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console)
|
||||
|
||||
## Running tests locally
|
||||
|
||||
### Test Dependencies
|
||||
|
||||
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
|
||||
|
||||
```sh
|
||||
script/bootstrap
|
||||
```
|
||||
<pre class="highlight"><code>$ script/bootstrap</code></pre>
|
||||
|
||||
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
|
||||
|
||||
```sh
|
||||
script/cibuild
|
||||
```
|
||||
<pre class="highlight"><code>$ script/cibuild</code></pre>
|
||||
|
||||
If you are only updating a file in `test/`, you can use the command:
|
||||
|
||||
```sh
|
||||
script/test test/blah_test.rb
|
||||
```
|
||||
<pre class="highlight"><code>$ script/test test/blah_test.rb</code></pre>
|
||||
|
||||
If you are only updating a `.feature` file, you can use the command:
|
||||
|
||||
```sh
|
||||
script/cucumber features/blah.feature
|
||||
```
|
||||
<pre class="highlight"><code>$ script/cucumber features/blah.feature</code></pre>
|
||||
|
||||
Both `script/test` and `script/cucumber` can be run without arguments to
|
||||
run its entire respective suite.
|
||||
|
||||
@@ -56,8 +56,8 @@ determines the variable name).
|
||||
|
||||
You can now render the list of members in a template:
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
<ul>
|
||||
{% for member in site.data.members %}
|
||||
<li>
|
||||
@@ -67,11 +67,8 @@ You can now render the list of members in a template:
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{: .note .info }
|
||||
If your Jekyll site has a lot of pages, such as with documentation websites, see the detailed examples in [how to build robust navigation for your site]({% link _tutorials/navigation.md %}).
|
||||
```
|
||||
|
||||
## Example: Organizations
|
||||
|
||||
@@ -106,8 +103,8 @@ members:
|
||||
The organizations can then be accessed via `site.data.orgs`, followed by the
|
||||
file name:
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
<ul>
|
||||
{% for org_hash in site.data.orgs %}
|
||||
{% assign org = org_hash[1] %}
|
||||
@@ -119,8 +116,8 @@ file name:
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
## Example: Accessing a specific author
|
||||
|
||||
@@ -136,8 +133,8 @@ dave:
|
||||
|
||||
The author can then be specified as a page variable in a post's frontmatter:
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
---
|
||||
title: sample post
|
||||
author: dave
|
||||
@@ -149,7 +146,6 @@ author: dave
|
||||
title="{{ author.name }}">
|
||||
{{ author.name }}
|
||||
</a>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
For information on how to build robust navigation for your site (especially if you have a documentation website or another type of Jekyll site with a lot of pages to organize), see [Navigation](/tutorials/navigation).
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
@@ -5,34 +5,9 @@ permalink: /docs/deployment-methods/
|
||||
|
||||
Sites built using Jekyll can be deployed in a large number of ways due to the static nature of the generated output. A few of the most common deployment techniques are described below.
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
|
||||
<p>GitHub Pages are powered by Jekyll behind the scenes, so if you’re looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
|
||||
</div>
|
||||
|
||||
## Netlify
|
||||
|
||||
Netlify provides Global CDN, Continuous Deployment, one click HTTPS and [much more](https://www.netlify.com/features/), providing developers the most robust toolset available for modern web projects, without added complexity. Netlify supports custom plugins for Jekyll and has a free plan for open source projects.
|
||||
|
||||
Read this [Jekyll step-by-step guide](https://www.netlify.com/blog/2015/10/28/a-step-by-step-guide-jekyll-3.0-on-netlify/) to setup your Jekyll site on Netlify.
|
||||
|
||||
## Aerobatic
|
||||
|
||||
[Aerobatic](https://www.aerobatic.com) has custom domains, global CDN distribution, basic auth, CORS proxying, and a growing list of plugins all included.
|
||||
|
||||
Automating the deployment of a Jekyll site is simple. See their [Jekyll docs](https://www.aerobatic.com/docs/static-site-generators/#jekyll) for more details. Your built `_site` folder is deployed to their highly-available, globally distributed hosting service.
|
||||
|
||||
## Kickster
|
||||
|
||||
Use [Kickster](http://kickster.nielsenramon.com/) for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
|
||||
|
||||
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
|
||||
|
||||
Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
|
||||
|
||||
## Web hosting providers (FTP)
|
||||
|
||||
Just about any traditional web hosting provider will let you upload files to their servers over FTP. To upload a Jekyll site to a web host using FTP, simply run the `jekyll build` command and copy the contents of the generated `_site` folder to the root folder of your hosting account. This is most likely to be the `httpdocs` or `public_html` folder on most hosting providers.
|
||||
Just about any traditional web hosting provider will let you upload files to their servers over FTP. To upload a Jekyll site to a web host using FTP, simply run the `jekyll build` command and copy the generated `_site` folder to the root folder of your hosting account. This is most likely to be the `httpdocs` or `public_html` folder on most hosting providers.
|
||||
|
||||
## Self-managed web server
|
||||
|
||||
@@ -66,15 +41,13 @@ server$ mkdir /var/www/myrepo
|
||||
Next, add the following lines to hooks/post-receive and be sure Jekyll is
|
||||
installed on the server:
|
||||
|
||||
```bash
|
||||
```sh
|
||||
GIT_REPO=$HOME/myrepo.git
|
||||
TMP_GIT_CLONE=$HOME/tmp/myrepo
|
||||
GEMFILE=$TMP_GIT_CLONE/Gemfile
|
||||
PUBLIC_WWW=/var/www/myrepo
|
||||
|
||||
git clone $GIT_REPO $TMP_GIT_CLONE
|
||||
BUNDLE_GEMFILE=$GEMFILE bundle install
|
||||
BUNDLE_GEMFILE=$GEMFILE bundle exec jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
|
||||
jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
|
||||
rm -Rf $TMP_GIT_CLONE
|
||||
exit
|
||||
```
|
||||
@@ -105,7 +78,7 @@ Another way to deploy your Jekyll site is to use [Rake](https://github.com/ruby/
|
||||
|
||||
### scp
|
||||
|
||||
Once you’ve generated the `_site` directory, you can easily scp its content using a
|
||||
Once you’ve generated the `_site` directory, you can easily scp it using a
|
||||
`tasks/deploy` shell script similar to [this deploy script][]. You’d obviously
|
||||
need to change the values to reflect your site’s details. There is even [a
|
||||
matching TextMate command][] that will help you run this script.
|
||||
@@ -116,7 +89,7 @@ matching TextMate command][] that will help you run this script.
|
||||
|
||||
### rsync
|
||||
|
||||
Once you’ve generated the `_site` directory, you can easily rsync its content using a `tasks/deploy` shell script similar to [this deploy script here](https://github.com/vitalyrepin/vrepinblog/blob/master/transfer.sh). You’d obviously need to change the values to reflect your site’s details.
|
||||
Once you’ve generated the `_site` directory, you can easily rsync it using a `tasks/deploy` shell script similar to [this deploy script here](https://github.com/vitalyrepin/vrepinblog/blob/master/transfer.sh). You’d obviously need to change the values to reflect your site’s details.
|
||||
|
||||
Certificate-based authorization is another way to simplify the publishing
|
||||
process. It makes sense to restrict rsync access only to the directory which it is supposed to sync. This can be done using rrsync.
|
||||
@@ -214,3 +187,22 @@ low-volume blogs as you only pay for what you use.
|
||||
|
||||
If you'd like to deploy your site to an OpenShift gear, there's [a cartridge
|
||||
for that](https://github.com/openshift-quickstart/jekyll-openshift).
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
|
||||
<p>GitHub Pages are powered by Jekyll behind the scenes, so if you’re looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
|
||||
</div>
|
||||
|
||||
## Kickster
|
||||
|
||||
Use [Kickster](http://kickster.nielsenramon.com/) for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
|
||||
|
||||
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
|
||||
|
||||
Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
|
||||
|
||||
## Aerobatic
|
||||
|
||||
[Aerobatic](https://www.aerobatic.com) is an add-on for Bitbucket that brings GitHub Pages style functionality to Bitbucket users. It includes continuous deployment, custom domains with a wildcard SSL cert, CDN, basic auth, and staging branches all in the box.
|
||||
|
||||
Automating the build and deployment of a Jekyll site is just as simple as GitHub Pages - push your changes to your repo (excluding the `_site` directory) and within seconds a build will be triggered and your built site deployed to our highly- available, globally distributed hosting service. The build process will even install and execute custom Ruby plugins. See our [Jekyll docs](https://www.aerobatic.com/docs/static-generators#jekyll) for more details.
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Working with drafts
|
||||
permalink: /docs/drafts/
|
||||
---
|
||||
|
||||
Drafts are posts without a date in the filename. They're posts you're still working on and
|
||||
Drafts are posts without a date. They're posts you're still working on and
|
||||
don't want to publish yet. To get up and running with drafts, create a
|
||||
`_drafts` folder in your site's root (as described in the [site structure](/docs/structure/) section) and create your
|
||||
first draft:
|
||||
|
||||
@@ -6,22 +6,12 @@ permalink: /docs/extras/
|
||||
There are a number of (optional) extra features that Jekyll supports that you
|
||||
may want to install, depending on how you plan to use Jekyll.
|
||||
|
||||
## Web Highlights and Commenting
|
||||
|
||||
Register your site with [txtpen](https://txtpen.com). Then append
|
||||
|
||||
```html
|
||||
<script src="https://txtpen.com/embed.js?site=<your site name>"></script>
|
||||
```
|
||||
|
||||
to your template files in `/_layout` folder.
|
||||
|
||||
## Math Support
|
||||
|
||||
Kramdown comes with optional support for LaTeX to PNG rendering via [MathJax](https://www.mathjax.org) within math blocks. See the Kramdown documentation on [math blocks](http://kramdown.gettalong.org/syntax.html#math-blocks) and [math support](http://kramdown.gettalong.org/converter/html.html#math-support) for more details. MathJax requires you to include JavaScript or CSS to render the LaTeX, e.g.
|
||||
|
||||
```html
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
|
||||
<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
|
||||
```
|
||||
|
||||
For more information about getting started, check out [this excellent blog post](http://gastonsanchez.com/visually-enforced/opinion/2014/02/16/Mathjax-with-jekyll/).
|
||||
|
||||
@@ -68,20 +68,6 @@ front matter of a page or post.
|
||||
<code>_layouts</code> directory.
|
||||
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
Using <code>null</code> will produce a file without using a layout
|
||||
file. However this is overridden if the file is a post/document and has a
|
||||
layout defined in the <a href="../configuration/#front-matter-defaults">
|
||||
frontmatter defaults</a>.
|
||||
</li>
|
||||
<li>
|
||||
Starting from version 3.5.0, using <code>none</code> in a post/document will
|
||||
produce a file without using a layout file regardless of frontmatter defaults.
|
||||
Using <code>none</code> in a page, however, will cause Jekyll to attempt to
|
||||
use a layout named "none".
|
||||
</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -113,14 +99,6 @@ front matter of a page or post.
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Render Posts Marked As Unpublished</h5>
|
||||
<p>
|
||||
To preview unpublished pages, simply run `jekyll serve` or `jekyll build`
|
||||
with the `--unpublished` switch. Jekyll also has a handy <a href="../drafts/">drafts</a>
|
||||
feature tailored specifically for blog posts.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Custom Variables
|
||||
|
||||
@@ -129,14 +107,14 @@ data that is sent to the Liquid templating engine during the conversion. For
|
||||
instance, if you set a title, you can use that in your layout to set the page
|
||||
title:
|
||||
|
||||
```liquid
|
||||
```html
|
||||
<!DOCTYPE HTML>
|
||||
<html>
|
||||
<head>
|
||||
<title>{% raw %}{{ page.title }}{% endraw %}</title>
|
||||
</head>
|
||||
<body>
|
||||
…
|
||||
...
|
||||
```
|
||||
|
||||
## Predefined Variables for Posts
|
||||
@@ -167,7 +145,7 @@ These are available out-of-the-box to be used in the front matter for a post.
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>category</code></p>
|
||||
<p style="margin-bottom: 5px;"><code>category</code></p>
|
||||
<p><code>categories</code></p>
|
||||
</td>
|
||||
<td>
|
||||
|
||||
@@ -4,82 +4,103 @@ permalink: /docs/github-pages/
|
||||
---
|
||||
|
||||
[GitHub Pages](https://pages.github.com) are public web pages for users,
|
||||
organizations, and repositories, that are freely hosted on GitHub's `github.io`
|
||||
domain or on a custom domain name of your choice. GitHub Pages are powered by
|
||||
Jekyll behind the scenes, so they're a great way to host your Jekyll-powered
|
||||
website for free.
|
||||
|
||||
Your site is automatically generated by GitHub Pages when you push your source
|
||||
files. Note that GitHub Pages works equally well for regular HTML content,
|
||||
simply because Jekyll treats files without YAML front matter as static assets.
|
||||
So if you only need to push generated HTML, you're good to go without any
|
||||
further setup.
|
||||
organizations, and repositories, that are freely hosted on GitHub's
|
||||
`github.io` domain or on a custom domain name of your choice. GitHub Pages are
|
||||
powered by Jekyll behind the scenes, so in addition to supporting regular HTML
|
||||
content, they’re also a great way to host your Jekyll-powered website for free.
|
||||
|
||||
Never built a website with GitHub Pages before? [See this marvelous guide by
|
||||
Jonathan McGlone](http://jmcglone.com/guides/github-pages/) to get you up and
|
||||
running. This guide will teach you what you need to know about Git, GitHub, and
|
||||
Jekyll to create your very own website on GitHub Pages.
|
||||
|
||||
## The github-pages gem
|
||||
|
||||
Our friends at GitHub have provided the
|
||||
[github-pages](https://github.com/github/pages-gem) gem which is used to manage
|
||||
[Jekyll and its dependencies on GitHub Pages](https://pages.github.com/versions/).
|
||||
Using it in your projects means that when you deploy your site to GitHub Pages,
|
||||
you will not be caught by unexpected differences between various versions of the
|
||||
gems.
|
||||
|
||||
Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted
|
||||
plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins).
|
||||
|
||||
To use the currently-deployed version of the gem in your project, add the
|
||||
following to your `Gemfile`:
|
||||
|
||||
```ruby
|
||||
source "https://rubygems.org"
|
||||
|
||||
gem "github-pages", group: :jekyll_plugins
|
||||
```
|
||||
|
||||
Be sure to run `bundle update` often.
|
||||
|
||||
<div class="note">
|
||||
<h5>GitHub Pages Documentation, Help, and Support</h5>
|
||||
<p>
|
||||
For more information about what you can do with GitHub Pages, as well as for
|
||||
troubleshooting guides, you should check out
|
||||
<a href="https://help.github.com/categories/github-pages-basics/">GitHub’s Pages Help section</a>.
|
||||
If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>.
|
||||
</p>
|
||||
</div>
|
||||
Jonathan McGlone to get you up and running](http://jmcglone.com/guides/github-pages/).
|
||||
This guide will teach you what you need to know about Git, GitHub, and Jekyll to create your very own website on GitHub Pages.
|
||||
|
||||
### Project Page URL Structure
|
||||
|
||||
Sometimes it's nice to preview your Jekyll site before you push your `gh-pages`
|
||||
branch to GitHub. However, the subdirectory-like URL structure GitHub uses for
|
||||
Project Pages complicates the proper resolution of URLs. In order to assure your
|
||||
site builds properly, use the handy [URL filters](../templates/#filters):
|
||||
Project Pages complicates the proper resolution of URLs. In order to assure your site builds properly, use `site.github.url` in your URL's.
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
<!-- For styles with static names... -->
|
||||
<link href="{{ "/assets/css/style.css" | relative_url }}" rel="stylesheet">
|
||||
<!-- For documents/pages whose URLs can change... -->
|
||||
[{{ page.title }}]("{{ page.url | relative_url }}")
|
||||
```
|
||||
<!-- Useful for styles with static names... -->
|
||||
<link href="{{ site.github.url }}/path/to/css.css" rel="stylesheet">
|
||||
<!-- and for documents/pages whose URL's can change... -->
|
||||
[{{ page.title }}]("{{ page.url | prepend: site.github.url }}")
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
This way you can preview your site locally from the site root on localhost,
|
||||
but when GitHub generates your pages from the `gh-pages` branch all the URLs
|
||||
but when GitHub generates your pages from the gh-pages branch all the URLs
|
||||
will resolve properly.
|
||||
|
||||
## Deploying Jekyll to GitHub Pages
|
||||
|
||||
GitHub Pages work by looking at certain branches of repositories on GitHub.
|
||||
There are two basic types available: [user/organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/).
|
||||
There are two basic types available: user/organization pages and project pages.
|
||||
The way to deploy these two types of sites are nearly identical, except for a
|
||||
few minor details.
|
||||
|
||||
<div class="note protip" markdown="1">
|
||||
<div markdown="1">
|
||||
</div>
|
||||
|
||||
##### Use the `github-pages` gem
|
||||
|
||||
Our friends at GitHub have provided the
|
||||
[github-pages](https://github.com/github/pages-gem)
|
||||
gem which is used to manage Jekyll and its dependencies on
|
||||
GitHub Pages. Using it in your projects means that when you deploy
|
||||
your site to GitHub Pages, you will not be caught by unexpected
|
||||
differences between various versions of the gems. To use the
|
||||
currently-deployed version of the gem in your project, add the
|
||||
following to your `Gemfile`:
|
||||
|
||||
<div class="code-block" markdown="1">
|
||||
<div markdown="1">
|
||||
</div>
|
||||
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
|
||||
require 'json'
|
||||
require 'open-uri'
|
||||
versions = JSON.parse(open('https://pages.github.com/versions.json').read)
|
||||
|
||||
gem 'github-pages', versions['github-pages']
|
||||
```
|
||||
</div>
|
||||
|
||||
This will ensure that when you run `bundle install`, you
|
||||
have the correct version of the `github-pages` gem.
|
||||
|
||||
If that fails, simplify it:
|
||||
|
||||
<div class="code-block" markdown="1">
|
||||
<div markdown="1">
|
||||
</div>
|
||||
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
|
||||
gem 'github-pages'
|
||||
```
|
||||
</div>
|
||||
|
||||
And be sure to run `bundle update` often.
|
||||
|
||||
If you like to install `pages-gem` on Windows you can find instructions by Jens Willmer on
|
||||
[how to install github-pages gem on Windows (x64)](https://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46#github-pages-and-plugins).
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Installing <code>github-pages</code> gem on Windows</h5>
|
||||
<p>
|
||||
While Windows is not officially supported, it is possible
|
||||
to install <code>github-pages</code> gem on Windows.
|
||||
Special instructions can be found on our
|
||||
<a href="../windows/#installation">Windows-specific docs page</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
### User and Organization Pages
|
||||
|
||||
User and organization pages live in a special GitHub repository dedicated to
|
||||
@@ -119,7 +140,7 @@ Please refer to GitHub official documentation on
|
||||
to see more detailed examples.
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Source files must be in the root directory</h5>
|
||||
<h5>Source Files Must be in the Root Directory</h5>
|
||||
<p>
|
||||
GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a>
|
||||
the <a href="/docs/configuration/#global-configuration">“Site Source”</a>
|
||||
@@ -128,13 +149,12 @@ to see more detailed examples.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Installing the <code>github-pages</code> gem on Windows</h5>
|
||||
|
||||
<div class="note">
|
||||
<h5>GitHub Pages Documentation, Help, and Support</h5>
|
||||
<p>
|
||||
While Windows is not officially supported, it is possible
|
||||
to install the <code>github-pages</code> gem on Windows.
|
||||
Special instructions can be found on our
|
||||
<a href="../windows/#installation">Windows-specific docs page</a>.
|
||||
For more information about what you can do with GitHub Pages, as well as for
|
||||
troubleshooting guides, you should check out
|
||||
<a href="https://help.github.com/categories/github-pages-basics/">GitHub’s Pages Help section</a>.
|
||||
If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -5,11 +5,9 @@ permalink: /docs/includes/
|
||||
|
||||
The `include` tag allows you to include the content from another file stored in the `_includes` folder:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% include footer.html %}
|
||||
{% raw %}{% include footer.html %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Jekyll will look for the referenced file (in this case, `footer.html`) in the `_includes` directory at the root of your source directory and insert its contents.
|
||||
|
||||
@@ -17,11 +15,9 @@ Jekyll will look for the referenced file (in this case, `footer.html`) in the `_
|
||||
|
||||
You can choose to include file fragments relative to the current file by using the `include_relative` tag:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% include_relative somedir/footer.html %}
|
||||
{% raw %}{% include_relative somedir/footer.html %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
You won't need to place your included content within the `_includes` directory. Instead,
|
||||
the inclusion is specifically relative to the file where the tag is being used. For example,
|
||||
@@ -46,11 +42,9 @@ my_variable: footer_company_a.html
|
||||
|
||||
You could then reference that variable in your include:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% include {{ page.my_variable }} %}
|
||||
{% raw %}{% include {{ page.my_variable }} %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
In this example, the include would insert the file `footer_company_a.html` from the `_includes/footer_company_a.html` directory.
|
||||
|
||||
@@ -58,22 +52,18 @@ In this example, the include would insert the file `footer_company_a.html` from
|
||||
|
||||
You can also pass parameters to an include. For example, suppose you have a file called `note.html` in your `_includes` folder that contains this formatting:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
<div markdown="span" class="alert alert-info" role="alert">
|
||||
{% raw %}<div markdown="span" class="alert alert-info" role="alert">
|
||||
<i class="fa fa-info-circle"></i> <b>Note:</b>
|
||||
{{ include.content }}
|
||||
</div>
|
||||
</div>{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The `{% raw %}{{ include.content }}{% endraw %}` is a parameter that gets populated when you call the include and specify a value for that parameter, like this:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% include note.html content="This is my sample note." %}
|
||||
{% raw %}{% include note.html content="This is my sample note." %} {% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The value of `content` (which is `This is my sample note`) will be inserted into the {% raw %}`{{ include.content }}`{% endraw %} parameter.
|
||||
|
||||
@@ -86,24 +76,20 @@ For example, suppose you have a special image syntax with complex formatting, an
|
||||
<a href="http://jekyllrb.com">
|
||||
<img src="logo.png" style="max-width: 200px;"
|
||||
alt="Jekyll logo" />
|
||||
</a>
|
||||
<figcaption>This is the Jekyll logo</figcaption>
|
||||
</figure>
|
||||
```
|
||||
|
||||
You could templatize this content in your include and make each value available as a parameter, like this:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
<figure>
|
||||
{% raw %}<figure>
|
||||
<a href="{{ include.url }}">
|
||||
<img src="{{ include.file }}" style="max-width: {{ include.max-width }};"
|
||||
alt="{{ include.alt }}"/>
|
||||
</a>
|
||||
<figcaption>{{ include.caption }}</figcaption>
|
||||
</figure>
|
||||
</figure>{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
This include contains 5 parameters:
|
||||
|
||||
@@ -115,17 +101,15 @@ This include contains 5 parameters:
|
||||
|
||||
Here's an example that passes all the parameters to this include (the include file is named `image.html`):
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% include image.html url="http://jekyllrb.com"
|
||||
{% raw %}{% include image.html url="http://jekyllrb.com"
|
||||
max-width="200px" file="logo.png" alt="Jekyll logo"
|
||||
caption="This is the Jekyll logo." %}
|
||||
caption="This is the Jekyll logo." %} {% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
The result is the original HTML code shown earlier.
|
||||
|
||||
To safeguard situations where users don't supply a value for the parameter, you can use [Liquid's default filter](https://shopify.github.io/liquid/filters/default/).
|
||||
To safeguard situations where users don't supply a value for the parameter, you can use [Liquid's default filter](https://help.shopify.com/themes/liquid/filters/additional-filters#default).
|
||||
|
||||
Overall, you can create includes that act as templates for a variety of uses — inserting audio or video clips, alerts, special formatting, and more. However, note that you should avoid using too many includes, as this will slow down the build time of your site. For example, don't use includes every time you insert an image. (The above technique shows a use case for special images.)
|
||||
|
||||
@@ -137,21 +121,16 @@ The string you pass to your include parameter can't contain curly braces. For ex
|
||||
|
||||
If you want to include this variable in your parameter that you pass to an include, you need to store the entire parameter as a variable before passing it to the include. You can use `capture` tags to create the variable:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% capture download_note %}
|
||||
The latest version of {{ site.product_name }} is now available.
|
||||
{% endcapture %}
|
||||
{% raw %}{% capture download_note %}The latest version of
|
||||
{{ site.product_name }} is now available.{% endcapture %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Then pass this captured variable into the parameter for the include. Omit the quotation marks around the parameter content because it's no longer a string (it's a variable):
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% include note.html content=download_note %}
|
||||
{% raw %}{% include note.html content=download_note %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### Passing references to YAML files as parameter values
|
||||
|
||||
@@ -171,22 +150,18 @@ Here's an example. In the `_data` folder, suppose you have a YAML file called `p
|
||||
|
||||
In the `_includes` folder, assume you have a file called `spotlight.html` with this code:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% for person in include.participants %}
|
||||
{% raw %}{% for person in {{ include.participants }} %}
|
||||
{% if person.login_age == "new" %}
|
||||
{{ person.name }}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endfor %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Now when you insert the `spotlight.html` include file, you can submit the YAML file as a parameter:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% include spotlight.html participants=site.data.profiles %}
|
||||
```
|
||||
{% endraw %}
|
||||
{% raw %}{% include spotlight.html participants=site.data.profiles %}{% endraw %}
|
||||
```
|
||||
|
||||
In this instance, `site.data.profiles` gets inserted in place of {% raw %}`include.participants`{% endraw %} in the include file, and the Liquid logic processes. The result will be `Jane Doe`.
|
||||
In this instance, `site.data.profiles` gets inserted in place of {% raw %}`{{ include.participants }}`{% endraw %} in the include file, and the Liquid logic processes. The result will be `Jane Doe`.
|
||||
|
||||
@@ -4,38 +4,53 @@ permalink: /docs/home/
|
||||
redirect_from: /docs/index.html
|
||||
---
|
||||
|
||||
This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying.
|
||||
This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such
|
||||
as getting your site up and running, creating and managing your content,
|
||||
customizing the way your site works and looks, deploying to various
|
||||
environments, and give you some advice on participating in the future
|
||||
development of Jekyll itself.
|
||||
|
||||
## What is Jekyll, exactly?
|
||||
## So what is Jekyll, exactly?
|
||||
|
||||
Jekyll is a simple, blog-aware, static site generator.
|
||||
Jekyll is a simple, blog-aware, static site generator. It takes a template
|
||||
directory containing raw text files in various formats, runs it through
|
||||
a converter (like [Markdown](https://daringfireball.net/projects/markdown/))
|
||||
and our [Liquid](https://github.com/Shopify/liquid/wiki) renderer, and
|
||||
spits out a complete, ready-to-publish static website suitable
|
||||
for serving with your favorite web server. Jekyll also happens to be the engine
|
||||
behind [GitHub Pages](https://pages.github.com), which means you can use Jekyll
|
||||
to host your project’s page, blog, or website from GitHub’s servers **for
|
||||
free**.
|
||||
|
||||
You create your content as text files ([Markdown](https://daringfireball.net/projects/markdown/)), and organize them into folders. Then, you build the shell of your site using [Liquid](https://shopify.github.io/liquid/)-enhanced HTML templates. Jekyll automatically stitches the content and templates together, generating a website made entirely of static assets, suitable for uploading to any server.
|
||||
## Helpful Hints
|
||||
|
||||
Jekyll happens to be the engine behind [GitHub Pages](https://pages.github.com), so you can host your project’s Jekyll page/blog/website on GitHub’s servers **for free**.
|
||||
|
||||
## Navigating the Guide
|
||||
|
||||
Throughout this guide, you'll see these special sections that help you get the most out of Jekyll:
|
||||
Throughout this guide there are a number of small-but-handy pieces of
|
||||
information that can make using Jekyll easier, more interesting, and less
|
||||
hazardous. Here’s what to look out for.
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTips™</h5>
|
||||
<p>Tips and tricks that'll make you a Jekyll wizard!</p>
|
||||
<h5>ProTips™ help you get more from Jekyll</h5>
|
||||
<p>These are tips and tricks that will help you be a Jekyll wizard!</p>
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Notes</h5>
|
||||
<p>Extra tidbits that are sometimes necessary to understand Jekyll.</p>
|
||||
<h5>Notes are handy pieces of information</h5>
|
||||
<p>These are for the extra tidbits sometimes necessary to understand
|
||||
Jekyll.</p>
|
||||
</div>
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Warnings</h5>
|
||||
<p>Common pitfalls to avoid.</p>
|
||||
<h5>Warnings help you not blow things up</h5>
|
||||
<p>Be aware of these messages if you wish to avoid certain death.</p>
|
||||
</div>
|
||||
|
||||
<div class="note unreleased">
|
||||
<h5>Unreleased</h5>
|
||||
<p>Features planned for future versions of Jekyll, but not available yet.</p>
|
||||
<h5>You'll see this by a feature that hasn't been released</h5>
|
||||
<p>Some pieces of this website are for future versions of Jekyll that
|
||||
are not yet released.</p>
|
||||
</div>
|
||||
|
||||
If you find anything we haven’t covered, or would like to share a tip that others might find handy, please [file an issue]({{ site.repository }}/issues/new) and we’ll see about adding it to the guide.
|
||||
If you come across anything along the way that we haven’t covered, or if you
|
||||
know of a tip you think others would find handy, please [file an
|
||||
issue]({{ site.repository }}/issues/new) and we’ll see about
|
||||
including it in this guide.
|
||||
|
||||
@@ -1,175 +1,61 @@
|
||||
---
|
||||
title: Installation
|
||||
description: Official guide to install Jekyll on macOS, GNU/Linux or Windows.
|
||||
permalink: /docs/installation/
|
||||
---
|
||||
|
||||
Jekyll is a [Ruby Gem](http://guides.rubygems.org/rubygems-basics/), and can be
|
||||
installed on most systems.
|
||||
Getting Jekyll installed and ready-to-go should only take a few minutes.
|
||||
If it ever becomes a pain, please [file an issue]({{ site.repository }}/issues/new)
|
||||
(or submit a pull request) describing the issue you
|
||||
encountered and how we might make the process easier.
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Install Jekyll on macOS](#macOS)
|
||||
- [Install Jekyll on Ubuntu Linux](#ubuntu)
|
||||
- [Install Jekyll on Windows](../windows/)
|
||||
- [Upgrade Jekyll](#upgrade-jekyll)
|
||||
### Requirements
|
||||
|
||||
## Requirements
|
||||
Installing Jekyll is easy and straight-forward, but there are a few
|
||||
requirements you’ll need to make sure your system has before you start.
|
||||
|
||||
Before you start, make sure your system has the following:
|
||||
|
||||
- [Ruby](https://www.ruby-lang.org/en/downloads/) version 2.2.5 or above, including all development headers (ruby installation can be checked by running `ruby -v`)
|
||||
- [RubyGems](https://rubygems.org/pages/download) (which you can check by running `gem -v`)
|
||||
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v`,`g++ -v` and `make -v` in your system's command line interface)
|
||||
|
||||
## Install on macOS {#macOS}
|
||||
|
||||
We only cover macOS High Sierra 10.13 here, which comes with Ruby 2.3.3, older systems will need to [install a more recent Ruby version via Homebrew](#homebrew).
|
||||
|
||||
First, you need to install the command-line tools to be able to compile native extensions, open a terminal and run:
|
||||
|
||||
```sh
|
||||
xcode-select --install
|
||||
```
|
||||
|
||||
### Set up Ruby included with the OS
|
||||
|
||||
Check your Ruby version meet our requirements:
|
||||
|
||||
```sh
|
||||
ruby -v
|
||||
2.3.3
|
||||
```
|
||||
|
||||
Great, let's install Jekyll. We also need [Bundler](https://bundler.io/) to help us handle [plugins](../plugins) and [themes](../themes):
|
||||
|
||||
```sh
|
||||
gem install bundler jekyll
|
||||
```
|
||||
|
||||
That's it, you're ready to go, either by installing our [default minimal blog theme](https://github.com/jekyll/minima) with `jekyll new jekyll-website` or by starting from scratch:
|
||||
|
||||
```sh
|
||||
mkdir jekyll-website
|
||||
cd jekyll-website
|
||||
|
||||
# Create a Gemfile
|
||||
bundle init
|
||||
|
||||
# Add Jekyll
|
||||
bundle add jekyll
|
||||
|
||||
# Install gems
|
||||
bundle install
|
||||
```
|
||||
|
||||
Great, from there you can now either use a [theme](../themes/) or [create your own layouts](../templates/).
|
||||
|
||||
### Install a newer Ruby version via Homebrew {#homebrew}
|
||||
|
||||
If you wish to install the latest version of Ruby and get faster builds, we recommend to do it via [Homebrew](https://brew.sh) a handy package manager for macOS.
|
||||
|
||||
```sh
|
||||
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
|
||||
brew install ruby
|
||||
ruby -v
|
||||
ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin17]
|
||||
```
|
||||
|
||||
Yay! Now you have a shiny Ruby on your system!
|
||||
|
||||
### Install multiple Ruby versions with rbenv {#rbenv}
|
||||
|
||||
Developers often use [rbenv](https://github.com/rbenv/rbenv) to manage multiple Ruby versions. This can be useful if you want to run the same Ruby version used by [GitHub Pages](https://pages.github.com/versions/) or [Netlify](https://www.netlify.com/docs/#ruby) for instance.
|
||||
|
||||
```sh
|
||||
# Install rbenv and ruby-build
|
||||
brew install rbenv
|
||||
|
||||
# Setup rbenv integration to your shell
|
||||
rbenv init
|
||||
|
||||
# Check your install
|
||||
curl -fsSL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-doctor | bash
|
||||
```
|
||||
|
||||
Restart your terminal for changes to take effect.
|
||||
Now we can install the Ruby version of our choice, let's go with Ruby 2.5.1 here:
|
||||
|
||||
```sh
|
||||
rbenv install 2.5.1
|
||||
rbenv global 2.5.1
|
||||
ruby -v
|
||||
ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin17]
|
||||
```
|
||||
|
||||
That's it! Head over [rbenv command references](https://github.com/rbenv/rbenv#command-reference) to learn how to use different versions of Ruby in your projects.
|
||||
|
||||
<div class="note info" markdown="1">
|
||||
|
||||
##### Problems installing Jekyll?
|
||||
|
||||
Check out the [troubleshooting](../troubleshooting/) page or
|
||||
[ask for help on our forum](https://talk.jekyllrb.com).
|
||||
- [Ruby](https://www.ruby-lang.org/en/downloads/) (including development
|
||||
headers, v1.9.3 or above for Jekyll 2 and v2 or above for Jekyll 3)
|
||||
- [RubyGems](https://rubygems.org/pages/download)
|
||||
- Linux, Unix, or macOS
|
||||
- [NodeJS](https://nodejs.org/), or another JavaScript runtime (Jekyll 2 and
|
||||
earlier, for CoffeeScript support).
|
||||
- [Python 2.7](https://www.python.org/downloads/) (for Jekyll 2 and earlier)
|
||||
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v` and `make -v` in your system's command line interface)
|
||||
|
||||
<div class="note info">
|
||||
<h5>Running Jekyll on Windows</h5>
|
||||
<p>
|
||||
While Windows is not officially supported, it is possible to get it running
|
||||
on Windows. Special instructions can be found on our
|
||||
<a href="../windows/#installation">Windows-specific docs page</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Install on Ubuntu Linux {#ubuntu}
|
||||
## Install with RubyGems
|
||||
|
||||
Before we install Jekyll, we need to make sure we have all the required
|
||||
dependencies.
|
||||
The best way to install Jekyll is via
|
||||
[RubyGems](https://rubygems.org/pages/download). At the terminal prompt,
|
||||
simply run the following command to install Jekyll:
|
||||
|
||||
```sh
|
||||
sudo apt-get install ruby ruby-dev build-essential
|
||||
$ gem install jekyll
|
||||
```
|
||||
|
||||
It is best to avoid installing Ruby Gems as the root user. Therefore, we need to
|
||||
set up a gem installation directory for your user account. The following
|
||||
commands will add environment variables to your `~/.bashrc` file to configure
|
||||
the gem installation path. Run them now:
|
||||
All of Jekyll’s gem dependencies are automatically installed by the above
|
||||
command, so you won’t have to worry about them at all. If you have problems
|
||||
installing Jekyll, check out the [troubleshooting](../troubleshooting/) page or
|
||||
[report an issue]({{ site.repository }}/issues/new) so the Jekyll
|
||||
community can improve the experience for everyone.
|
||||
|
||||
```sh
|
||||
echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
|
||||
echo 'export GEM_HOME=$HOME/gems' >> ~/.bashrc
|
||||
echo 'export PATH=$HOME/gems/bin:$PATH' >> ~/.bashrc
|
||||
source ~/.bashrc
|
||||
```
|
||||
|
||||
Finally, install Jekyll:
|
||||
|
||||
```sh
|
||||
gem install jekyll bundler
|
||||
```
|
||||
|
||||
That's it! You're ready to start using Jekyll.
|
||||
|
||||
## Upgrade Jekyll
|
||||
|
||||
Before you start developing with Jekyll, you may want to check that you're up to date with the latest version. To find the currently installed version of Jekyll, run one of these commands:
|
||||
|
||||
```sh
|
||||
jekyll --version
|
||||
gem list jekyll
|
||||
```
|
||||
|
||||
You can use RubyGems to find [the current version of Jekyll](https://rubygems.org/gems/jekyll). Another way to check if you have the latest version is to run the command `gem outdated`. This will provide a list of all the gems on your system that need to be updated. If you aren't running the latest version, run this command:
|
||||
|
||||
```sh
|
||||
bundle update jekyll
|
||||
```
|
||||
|
||||
Alternatively, if you don't have Bundler installed run:
|
||||
|
||||
```sh
|
||||
gem update jekyll
|
||||
```
|
||||
|
||||
To upgrade to latest Rubygems, run:
|
||||
|
||||
```
|
||||
gem update --system
|
||||
```
|
||||
|
||||
Refer to our [upgrading section](../upgrading/) to upgrade from Jekyll 2.x or 1.x.
|
||||
<div class="note info">
|
||||
<h5>Installing Xcode Command-Line Tools</h5>
|
||||
<p>
|
||||
If you run into issues installing Jekyll's dependencies which make use of
|
||||
native extensions and are using macOS, you will need to install Xcode
|
||||
and the Command-Line Tools it ships with. Download them in
|
||||
<code>Preferences → Downloads → Components</code>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Pre-releases
|
||||
|
||||
@@ -192,11 +78,50 @@ more involved. This gives you the advantage of having the latest and greatest,
|
||||
but may be unstable.
|
||||
|
||||
```sh
|
||||
git clone git://github.com/jekyll/jekyll.git
|
||||
cd jekyll
|
||||
script/bootstrap
|
||||
bundle exec rake build
|
||||
ls pkg/*.gem | head -n 1 | xargs gem install -l
|
||||
$ git clone git://github.com/jekyll/jekyll.git
|
||||
$ cd jekyll
|
||||
$ script/bootstrap
|
||||
$ bundle exec rake build
|
||||
$ ls pkg/*.gem | head -n 1 | xargs gem install -l
|
||||
```
|
||||
|
||||
## Optional Extras
|
||||
|
||||
There are a number of (optional) extra features that Jekyll supports that you
|
||||
may want to install, depending on how you plan to use Jekyll. These extras
|
||||
include LaTeX support, and the use of alternative content rendering engines.
|
||||
Check out [the extras page](../extras/) for more information.
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Enable Syntax Highlighting</h5>
|
||||
<p>
|
||||
If you’re the kind of person who is using Jekyll, then chances are you’ll
|
||||
want to enable syntax highlighting using <a href="http://pygments.org/">Pygments</a>
|
||||
or <a href="https://github.com/jayferd/rouge">Rouge</a>. You should really
|
||||
<a href="../templates/#code-snippet-highlighting">check out how to
|
||||
do that</a> before you go any farther.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Already Have Jekyll?
|
||||
|
||||
Before you start developing with Jekyll, you may want to check that you're up to date with the latest version. To find your version of Jekyll, run one of these commands:
|
||||
|
||||
```sh
|
||||
$ jekyll --version
|
||||
$ gem list jekyll
|
||||
```
|
||||
|
||||
You can also use [RubyGems](https://rubygems.org/gems/jekyll) to find the current versioning of any gem. But you can also use the `gem` command line tool:
|
||||
|
||||
```sh
|
||||
$ gem search jekyll --remote
|
||||
```
|
||||
|
||||
and you'll search for just the name `jekyll`, and in brackets will be latest version. Another way to check if you have the latest version is to run the command `gem outdated`. This will provide a list of all the gems on your system that need to be updated. If you aren't running the latest version, run this command:
|
||||
|
||||
```sh
|
||||
$ gem update jekyll
|
||||
```
|
||||
|
||||
Now that you’ve got everything up-to-date and installed, let’s get to work!
|
||||
|
||||
@@ -7,11 +7,11 @@ title: "Avoiding Burnout"
|
||||
|
||||
# 1. Use Jekyll
|
||||
|
||||
Maintainers of Jekyll should be using it regularly. This is partly because you won't be a good maintainer unless you can put yourself in the shoes of our users, but also because you may at some point decide to stop using Jekyll, and at that point you should also decide to stop being a maintainer and find other things to work on.
|
||||
Maintainers of Jekyll should be using it regularly. This is partly because you won't be a good maintainer unless you can put yourself in the shoes of our users but also because you may decide to stop using Jekyll and at that point you should also decide not to be a maintainer and find other things to work on.
|
||||
|
||||
# 2. No Guilt About Leaving
|
||||
|
||||
All maintainers can stop working on Jekyll at any time without any guilt or explanation (like at a job). We may still ask for your help with questions after you leave but you are under no obligation to answer them. If you create a big mess and then leave you still have no obligations but we may think less of you (or, realistically, probably just revert the problematic work). Also, you should probably take a break from Jekyll at least a few times a year.
|
||||
All maintainers can stop working on Jekyll at any time without any guilt or explanation (like a job). We may still ask for your help with questions after you leave but you are under no obligation to answer them. Like a job, if you create a big mess and then leave you still have no obligations but we may think less of you (or, realistically, probably just revert the problematic work). Like a job, you should probably take a break from Jekyll at least a few times a year.
|
||||
|
||||
This also means contributors should be consumers. If a maintainer finds they are not using a project in the real-world, they should reconsider their involvement with the project.
|
||||
|
||||
|
||||
@@ -8,14 +8,13 @@ permalink: /docs/maintaining/
|
||||
|
||||
Hello! This is where we document various processes for maintaining Jekyll. Being a maintainer for any Jekyll project is a big responsibility, so we put together some helpful documentation for various tasks you might do as a maintainer.
|
||||
|
||||
- [Affinity teams & their captains](affinity-team-captain/)
|
||||
- [Triaging an issue](triaging-an-issue/)
|
||||
- [Reviewing a pull request](reviewing-a-pull-request/)
|
||||
- [Merging a pull request](merging-a-pull-request/)
|
||||
- [Avoiding burnout](avoiding-burnout/)
|
||||
- [Special Labels](special-labels/)
|
||||
- [Releasing a new version](releasing-a-new-version/)
|
||||
1. [Affinity teams & their captains](affinity-team-captain/)
|
||||
2. [Triaging and issue](triaging-an-issue/)
|
||||
3. [Reviewing a pull request](reviewing-a-pull-request/)
|
||||
4. [Merging a pull request](merging-a-pull-request/)
|
||||
5. [Avoiding burnout](avoiding-burnout/)
|
||||
6. [Special Labels](special-labels/)
|
||||
|
||||
Interested in becoming a maintainer? Here is some documentation for **contributors**:
|
||||
|
||||
- [Becoming a maintainer](becoming-a-maintainer/)
|
||||
1. [Becoming a maintainer](becoming-a-maintainer/)
|
||||
|
||||
@@ -16,7 +16,7 @@ All pull requests should be subject to code review. Code review is a [foundation
|
||||
We have [a helpful little bot](https://github.com/jekyllbot) which we use to merge pull requests. We don't use the GitHub.com interface for two reasons:
|
||||
|
||||
1. You can't modify anything on mobile (e.g. titles, labels)
|
||||
2. We like to provide a consistent paper trail in the `History.markdown` file for each release
|
||||
2. Provide a consistent paper trail in the `History.markdown` file for each release
|
||||
|
||||
To merge a pull request, leave a comment thanking the contributor, then add the special merge request:
|
||||
|
||||
@@ -30,12 +30,12 @@ The merge request is made up of three things:
|
||||
|
||||
1. `@jekyllbot:` – this is the prefix our bot looks for when processing commands
|
||||
2. `merge` – the command
|
||||
3. `+dev` – the category to which the changes belong.
|
||||
3. `+dev` – the category to which the changes belong
|
||||
|
||||
The categories match the headings in the `History.markdown` file, and they are:
|
||||
The categories match the H3's in the history/changelog file, and they are:
|
||||
|
||||
1. Major Enhancements (`+major`) – major updates or breaking changes to the code which necessitate a major version bump (v3 ~> v4)
|
||||
2. Minor Enhancements (`+minor`) – minor updates (with the labels `feature` or `enhancement`) which necessitate a minor version bump (v3.1 ~> v3.2)
|
||||
2. Minor Enhancements (`+minor`) – minor updates (feature, enhancement) which necessitate a minor version bump (v3.1 ~> v3.2)
|
||||
3. Bug Fixes (`+bug`) – corrections to code which do not change or add functionality, which necessitate a patch version bump (v3.1.0 ~> v3.1.1)
|
||||
4. Documentation (`+doc`) - changes to the documentation found in `docs/_docs/`
|
||||
5. Site Enhancements (`+site`) – changes to the source of [https://jekyllrb.com](https://jekyllrb.com) found in `docs/`
|
||||
|
||||
@@ -1,89 +0,0 @@
|
||||
---
|
||||
title: "Releasing a new version"
|
||||
---
|
||||
|
||||
**This guide is for maintainers.** These special people have **write access** to one or more of Jekyll's repositories and help merge the contributions of others. You may find what is written here interesting, but it’s definitely not for everyone.
|
||||
{: .note .info }
|
||||
|
||||
The most important thing to understand before making a release is that there's no need to feel nervous. Most things are revertable, and even if you do publish an incomplete gem version, we can always skip that one. Don't hestitate to contact the other maintainers if you feel unsure or don't know what to do next.
|
||||
|
||||
### Bump the version
|
||||
|
||||
The only important place you need to manually bump the version is in `lib/jekyll/version.rb`. Adjust that, and everything else should work fine.
|
||||
|
||||
### Update the history document
|
||||
|
||||
Replace the first header of the history document with a version milestone. This looks like the following:
|
||||
|
||||
```diff
|
||||
-## HEAD
|
||||
+## 3.7.1 / 2018-01-25
|
||||
```
|
||||
|
||||
Adjust the version number and the date. The `## HEAD` heading will be regenerated next time a pull request is merged.
|
||||
|
||||
Once you've done this, update the website by running the following command:
|
||||
|
||||
```sh
|
||||
bundle exec rake site:generate
|
||||
```
|
||||
|
||||
This updates the website's changelog, and pushes the versions in various other places.
|
||||
|
||||
It's recommended that you go over the `History.markdown` file manually one more time, in case there are any spelling errors or such. Feel free to fix those manually, and after you're done generating the website changelog, commit your changes.
|
||||
|
||||
## Write a release post
|
||||
|
||||
In case this isn't done already, you can generate a new release post using the included `rake` command:
|
||||
|
||||
```sh
|
||||
bundle exec rake site:releases:new[3.8.0]
|
||||
```
|
||||
|
||||
where `3.8.0` should be replaced with the new version. Then, write the post. Be sure to thank all of the collaborators and maintainers who have contributed since the last release. You can generate a log of their names using the following command:
|
||||
|
||||
```sh
|
||||
git shortlog -sn master...v3.7.2
|
||||
```
|
||||
|
||||
where, again `v3.7.2` is the last release. Be sure to open a pull request for your release post.
|
||||
|
||||
### Push the version
|
||||
|
||||
Before you do this step, make sure the following things are done:
|
||||
|
||||
- You have permission to push a new gem version to RubyGems
|
||||
- You're logged into RubyGems on your command line
|
||||
- A release post has been prepared, and is ideally already live
|
||||
- All of the prior steps are done, committed, and pushed to `master`
|
||||
|
||||
Really the only thing left to do is to run this command:
|
||||
|
||||
```sh
|
||||
bundle exec rake release
|
||||
```
|
||||
|
||||
This will automatically build the new gem, make a release commit and tag and then push the new gem to RubyGems. Don't worry about creating a GitHub release, @jekyllbot should take care of that.
|
||||
|
||||
And then, you're done! :tada: Feel free to celebrate!
|
||||
|
||||
If you have access to the [@jekyllrb](https://twitter.com/jekyllrb) Twitter account, you should tweet the release post from there. If not, just ask another maintainer to do it or to give you access.
|
||||
|
||||
### Build the docs
|
||||
|
||||
We package our documentation as a :gem: Gem for offline use.
|
||||
|
||||
This is done with the
|
||||
[**jekyll-docs**](https://github.com/jekyll/jekyll-docs#building) repository,
|
||||
and more detailed instructions are provided there.
|
||||
|
||||
## For non-core gems
|
||||
|
||||
If you're not a maintainer for `jekyll/jekyll`, the procedure is much simpler in a lot of cases. Generally, the procedure still looks like this:
|
||||
|
||||
- Bump the gem version manually, usually in `lib/<plugin_name>/version.rb`
|
||||
- Adjust the history file
|
||||
- Run `bundle exec rake release` or `script/release`, depending on which of the two exists
|
||||
- Rejoice
|
||||
|
||||
Be sure to ask your project's maintainers if you're unsure!
|
||||
@@ -18,7 +18,3 @@ These labels are used to indicate that the Git state of a pull request must chan
|
||||
## `stale`
|
||||
|
||||
This label is automatically added and removed by @jekyllbot based on activity on an issue or pull request. The rules for this label are laid out in [Triaging an Issue: Staleness and automatic closure](../triaging-an-issue/#staleness-and-automatic-closure).
|
||||
|
||||
## `pinned`
|
||||
|
||||
This label is for @jekyllbot to ignore the age of the issue, which means that the `stale` label won't be automatically added, and the issue won't be closed after a while. This needs to be set manually, and should be set with care. (The `has-pull-request` label does the same thing, but shouldn't be used to _only_ keep an issue open)
|
||||
|
||||
@@ -51,4 +51,4 @@ Is what they wanted to get something we want to happen? Sometimes a bug report i
|
||||
|
||||
### Staleness and automatic closure
|
||||
|
||||
@jekyllbot will automatically mark issues as `stale` if no activity occurs for at least one month. @jekyllbot leaves a comment asking for information about reproducibility in current versions. If no one responds after another month, the issue is automatically closed. This behaviour can be suppressed by setting the [`pinned` label](../maintaining/special-labels.md/#pinned).
|
||||
@jekyllbot will automatically mark issues as `stale` if no activity occurs for at least one month. @jekyllbot leaves a comment asking for information about reproducibility in current versions. If no one responds after another month, the issue is automatically closed.
|
||||
|
||||
@@ -60,7 +60,7 @@ If you have a lot of pages, you can organize those pages into subfolders. The sa
|
||||
|
||||
If you have pages organized into subfolders in your source folder and want to flatten them in the root folder on build, you must add the [permalink]({% link _docs/permalinks.md %}) property directly in your page's front matter like this:
|
||||
|
||||
```yaml
|
||||
```
|
||||
---
|
||||
title: My page
|
||||
permalink: mypageurl.html
|
||||
|
||||
@@ -9,12 +9,12 @@ multiple pages. Jekyll offers a pagination plugin, so you can automatically
|
||||
generate the appropriate files and folders you need for paginated listings.
|
||||
|
||||
For Jekyll 3, include the `jekyll-paginate` plugin in your Gemfile and in
|
||||
your `_config.yml` under `plugins`. For Jekyll 2, this is standard.
|
||||
your `_config.yml` under `gems`. For Jekyll 2, this is standard.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Pagination only works within HTML files</h5>
|
||||
<p>
|
||||
Pagination does not work from within Markdown files from
|
||||
Pagination does not work from within Markdown or Textile files from
|
||||
your Jekyll site. Pagination works when called from within the HTML
|
||||
file, named <code>index.html</code>, which optionally may reside in and
|
||||
produce pagination from within a subdirectory, via the
|
||||
@@ -24,7 +24,7 @@ your `_config.yml` under `plugins`. For Jekyll 2, this is standard.
|
||||
|
||||
## Enable pagination
|
||||
|
||||
To enable pagination for posts on your blog, add a line to the `_config.yml` file that
|
||||
To enable pagination for your blog, add a line to the `_config.yml` file that
|
||||
specifies how many items should be displayed per page:
|
||||
|
||||
```yaml
|
||||
@@ -55,14 +55,6 @@ directory.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div class="note info">
|
||||
<h5>Pagination for categories, tags and collections</h5>
|
||||
<p>
|
||||
The more recent <a href="https://github.com/sverrirs/jekyll-paginate-v2">jekyll-paginate-v2</a> plugin supports more features. See the <a href="https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples">pagination examples</a> in the repository.
|
||||
<strong>This plugin is not supported by GitHub Pages</strong>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Liquid Attributes Available
|
||||
|
||||
The pagination plugin exposes the `paginator` liquid object with the following
|
||||
@@ -153,8 +145,8 @@ the `paginator` variable that will now be available to you. You’ll probably
|
||||
want to do this in one of the main pages of your site. Here’s one example of a
|
||||
simple way of rendering paginated Posts in a HTML file:
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
---
|
||||
layout: default
|
||||
title: My Blog
|
||||
@@ -185,8 +177,8 @@ title: My Blog
|
||||
<span class="next ">Next</span>
|
||||
{% endif %}
|
||||
</div>
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
<div class="note warning">
|
||||
<h5>Beware the page one edge-case</h5>
|
||||
@@ -200,8 +192,8 @@ title: My Blog
|
||||
The following HTML snippet should handle page one, and render a list of each
|
||||
page with links to all but the current page.
|
||||
|
||||
```html
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% if paginator.total_pages > 1 %}
|
||||
<div class="pagination">
|
||||
{% if paginator.previous_page %}
|
||||
@@ -227,5 +219,5 @@ page with links to all but the current page.
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
@@ -6,7 +6,7 @@ permalink: /docs/permalinks/
|
||||
Permalinks refer to the URLs (excluding the domain name or directory folder) for your pages, posts, or collections.
|
||||
Jekyll supports a flexible way to build permalinks, allowing you to leverage various template variables or choose built-in permalink styles (such as `date`) that automatically use a template-variable pattern.
|
||||
|
||||
You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is `/:categories/:year/:month/:day/:title:output_ext`. Each of the colon-prefixed keywords is a template variable.
|
||||
You construct permalinks by creating a template URL where dynamic elements are represented by colon-prefixed keywords. The default template permalink is `/:categories/:year/:month/:day/:title.html`. Each of the colon-prefixed keywords is a template variable.
|
||||
|
||||
## Where to configure permalinks
|
||||
|
||||
@@ -15,7 +15,7 @@ You can configure your site's permalinks through the [Configuration]({% link _do
|
||||
Setting permalink styles in your configuration file applies the setting globally in your project. You configure permalinks in your `_config.yml` file like this:
|
||||
|
||||
```yaml
|
||||
permalink: /:categories/:year/:month/:day/:title:output_ext
|
||||
permalink: /:categories/:year/:month/:day/:title.html
|
||||
```
|
||||
|
||||
If you don't specify any permalink setting, Jekyll uses the above pattern as the default.
|
||||
@@ -26,7 +26,7 @@ The permalink can also be set using a built-in permalink style:
|
||||
permalink: date
|
||||
```
|
||||
|
||||
`date` is the same as `:categories/:year/:month/:day/:title:output_ext`, the default. See [Built-in Permalink Styles](#builtinpermalinkstyles) below for more options.
|
||||
`date` is the same as `:categories/:year/:month/:day/:title.html`, the default. See [Built-in Permalink Styles](#builtinpermalinkstyles) below for more options.
|
||||
|
||||
Setting the permalink in your post, page, or collection's front matter overrides any global settings. Here's an example:
|
||||
|
||||
@@ -66,10 +66,7 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>year</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Year from the post's filename. May be overridden via the document’s
|
||||
<code>date</code> YAML front matter
|
||||
</p>
|
||||
<p>Year from the post's filename</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -77,10 +74,7 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>month</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Month from the post's filename. May be overridden via the document’s
|
||||
<code>date</code> YAML front matter
|
||||
</p>
|
||||
<p>Month from the post's filename</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -88,10 +82,7 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>i_month</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Month without leading zeros from the post's filename. May be
|
||||
overridden via the document’s <code>date</code> YAML front matter
|
||||
</p>
|
||||
<p>Month from the post's filename without leading zeros.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -99,10 +90,7 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>day</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Day from the post's filename. May be overridden via the document’s
|
||||
<code>date</code> YAML front matter
|
||||
</p>
|
||||
<p>Day from the post's filename</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -110,18 +98,7 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>i_day</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Day without leading zeros from the post's filename. May be overridden
|
||||
via the document’s <code>date</code> YAML front matter
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>y_day</code></p>
|
||||
</td>_
|
||||
<td>
|
||||
<p>Day of the year from the post's filename, with leading zeros.</p>
|
||||
<p>Day from the post's filename without leading zeros.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -129,10 +106,7 @@ The following table lists the template variables available for permalinks. You c
|
||||
<p><code>short_year</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Year without the century from the post's filename. May be overridden
|
||||
via the document’s <code>date</code> YAML front matter
|
||||
</p>
|
||||
<p>Year from the post's filename without the century.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -141,8 +115,7 @@ The following table lists the template variables available for permalinks. You c
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Hour of the day, 24-hour clock, zero-padded from the post's
|
||||
<code>date</code> front matter. (00..23)
|
||||
Hour of the day, 24-hour clock, zero-padded from the post's <code>date</code> front matter. (00..23)
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -226,7 +199,7 @@ Although you can specify a custom permalink pattern using [template variables](#
|
||||
<p><code>date</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:year/:month/:day/:title:output_ext</code></p>
|
||||
<p><code>/:categories/:year/:month/:day/:title.html</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -242,7 +215,7 @@ Although you can specify a custom permalink pattern using [template variables](#
|
||||
<p><code>ordinal</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:year/:y_day/:title:output_ext</code></p>
|
||||
<p><code>/:categories/:year/:y_day/:title.html</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -250,7 +223,7 @@ Although you can specify a custom permalink pattern using [template variables](#
|
||||
<p><code>none</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:title:output_ext</code></p>
|
||||
<p><code>/:categories/:title.html</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -297,7 +270,7 @@ Given a post named: `/2009-04-29-slap-chop.md`
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>/:month-:day-:year/:title:output_ext</code></p>
|
||||
<p><code>/:month-:day-:year/:title.html</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/04-29-2009/slap-chop.html</code></p>
|
||||
@@ -330,7 +303,7 @@ The permalink setting in your configuration file specifies the permalink style u
|
||||
|
||||
For example:
|
||||
|
||||
* A permalink style of `/:categories/:year/:month/:day/:title:output_ext` for posts becomes `/:title.html` for pages and collections.
|
||||
* A permalink style of `/:categories/:year/:month/:day/:title.html` for posts becomes `/:title.html` for pages and collections.
|
||||
* A permalink style of `pretty` (or `/:categories/:year/:month/:day/:title/`), which omits the file extension and contains a trailing slash, will update page and collection permalinks to also omit the file extension and contain a trailing slash: `/:title/`.
|
||||
* A permalink style of `date`, which contains a trailing file extension, will update page permalinks to also contain a trailing file extension: `/:title.html`. But no time or category information will be included.
|
||||
|
||||
@@ -354,13 +327,13 @@ As with posts, if you use a permalink style that omits the `.html` file extensio
|
||||
|
||||
By default, collections follow a similar structure in the `_site` folder as pages, except that the path is prefaced by the collection name. For example: `collectionname/mypage.html`. For permalink settings that omit the file extension, the path would be `collection_name/mypage/index.html`.
|
||||
|
||||
Collections have their own way of setting permalinks. Additionally, collections have unique template variables available (such as `path` and `output_ext`). See the [Configuring permalinks for collections](../collections/#permalinks) in Collections for more information.
|
||||
Collections have their own way of setting permalinks. Additionally, collections have unique template variables available available (such as `path` and `output_ext`). See the [Configuring permalinks for collections](../collections/#permalinks) in Collections for more information.
|
||||
|
||||
## Flattening pages in \_site on build
|
||||
|
||||
If you want to flatten your pages (pull them out of subfolders) in the `_site` directory when your site builds (similar to posts), add the `permalink` property to the front matter of each page, with no path specified:
|
||||
|
||||
```yaml
|
||||
```
|
||||
---
|
||||
title: My page
|
||||
permalink: mypageurl.html
|
||||
|
||||
@@ -25,36 +25,27 @@ having to modify the Jekyll source itself.
|
||||
You have 3 options for installing plugins:
|
||||
|
||||
1. In your site source root, make a `_plugins` directory. Place your plugins
|
||||
here. Any file ending in `*.rb` inside this directory will be loaded before
|
||||
Jekyll generates your site.
|
||||
here. Any file ending in `*.rb` inside this directory will be loaded before
|
||||
Jekyll generates your site.
|
||||
2. In your `_config.yml` file, add a new array with the key `gems` and the
|
||||
values of the gem names of the plugins you'd like to use. An example:
|
||||
|
||||
2. In your `_config.yml` file, add a new array with the key `plugins` (or `gems` for Jekyll < `3.5.0`) and the
|
||||
values of the gem names of the plugins you'd like to use. An example:
|
||||
|
||||
```yaml
|
||||
# This will require each of these plugins automatically.
|
||||
plugins:
|
||||
- jekyll-gist
|
||||
- jekyll-coffeescript
|
||||
- jekyll-assets
|
||||
- another-jekyll-plugin
|
||||
```
|
||||
gems: [jekyll-coffeescript, jekyll-watch, jekyll-assets]
|
||||
# This will require each of these gems automatically.
|
||||
|
||||
Then install your plugins using `gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin`
|
||||
Then install your plugins using `gem install jekyll-coffeescript jekyll-watch jekyll-assets`
|
||||
|
||||
3. Add the relevant plugins to a Bundler group in your `Gemfile`. An
|
||||
example:
|
||||
example:
|
||||
|
||||
```ruby
|
||||
group :jekyll_plugins do
|
||||
gem "jekyll-gist"
|
||||
gem "jekyll-coffeescript"
|
||||
gem "jekyll-assets"
|
||||
gem "another-jekyll-plugin"
|
||||
end
|
||||
```
|
||||
group :jekyll_plugins do
|
||||
gem "my-jekyll-plugin"
|
||||
gem "another-jekyll-plugin"
|
||||
end
|
||||
|
||||
Now you need to install all plugins from your Bundler group by running single command `bundle install`
|
||||
|
||||
Now you need to install all plugins from your Bundler group by running single command `bundle install`.
|
||||
|
||||
<div class="note info">
|
||||
<h5>
|
||||
@@ -68,25 +59,7 @@ You have 3 options for installing plugins:
|
||||
</p>
|
||||
</div>
|
||||
|
||||
### The jekyll_plugins group
|
||||
|
||||
Jekyll gives this particular group of gems in your `Gemfile` a different
|
||||
treatment. Any gem included in this group is loaded before Jekyll starts
|
||||
processing the rest of your source directory.
|
||||
|
||||
A gem included here will be activated even if its not explicitly listed under
|
||||
the `plugins:` key in your site's config file.
|
||||
|
||||
<div class="note warning">
|
||||
<p>
|
||||
Gems included in the <code>:jekyll-plugins</code> group are activated
|
||||
regardless of the <code>--safe</code> mode setting. Be aware of what
|
||||
gems are included under this group!
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
In general, plugins you make will fall broadly into one of five categories:
|
||||
In general, plugins you make will fall into one of five categories:
|
||||
|
||||
1. [Generators](#generators)
|
||||
2. [Converters](#converters)
|
||||
@@ -94,12 +67,6 @@ In general, plugins you make will fall broadly into one of five categories:
|
||||
4. [Tags](#tags)
|
||||
5. [Hooks](#hooks)
|
||||
|
||||
See the bottom of the page for a [list of available plugins](#available-plugins).
|
||||
|
||||
For further information on how to develop your own plugins, check out the [Liquid documentation](https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers) as well.
|
||||
|
||||
If you never developed a Jekyll plugin [check this useful wrap-up](https://ayastreb.me/writing-a-jekyll-plugin/) by @ayastreb to get started.
|
||||
|
||||
## Generators
|
||||
|
||||
You can create a generator when you need Jekyll to create additional content
|
||||
@@ -143,6 +110,7 @@ This is a more complex generator that generates new pages:
|
||||
|
||||
```ruby
|
||||
module Jekyll
|
||||
|
||||
class CategoryPage < Page
|
||||
def initialize(site, base, dir, category)
|
||||
@site = site
|
||||
@@ -171,6 +139,7 @@ module Jekyll
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
```
|
||||
|
||||
@@ -409,11 +378,11 @@ Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
|
||||
In the example above, we can place the following tag anywhere in one of our
|
||||
pages:
|
||||
|
||||
{% raw %}
|
||||
```ruby
|
||||
{% raw %}
|
||||
<p>{% render_time page rendered at: %}</p>
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
And we would get something like this on the page:
|
||||
|
||||
@@ -757,6 +726,10 @@ You can find a few useful plugins at the following locations:
|
||||
|
||||
#### Generators
|
||||
|
||||
- [ArchiveGenerator by Ilkka Laukkanen](https://gist.github.com/707909): Uses [this archive page](https://gist.github.com/707020) to generate archives.
|
||||
- [LESS.js Generator by Andy Fowler](https://gist.github.com/642739): Renders
|
||||
LESS.js files during generation.
|
||||
- [Version Reporter by Blake Smith](https://gist.github.com/449491): Creates a version.html file containing the Jekyll version.
|
||||
- [Sitemap.xml Generator by Michael Levin](https://github.com/kinnetica/jekyll-plugins): Generates a sitemap.xml file by traversing all of the available posts and pages.
|
||||
- [Full-text search by Pascal Widdershoven](https://github.com/PascalW/jekyll_indextank): Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.
|
||||
- [AliasGenerator by Thomas Mango](https://github.com/tsmango/jekyll_alias_generator): Generates redirect pages for posts when an alias is specified in the YAML Front Matter.
|
||||
@@ -772,6 +745,7 @@ You can find a few useful plugins at the following locations:
|
||||
- [Typescript Generator by Matt Sheehan](https://github.com/sheehamj13/jekyll_ts): Generate Javascript on build from your Typescript.
|
||||
- [Jekyll::AutolinkEmail by Ivan Tse](https://github.com/ivantsepp/jekyll-autolink_email): Autolink your emails.
|
||||
- [Jekyll::GitMetadata by Ivan Tse](https://github.com/ivantsepp/jekyll-git_metadata): Expose Git metadata for your templates.
|
||||
- [Jekyll Http Basic Auth Plugin](https://gist.github.com/snrbrnjna/422a4b7e017192c284b3): Plugin to manage http basic auth for jekyll generated pages and directories.
|
||||
- [Jekyll Auto Image by Merlos](https://github.com/merlos/jekyll-auto-image): Gets the first image of a post. Useful to list your posts with images or to add [twitter cards](https://dev.twitter.com/cards/overview) to your site.
|
||||
- [Jekyll Portfolio Generator by Shannon Babincsak](https://github.com/codeinpink/jekyll-portfolio-generator): Generates project pages and computes related projects out of project data files.
|
||||
- [Jekyll-Umlauts by Arne Gockeln](https://github.com/webchef/jekyll-umlauts): This generator replaces all german umlauts (äöüß) case sensitive with html.
|
||||
@@ -780,24 +754,26 @@ You can find a few useful plugins at the following locations:
|
||||
- [AMP-Jekyll by Juuso Mikkonen](https://github.com/juusaw/amp-jekyll): Generate [Accelerated Mobile Pages](https://www.ampproject.org) of Jekyll posts.
|
||||
- [Jekyll Art Gallery plugin](https://github.com/alexivkin/Jekyll-Art-Gallery-Plugin): An advanced art/photo gallery generation plugin for creating galleries from a set of image folders. Supports image tagging, thumbnails, sorting, image rotation, post-processing (remove EXIF, add watermark), multiple collections and much more.
|
||||
- [jekyll-ga](https://github.com/developmentseed/jekyll-ga): A Jekyll plugin that downloads Google Analytics data and adds it to posts. Useful for making a site that lists "most popular" content. [Read the introduction](https://developmentseed.org/blog/google-analytics-jekyll-plugin/) post on the developmentSEED blog.
|
||||
- [jekyll-multi-paginate](https://github.com/fadhilnapis/jekyll-multi-paginate): Simple Jekyll paginator for multiple page. Ease you to make pagination on multiple page especially like multiple language.
|
||||
- [jekyll-category-pages](https://github.com/field-theory/jekyll-category-pages): Easy-to-use category index pages with and without pagination. Supports non-URL-safe category keywords and has extensive documentation and test coverage.
|
||||
- [Tweetsert](https://github.com/ibrado/jekyll-tweetsert): Imports tweets (Twitter statuses) as new posts. Features multiple timeline support, hashtag import, filtering, automatic category and/or tags, optional retweets and replies.
|
||||
- [Stickyposts](https://github.com/ibrado/jekyll-stickyposts): Moves or copies (pins) posts marked `sticky: true` to the top of the list. Perfect for keeping important announcements on the home page, or giving collections a descriptive entry. Paginator friendly.
|
||||
- [Jekyll::Paginate::Content](https://github.com/ibrado/jekyll-paginate-content): Content paginator in the style of jekyll-paginator-v2 that splits pages, posts, and collection entries into several pages. Specify a separator or use HTML <h1> etc. headers. Automatic splitting, single-page view, pager/trail, self-adjusting links, multipage TOC, SEO support.
|
||||
- [Premonition](https://github.com/amedia/premonition): Adds block-styled side content to your page. For example summary, notes, hints or warning boxes.
|
||||
- [jekyll-fontello](https://github.com/ericcornelissen/jekyll-fontello): A Jekyll plugin that automatically downloads your webfont from Fontello.
|
||||
- [Target Blank](https://github.com/keithmifsud/jekyll-target-blank): A Jekyll plugin to automatically open external links in a new browser tab or window.
|
||||
- [jekyll-info](https://github.com/swestmoreland/jekyll-info): A plugin to provide information about your Jekyll site’s configuration.
|
||||
|
||||
#### Converters
|
||||
|
||||
- [Pug plugin by Doug Beney](http://jekyll-pug.dougie.io): Use the popular Pug (previously Jade) templating language in Jekyll. Complete with caching, includes support, and much more.
|
||||
- [Textile converter](https://github.com/jekyll/jekyll-textile-converter): Convert `.textile` files into HTML. Also includes the `textilize` Liquid filter.
|
||||
- [Slim plugin](https://github.com/slim-template/jekyll-slim): Slim converter and includes for Jekyll with support for Liquid tags.
|
||||
- [Jade plugin by John Papandriopoulos](https://github.com/snappylabs/jade-jekyll-plugin): Jade converter for Jekyll.
|
||||
- [Pug plugin by Josh Waller](https://github.com/mdxprograms/pug-jekyll-plugin): Pug (previously Jade) converter for Jekyll.
|
||||
- [HAML plugin by Sam Z](https://gist.github.com/517556): HAML converter for Jekyll.
|
||||
- [HAML-Sass Converter by Adam Pearson](https://gist.github.com/481456): Simple HAML-Sass converter for Jekyll. [Fork](https://gist.github.com/528642) by Sam X.
|
||||
- [Sass SCSS Converter by Mark Wolfe](https://gist.github.com/960150): Sass converter which uses the new CSS compatible syntax, based Sam X’s fork above.
|
||||
- [LESS Converter by Jason Graham](https://gist.github.com/639920): Convert LESS files to CSS.
|
||||
- [LESS Converter by Josh Brown](https://gist.github.com/760265): Simple LESS converter.
|
||||
- [Upcase Converter by Blake Smith](https://gist.github.com/449463): An example Jekyll converter.
|
||||
- [CoffeeScript Converter by phaer](https://gist.github.com/959938): A [CoffeeScript](http://coffeescript.org) to Javascript converter.
|
||||
- [Markdown References by Olov Lassus](https://github.com/olov/jekyll-references): Keep all your markdown reference-style link definitions in one \_references.md file.
|
||||
- [Stylus Converter](https://gist.github.com/988201): Convert .styl to .css.
|
||||
- [ReStructuredText Converter](https://github.com/xdissent/jekyll-rst): Converts ReST documents to HTML with Pygments syntax highlighting.
|
||||
- [Jekyll-pandoc-multiple-formats](https://github.com/fauno/jekyll-pandoc-multiple-formats) by [edsl](https://github.com/edsl): Use pandoc to generate your site in multiple formats. Supports pandoc’s markdown extensions.
|
||||
- [Transform Layouts](https://gist.github.com/1472645): Allows HAML layouts (you need a HAML Converter plugin for this to work).
|
||||
- [Org-mode Converter](https://gist.github.com/abhiyerra/7377603): Org-mode converter for Jekyll.
|
||||
- [Customized Kramdown Converter](https://github.com/mvdbos/kramdown-with-pygments): Enable Pygments syntax highlighting for Kramdown-parsed fenced code blocks.
|
||||
- [Bigfootnotes Plugin](https://github.com/TheFox/jekyll-bigfootnotes): Enables big footnotes for Kramdown.
|
||||
- [AsciiDoc Plugin](https://github.com/asciidoctor/jekyll-asciidoc): AsciiDoc convertor for Jekyll using [Asciidoctor](http://asciidoctor.org/).
|
||||
@@ -808,7 +784,10 @@ You can find a few useful plugins at the following locations:
|
||||
|
||||
- [Truncate HTML](https://github.com/MattHall/truncatehtml) by [Matt Hall](https://codebeef.com/): A Jekyll filter that truncates HTML while preserving markup structure.
|
||||
- [Domain Name Filter by Lawrence Woodman](https://github.com/LawrenceWoodman/domain_name-liquid_filter): Filters the input text so that just the domain name is left.
|
||||
- [Summarize Filter by Mathieu Arnold](https://gist.github.com/731597): Remove markup after a `<div id="extended">` tag.
|
||||
- [i18n_filter](https://github.com/gacha/gacha.id.lv/blob/master/_plugins/i18n_filter.rb): Liquid filter to use I18n localization.
|
||||
- [Smilify](https://github.com/SaswatPadhi/jekyll_smilify) by [SaswatPadhi](https://github.com/SaswatPadhi): Convert text emoticons in your content to themeable smiley pics.
|
||||
- [Read in X Minutes](https://gist.github.com/zachleat/5792681) by [zachleat](https://github.com/zachleat): Estimates the reading time of a string (for blog post content).
|
||||
- [Jekyll-timeago](https://github.com/markets/jekyll-timeago): Converts a time value to the time ago in words.
|
||||
- [pluralize](https://github.com/bdesham/pluralize): Easily combine a number and a word into a grammatically-correct amount like “1 minute” or “2 minute**s**”.
|
||||
- [reading_time](https://github.com/bdesham/reading_time): Count words and estimate reading time for a piece of text, ignoring HTML elements that are unlikely to contain running text.
|
||||
@@ -819,6 +798,7 @@ You can find a few useful plugins at the following locations:
|
||||
- [Deprecated articles keeper](https://github.com/kzykbys/JekyllPlugins) by [Kazuya Kobayashi](http://blog.kazuya.co/): A simple Jekyll filter which monitor how old an article is.
|
||||
- [Jekyll-jalali](https://github.com/mehdisadeghi/jekyll-jalali) by [Mehdi Sadeghi](http://mehdix.ir): A simple Gregorian to Jalali date converter filter.
|
||||
- [Jekyll Thumbnail Filter](https://github.com/matallo/jekyll-thumbnail-filter): Related posts thumbnail filter.
|
||||
- [Jekyll-Smartify](https://github.com/pathawks/jekyll-smartify): SmartyPants filter. Make "quotes" “curly”
|
||||
- [liquid-md5](https://github.com/pathawks/liquid-md5): Returns an MD5 hash. Helpful for generating Gravatars in templates.
|
||||
- [jekyll-roman](https://github.com/paulrobertlloyd/jekyll-roman): A liquid filter for Jekyll that converts numbers into Roman numerals.
|
||||
- [jekyll-typogrify](https://github.com/myles/jekyll-typogrify): A Jekyll plugin that brings the functions of [typogruby](http://avdgaag.github.io/typogruby/).
|
||||
@@ -827,26 +807,35 @@ You can find a few useful plugins at the following locations:
|
||||
- [match_regex](https://github.com/sparanoid/match_regex): A Liquid filter to perform regex match.
|
||||
- [replace_regex](https://github.com/sparanoid/replace_regex): A Liquid filter to perform regex replace.
|
||||
- [Jekyll Money](https://rubygems.org/gems/jekyll-money): A Jekyll plugin for dealing with money. Because we all have to at some point.
|
||||
- [jekyll-random](https://github.com/codecalm/jekyll-random) by [codecalm](https://nodecalm.net): A Jekyll plugin that generates pseudo-random data. Very useful when you want to generate a large amount of random data.
|
||||
- [jekyll-firstimage](https://github.com/nhoizey/jekyll-firstimage) adds a Liquid filter finding the first image in a HTML content string, including responsive images srcset.
|
||||
|
||||
#### Tags
|
||||
|
||||
You can find a few useful plugins at the following locations:
|
||||
|
||||
- [Jekyll-gist](https://github.com/jekyll/jekyll-gist): Use the `gist` tag to easily embed a GitHub Gist onto your site. This works with public or secret gists.
|
||||
- [Asset Path Tag](https://github.com/samrayner/jekyll-asset-path-plugin) by [Sam Rayner](http://www.samrayner.com/): Allows organisation of assets into subdirectories by outputting a path for a given file relative to the current post or page.
|
||||
- [Delicious Plugin by Christian Hellsten](https://github.com/christianhellsten/jekyll-plugins): Fetches and renders bookmarks from delicious.com.
|
||||
- [Ultraviolet Plugin by Steve Alex](https://gist.github.com/480380): Jekyll tag for the [Ultraviolet](https://github.com/grosser/ultraviolet) code highligher.
|
||||
- [Tag Cloud Plugin by Ilkka Laukkanen](https://gist.github.com/710577): Generate a tag cloud that links to tag pages.
|
||||
- [GIT Tag by Alexandre Girard](https://gist.github.com/730347): Add Git activity inside a list.
|
||||
- [MathJax Liquid Tags by Jessy Cowan-Sharp](https://gist.github.com/834610): Simple liquid tags for Jekyll that convert inline math and block equations to the appropriate MathJax script tags.
|
||||
- [Non-JS Gist Tag by Brandon Tilley](https://gist.github.com/1027674) A Liquid tag that embeds Gists and shows code for non-JavaScript enabled browsers and readers.
|
||||
- [Render Time Tag by Blake Smith](https://gist.github.com/449509): Displays the time a Jekyll page was generated.
|
||||
- [Status.net/OStatus Tag by phaer](https://gist.github.com/912466): Displays the notices in a given status.net/ostatus feed.
|
||||
- [Embed.ly client by Robert Böhnke](https://github.com/robb/jekyll-embedly-client): Autogenerate embeds from URLs using oEmbed.
|
||||
- [Logarithmic Tag Cloud](https://gist.github.com/2290195): Flexible. Logarithmic distribution. Documentation inline.
|
||||
- [oEmbed Tag by Tammo van Lessen](https://gist.github.com/1455726): Enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.
|
||||
- [FlickrSetTag by Thomas Mango](https://github.com/tsmango/jekyll_flickr_set_tag): Generates image galleries from Flickr sets.
|
||||
- [Tweet Tag by Scott W. Bradley](https://github.com/scottwb/jekyll-tweet-tag): Liquid tag for [Embedded Tweets](https://dev.twitter.com/docs/embedded-tweets) using Twitter’s shortcodes.
|
||||
- [Jekyll Twitter Plugin](https://github.com/rob-murray/jekyll-twitter-plugin): A Liquid tag plugin that renders Tweets from Twitter API. Currently supports the [oEmbed](https://dev.twitter.com/rest/reference/get/statuses/oembed) API.
|
||||
- [Jekyll-contentblocks](https://github.com/rustygeldmacher/jekyll-contentblocks): Lets you use Rails-like content_for tags in your templates, for passing content from your posts up to your layouts.
|
||||
- [Generate YouTube Embed](https://gist.github.com/1805814) by [joelverhagen](https://github.com/joelverhagen): Jekyll plugin which allows you to embed a YouTube video in your page with the YouTube ID. Optionally specify width and height dimensions. Like “oEmbed Tag” but just for YouTube.
|
||||
- [Jekyll-beastiepress](https://github.com/okeeblow/jekyll-beastiepress): FreeBSD utility tags for Jekyll sites.
|
||||
- [Jsonball](https://gist.github.com/1895282): Reads json files and produces maps for use in Jekyll files.
|
||||
- [Bibjekyll](https://github.com/pablooliveira/bibjekyll): Render BibTeX-formatted bibliographies/citations included in posts and pages using bibtex2html.
|
||||
- [Jekyll-citation](https://github.com/archome/jekyll-citation): Render BibTeX-formatted bibliographies/citations included in posts and pages (pure Ruby).
|
||||
- [Jekyll Dribbble Set Tag](https://github.com/ericdfields/Jekyll-Dribbble-Set-Tag): Builds Dribbble image galleries from any user.
|
||||
- [Debbugs](https://gist.github.com/2218470): Allows posting links to Debian BTS easily.
|
||||
- [Jekyll-devonly_tag](https://gist.github.com/2403522): A block tag for including markup only during development.
|
||||
- [JekyllGalleryTag](https://github.com/redwallhp/JekyllGalleryTag) by [redwallhp](https://github.com/redwallhp): Generates thumbnails from a directory of images and displays them in a grid.
|
||||
- [Youku and Tudou Embed](https://gist.github.com/Yexiaoxing/5891929): Liquid plugin for embedding Youku and Tudou videos.
|
||||
- [Jekyll-swfobject](https://github.com/sectore/jekyll-swfobject): Liquid plugin for embedding Adobe Flash files (.swf) using [SWFObject](https://github.com/swfobject/swfobject).
|
||||
- [Jekyll Picture Tag](https://github.com/robwierzbowski/jekyll-picture-tag): Easy responsive images for Jekyll. Based on the proposed [`<picture>`](https://html.spec.whatwg.org/multipage/embedded-content.html#the-picture-element) element, polyfilled with Scott Jehl’s [Picturefill](https://github.com/scottjehl/picturefill).
|
||||
- [Jekyll Image Tag](https://github.com/robwierzbowski/jekyll-image-tag): Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.
|
||||
@@ -856,6 +845,8 @@ You can find a few useful plugins at the following locations:
|
||||
- [Jekyll Date Chart](https://github.com/GSI/jekyll_date_chart) by [GSI](https://github.com/GSI): Block that renders date line charts based on textile-formatted tables.
|
||||
- [Jekyll Image Encode](https://github.com/GSI/jekyll_image_encode) by [GSI](https://github.com/GSI): Tag that renders base64 codes of images fetched from the web.
|
||||
- [Jekyll Quick Man](https://github.com/GSI/jekyll_quick_man) by [GSI](https://github.com/GSI): Tag that renders pretty links to man page sources on the internet.
|
||||
- [jekyll-font-awesome](https://gist.github.com/23maverick23/8532525): Quickly and easily add Font Awesome icons to your posts.
|
||||
- [Lychee Gallery Tag](https://gist.github.com/tobru/9171700) by [tobru](https://github.com/tobru): Include [Lychee](https://lychee.electerious.com/) albums into a post. For an introduction, see [Jekyll meets Lychee - A Liquid Tag plugin](https://tobrunet.ch/articles/jekyll-meets-lychee-a-liquid-tag-plugin/)
|
||||
- [Image Set/Gallery Tag](https://github.com/callmeed/jekyll-image-set) by [callmeed](https://github.com/callmeed): Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.
|
||||
- [jekyll_figure](https://github.com/lmullen/jekyll_figure): Generate figures and captions with links to the figure in a variety of formats
|
||||
- [Jekyll GitHub Sample Tag](https://github.com/bwillis/jekyll-github-sample): A liquid tag to include a sample of a github repo file in your Jekyll site.
|
||||
@@ -874,23 +865,12 @@ You can find a few useful plugins at the following locations:
|
||||
- [jekyll-figure](https://github.com/paulrobertlloyd/jekyll-figure): A liquid tag for Jekyll that generates `<figure>` elements.
|
||||
- [Jekyll Video Embed](https://github.com/eug/jekyll-video-embed): It provides several tags to easily embed videos (e.g. Youtube, Vimeo, UStream and Ted Talks)
|
||||
- [jekyll-i18n_tags](https://github.com/KrzysiekJ/jekyll-i18n_tags): Translate your templates.
|
||||
- [Jekyll Ideal Image Slider](https://github.com/jekylltools/jekyll-ideal-image-slider): Liquid tag plugin to create image sliders using [Ideal Image Slider](https://github.com/gilbitron/Ideal-Image-Slider).
|
||||
- [Jekyll Ideal Image Slider](https://github.com/xHN35RQ/jekyll-ideal-image-slider): Liquid tag plugin to create image sliders using [Ideal Image Slider](https://github.com/gilbitron/Ideal-Image-Slider).
|
||||
- [Jekyll Tags List Plugin](https://github.com/crispgm/jekyll-tags-list-plugin): A Liquid tag plugin that creates tags list in specific order.
|
||||
- [Jekyll Maps](https://github.com/ayastreb/jekyll-maps) by [Anatoliy Yastreb](https://github.com/ayastreb): A Jekyll plugin to easily embed maps with filterable locations.
|
||||
- [Jekyll Cloudinary](https://nhoizey.github.io/jekyll-cloudinary/) by [Nicolas Hoizey](https://nicolas-hoizey.com/): a Jekyll plugin adding a Liquid tag to ease the use of Cloudinary for responsive images in your Markdown/Kramdown posts.
|
||||
- [jekyll-include-absolute-plugin](https://github.com/tnhu/jekyll-include-absolute-plugin) by [Tan Nhu](https://github.com/tnhu): A Jekyll plugin to include a file from its path relative to Jekyll's source folder.
|
||||
- [Jekyll Download Tag](https://github.com/mattg/jekyll-download-tag): A Liquid tag that acts like `include`, but for external resources.
|
||||
- [Jekyll Brand Social Wall](https://github.com/MediaComem/jekyll-brand-social-wall): A jekyll plugin to generate a social wall with your favorite social networks
|
||||
- [Jekyll If File Exists](https://github.com/k-funk/jekyll-if-file-exists): A Jekyll Plugin that checks if a file exists with an if/else block.
|
||||
- [BibSonomy](https://github.com/rjoberon/bibsonomy-jekyll): Jekyll
|
||||
plugin to generate publication lists from [BibSonomy](https://www.bibsonomy.org/).
|
||||
- [github-cards](https://github.com/edward-shen/github-cards): Creates styleable Github cards for your Github projects.
|
||||
- [disqus-for-jekyll](https://github.com/kacperduras/disqus-for-jekyll): A Jekyll plugin to view the comments powered by Disqus.
|
||||
- [jekyll-html](https://github.com/kacperduras/jekyll-html): A Jekyll plugin to use HTML tags in Jekyll pages, posts and collections.
|
||||
- [jekyll-onebox](https://github.com/rriemann/jekyll-onebox): Liquid tag for displaying HTML previews (embeds) for links to popular domains. Plugin is based on [Onebox](https://github.com/discourse/onebox) that powers link previews in [Discourse](http://github.com/discourse/discourse) forums.
|
||||
- [jekyll-w2m](https://github.com/kacperduras/jekyll-w2m): A Jekyll plugin to liberate content from Microsoft Word documents (powered by [word-to-markdown](https://github.com/benbalter/word-to-markdown)).
|
||||
- [jekyll-flickr](https://github.com/rriemann/jekyll-flickr): Liquid tag for responsive Flickr images using HTML5 srcset. Subtitles and automatic license notices are supported.
|
||||
- [CAT](https://github.com/binfalse/jekyll-cat): Include the contents of any file (like the `include` command, but also for files outside of `_include`). Similar to Unix' `cat` tool; useful for including source code etc. in posts and pages.
|
||||
|
||||
#### Collections
|
||||
|
||||
@@ -900,18 +880,23 @@ You can find a few useful plugins at the following locations:
|
||||
|
||||
#### Other
|
||||
|
||||
- [Analytics for Jekyll](https://github.com/hendrikschneider/jekyll-analytics) by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Matomo (formerly Piwik), mPulse, etc. to your site.
|
||||
- [ditaa-ditaa](https://github.com/tmthrgd/ditaa-ditaa) by Tom Thorogood: a drastic revision of jekyll-ditaa that renders diagrams drawn using ASCII art into PNG images.
|
||||
- [Pygments Cache Path by Raimonds Simanovskis](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb): Plugin to cache syntax-highlighted code from Pygments.
|
||||
- [Draft/Publish Plugin by Michael Ivey](https://gist.github.com/49630): Save posts as drafts.
|
||||
- [Growl Notification Generator by Tate Johnson](https://gist.github.com/490101): Send Jekyll notifications to Growl.
|
||||
- [Growl Notification Hook by Tate Johnson](https://gist.github.com/525267): Better alternative to the above, but requires his “hook” fork.
|
||||
- [Related Posts by Lawrence Woodman](https://github.com/LawrenceWoodman/related_posts-jekyll_plugin): Overrides `site.related_posts` to use categories to assess relationship.
|
||||
- [jekyll-tagging-related_posts](https://github.com/toshimaru/jekyll-tagging-related_posts): Jekyll related_posts function based on tags (works on Jekyll3).
|
||||
- [Tiered Archives by Eli Naeher](https://gist.github.com/88cda643aa7e3b0ca1e5): Create tiered template variable that allows you to group archives by year and month.
|
||||
- [Jekyll-localization](https://github.com/blackwinter/jekyll-localization): Jekyll plugin that adds localization features to the rendering engine.
|
||||
- [Jekyll-rendering](https://github.com/blackwinter/jekyll-rendering): Jekyll plugin to provide alternative rendering engines.
|
||||
- [Jekyll-pagination](https://github.com/blackwinter/jekyll-pagination): Jekyll plugin to extend the pagination generator.
|
||||
- [Jekyll-tagging](https://github.com/pattex/jekyll-tagging): Jekyll plugin to automatically generate a tag cloud and tag pages.
|
||||
- [Jekyll-scholar](https://github.com/inukshuk/jekyll-scholar): Jekyll extensions for the blogging scholar.
|
||||
- [Jekyll-asset_bundler](https://github.com/moshen/jekyll-asset_bundler): Bundles and minifies JavaScript and CSS.
|
||||
- [Jekyll-assets](http://jekyll.github.io/jekyll-assets/) by [ixti](https://github.com/ixti): Rails-alike assets pipeline (write assets in CoffeeScript, Sass, LESS etc; specify dependencies for automatic bundling using simple declarative comments in assets; minify and compress; use JST templates; cache bust; and many-many more).
|
||||
- [JAPR](https://github.com/kitsched/japr): Jekyll Asset Pipeline Reborn - Powerful asset pipeline for Jekyll that collects, converts and compresses JavaScript and CSS assets.
|
||||
- [File compressor](https://gist.github.com/2758691) by [mytharcher](https://github.com/mytharcher): Compress HTML and JavaScript files on site build.
|
||||
- [Jekyll-minibundle](https://github.com/tkareine/jekyll-minibundle): Asset bundling and cache busting using external minification tool of your choice. No gem dependencies.
|
||||
- [Singlepage-jekyll](https://github.com/JCB-K/singlepage-jekyll) by [JCB-K](https://github.com/JCB-K): Turns Jekyll into a dynamic one-page website.
|
||||
- [generator-jekyllrb](https://github.com/robwierzbowski/generator-jekyllrb): A generator that wraps Jekyll in [Yeoman](http://yeoman.io/), a tool collection and workflow for building modern web apps.
|
||||
@@ -938,15 +923,20 @@ You can find a few useful plugins at the following locations:
|
||||
- [Jekyll-Post](https://github.com/robcrocombe/jekyll-post): A CLI tool to easily draft, edit, and publish Jekyll posts.
|
||||
- [jekyll-numbered-headings](https://github.com/muratayusuke/jekyll-numbered-headings): Adds ordered number to headings.
|
||||
- [jekyll-pre-commit](https://github.com/mpchadwick/jekyll-pre-commit): A framework for running checks against your posts using a git pre-commit hook before you publish them.
|
||||
- [jekyll-pwa-plugin](https://github.com/lavas-project/jekyll-pwa): A plugin provides PWA support for Jekyll. It generates a service worker in Jekyll build process and makes precache and runtime cache available in the runtime with Google Workbox.
|
||||
- [jekyll-algolia](https://community.algolia.com/jekyll-algolia/): Add fast and relevant search to your Jekyll site through the Algolia API.
|
||||
- [jekyll-get](https://github.com/18F/jekyll-get): Download data from external JSON API sources to use in generating a site.
|
||||
- [jekyll-xml-source](https://github.com/mcred/jekyll-xml-source): Download XML and RSS from external sites for use in site data.
|
||||
|
||||
#### Editors
|
||||
|
||||
- [sublime-jekyll](https://github.com/23maverick23/sublime-jekyll): A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via [Package Control](https://packagecontrol.io/packages/Jekyll).
|
||||
- [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate
|
||||
new posts and run `jekyll build` all without leaving vim.
|
||||
- [markdown-writer](https://atom.io/packages/markdown-writer): An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
|
||||
- [Wordpress2Jekyll](https://wordpress.org/plugins/wp2jekyll/): A Wordpress plugin that allows you to use Wordpress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Submit your gem plugins</h5>
|
||||
<h5>Jekyll Plugins Wanted</h5>
|
||||
<p>
|
||||
You're encouraged to add your Jekyll gem plugins to this list, <a href="../contributing/">read the contributing page</a> to find
|
||||
If you have a Jekyll plugin that you would like to see added to this list,
|
||||
you should <a href="../contributing/">read the contributing page</a> to find
|
||||
out how to make that happen.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@@ -26,7 +26,7 @@ To create a new post, all you need to do is create a file in the `_posts`
|
||||
directory. How you name files in this folder is important. Jekyll requires blog
|
||||
post files to be named according to the following format:
|
||||
|
||||
```
|
||||
```sh
|
||||
YEAR-MONTH-DAY-title.MARKUP
|
||||
```
|
||||
|
||||
@@ -34,7 +34,7 @@ Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit
|
||||
numbers, and `MARKUP` is the file extension representing the format used in the
|
||||
file. For example, the following are examples of valid post filenames:
|
||||
|
||||
```
|
||||
```sh
|
||||
2011-12-31-new-years-eve-is-awesome.md
|
||||
2012-09-12-how-to-write-a-blog.md
|
||||
```
|
||||
@@ -42,8 +42,8 @@ file. For example, the following are examples of valid post filenames:
|
||||
<div class="note">
|
||||
<h5>ProTip™: Link to other posts</h5>
|
||||
<p>
|
||||
Use the <a href="../templates/#linking-to-posts"><code>post_url</code></a>
|
||||
tag to link to other posts without having to worry about the URLs
|
||||
Use the <a href="../templates/#post-url"><code>post_url</code></a>
|
||||
tag to link to other posts without having to worry about the URL's
|
||||
breaking when the site permalink style changes.
|
||||
</p>
|
||||
</div>
|
||||
@@ -78,54 +78,55 @@ digital assets along with your text content. While the syntax for linking to
|
||||
these resources differs between Markdown and Textile, the problem of working
|
||||
out where to store these files in your site is something everyone will face.
|
||||
|
||||
There are a number of ways to include digital assets in Jekyll.
|
||||
Because of Jekyll’s flexibility, there are many solutions to how to do this.
|
||||
One common solution is to create a folder in the root of the project directory
|
||||
called something like `assets`, into which any images, files
|
||||
called something like `assets` or `downloads`, into which any images, downloads
|
||||
or other resources are placed. Then, from within any post, they can be linked
|
||||
to using the site’s root as the path for the asset to include. Again, this will
|
||||
depend on the way your site’s (sub)domain and path are configured, but here are
|
||||
some examples in Markdown of how you could do this using the `absolute_url`
|
||||
filter in a post.
|
||||
some examples (in Markdown) of how you could do this using the `site.url`
|
||||
variable in a post.
|
||||
|
||||
Including an image asset in a post:
|
||||
|
||||
{% raw %}
|
||||
```markdown
|
||||
```text
|
||||
... which is shown in the screenshot below:
|
||||

|
||||

|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Linking to a PDF for readers to download:
|
||||
|
||||
{% raw %}
|
||||
```markdown
|
||||
... you can [get the PDF]({{ "/assets/mydoc.pdf" | absolute_url }}) directly.
|
||||
```text
|
||||
... you can [get the PDF]({% raw %}{{ site.url }}{% endraw %}/assets/mydoc.pdf) directly.
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
<div class="info">
|
||||
|
||||
<div class="note">
|
||||
<h5>ProTip™: Link using just the site root URL</h5>
|
||||
<p>
|
||||
You can skip the <code>{% raw %}{{ site.url }}{% endraw %}</code> variable
|
||||
if you <strong>know</strong> your site will only ever be displayed at the
|
||||
root URL of your domain. In this case you can reference assets directly with
|
||||
just <code>/path/file.jpg</code>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## A typical post
|
||||
|
||||
Jekyll can handle many different iterations of the idea you might associate with a "post," however a standard blog style post, including a Title, Layout, Publishing Date, and Categories might look like this:
|
||||
Jekyll can handle many different iterations of the idea you might associate with a "post," however a standard blog style post, including an Title, Layout, Publishing Date, and Categories might look like this:
|
||||
|
||||
```markdown
|
||||
```
|
||||
---
|
||||
layout: post
|
||||
title: "Welcome to Jekyll!"
|
||||
date: 2015-11-17 16:16:01 -0600
|
||||
categories: jekyll update
|
||||
---
|
||||
|
||||
You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bundle exec jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
|
||||
|
||||
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
|
||||
```
|
||||
|
||||
Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content".
|
||||
```
|
||||
Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content."
|
||||
|
||||
## Displaying an index of posts
|
||||
|
||||
@@ -135,17 +136,15 @@ you have a list of posts somewhere. Creating an index of posts on another page
|
||||
language](https://docs.shopify.com/themes/liquid/basics) and its tags. Here’s a
|
||||
basic example of how to create a list of links to your blog posts:
|
||||
|
||||
{% raw %}
|
||||
```html
|
||||
<ul>
|
||||
{% for post in site.posts %}
|
||||
{% raw %}{% for post in site.posts %}{% endraw %}
|
||||
<li>
|
||||
<a href="{{ post.url }}">{{ post.title }}</a>
|
||||
<a href="{% raw %}{{ post.url }}{% endraw %}">{% raw %}{{ post.title }}{% endraw %}</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
{% raw %}{% endfor %}{% endraw %}
|
||||
</ul>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Of course, you have full control over how (and where) you display your posts,
|
||||
and how you structure your site. You should read more about [how templates
|
||||
@@ -156,116 +155,39 @@ you wish to access the currently-rendering page/posts's variables (the
|
||||
variables of the post/page that has the `for` loop in it), use the `page`
|
||||
variable instead.
|
||||
|
||||
## Displaying post categories or tags
|
||||
|
||||
Hey, that's pretty neat, but what about showing just some of your posts that are
|
||||
related to each other? For that you can use any of the [variables definable in
|
||||
Front Matter](https://jekyllrb.com/docs/frontmatter/). In the "typical post"
|
||||
section you can see how to define categories. Simply add the categories to your
|
||||
Front Matter as a [yaml
|
||||
list](https://en.wikipedia.org/wiki/YAML#Basic_components).
|
||||
|
||||
Now that your posts have a category or multiple categories, you can make a page
|
||||
or a template displaying just the posts in those categories you specify. Here's
|
||||
a basic example of how to create a list of posts from a specific category.
|
||||
|
||||
First, in the `_layouts` directory create a new file called `category.html` - in
|
||||
that file put (at least) the following:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
---
|
||||
layout: page
|
||||
---
|
||||
|
||||
{% for post in site.categories[page.category] %}
|
||||
<a href="{{ post.url | absolute_url }}">
|
||||
{{ post.title }}
|
||||
</a>
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Next, in the root directory of your Jekyll install, create a new directory
|
||||
called `category` and then create a file for each category you want to list. For
|
||||
example, if you have a category `blog` then create a file in the new directory
|
||||
called `blog.html` with at least
|
||||
|
||||
```yaml
|
||||
---
|
||||
layout: category
|
||||
title: Blog
|
||||
category: blog
|
||||
---
|
||||
```
|
||||
|
||||
In this case, the listing pages will be accessible at `{baseurl}/category/blog.html`
|
||||
|
||||
Although categories and tags are very similar, they are used to group posts,
|
||||
there are a few differences between them. Categories and sub-categories create
|
||||
hierarchies that, by default, are reflected in the directory structure of your
|
||||
site. A post with the following header
|
||||
```yaml
|
||||
---
|
||||
layout: post
|
||||
title: A Trip
|
||||
category: [ blog, travel ]
|
||||
---
|
||||
```
|
||||
will be accessible at `{baseurl}/blog/travel/year/month/day/A-Trip.html`. On
|
||||
the other hand, a tagged post
|
||||
```yaml
|
||||
---
|
||||
layout: post
|
||||
title: A Trip
|
||||
tags: [ blog, travel ]
|
||||
---
|
||||
```
|
||||
will be saved as `{baseurl}/year/month/day/A-Trip.html`. It is up to you to
|
||||
create `{baseurl}/tag/blog.html` and `{baseurl}/tag/travel.html` the same way as
|
||||
described above for categories.
|
||||
|
||||
While this example is done with tags and categories, you can easily extend your
|
||||
lists to filter by any other variable created with extensions.
|
||||
|
||||
## Post excerpts
|
||||
|
||||
Each post automatically takes the first block of text, from the beginning of
|
||||
the content to the first occurrence of `excerpt_separator`, and sets it in the
|
||||
post's data hash.
|
||||
the content to the first occurrence of `excerpt_separator`, and sets it as the `post.excerpt`.
|
||||
Take the above example of an index of posts. Perhaps you want to include
|
||||
a little hint about the post's content by adding the first paragraph of each of
|
||||
your posts:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
```html
|
||||
<ul>
|
||||
{% for post in site.posts %}
|
||||
{% raw %}{% for post in site.posts %}{% endraw %}
|
||||
<li>
|
||||
<a href="{{ post.url }}">{{ post.title }}</a>
|
||||
{{ post.excerpt }}
|
||||
<a href="{% raw %}{{ post.url }}{% endraw %}">{% raw %}{{ post.title }}{% endraw %}</a>
|
||||
{% raw %}{{ post.excerpt }}{% endraw %}
|
||||
</li>
|
||||
{% endfor %}
|
||||
{% raw %}{% endfor %}{% endraw %}
|
||||
</ul>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Because Jekyll grabs the first paragraph you will not need to wrap the excerpt
|
||||
in `p` tags, which is already done for you. These tags can be removed with the
|
||||
following if you'd prefer:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{{ post.excerpt | remove: '<p>' | remove: '</p>' }}
|
||||
```html
|
||||
{% raw %}{{ post.excerpt | remove: '<p>' | remove: '</p>' }}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
If you don't like the automatically-generated post excerpt, it can be
|
||||
explicitly overridden by adding an `excerpt` value to your post's YAML
|
||||
Front Matter. Alternatively, you can choose to define a custom
|
||||
`excerpt_separator` in the post's YAML front matter:
|
||||
|
||||
```yaml
|
||||
```text
|
||||
---
|
||||
excerpt_separator: <!--more-->
|
||||
---
|
||||
@@ -292,9 +214,8 @@ Jekyll also has built-in support for syntax highlighting of code snippets using
|
||||
either Pygments or Rouge, and including a code snippet in any post is easy.
|
||||
Just use the dedicated Liquid tag as follows:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% highlight ruby %}
|
||||
```text
|
||||
{% raw %}{% highlight ruby %}{% endraw %}
|
||||
def show
|
||||
@widget = Widget(params[:id])
|
||||
respond_to do |format|
|
||||
@@ -302,9 +223,8 @@ def show
|
||||
format.json { render json: @widget }
|
||||
end
|
||||
end
|
||||
{% endhighlight %}
|
||||
{% raw %}{% endhighlight %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
And the output will look like this:
|
||||
|
||||
|
||||
@@ -4,37 +4,35 @@ permalink: /docs/quickstart/
|
||||
---
|
||||
|
||||
|
||||
If you already have a full [Ruby](https://www.ruby-lang.org/en/downloads/) development environment with all headers and [RubyGems](https://rubygems.org/pages/download) installed (see Jekyll's [requirements](/docs/installation/#requirements)), you can create a new Jekyll site by doing the following:
|
||||
If you already have a full [Ruby](https://www.ruby-lang.org/en/downloads/) development environment with all headers and [RubyGems](https://rubygems.org/pages/download) installed (see Jekyll's [requirements](/docs/installation/#requirements/)), you can create a new Jekyll site by doing the following:
|
||||
|
||||
```sh
|
||||
# Install Jekyll and Bundler gems through RubyGems
|
||||
gem install jekyll bundler
|
||||
~ $ gem install jekyll bundler
|
||||
|
||||
# Create a new Jekyll site at ./myblog
|
||||
jekyll new myblog
|
||||
~ $ jekyll new myblog
|
||||
|
||||
# Change into your new directory
|
||||
cd myblog
|
||||
~ $ cd myblog
|
||||
|
||||
# Build the site on the preview server
|
||||
bundle exec jekyll serve
|
||||
~/myblog $ bundle exec jekyll serve
|
||||
|
||||
# Now browse to http://localhost:4000
|
||||
```
|
||||
|
||||
If you encounter any unexpected errors during the above, please refer to the [troubleshooting](/docs/troubleshooting/#configuration-problems) page or the already-mentioned [requirements](/docs/installation/#requirements) page, as you might be missing development headers or other prerequisites.
|
||||
If you encounter any unexpected errors during the above, please refer to the already-mentioned [requirements](/docs/installation/#requirements/) page, as you might be missing development headers or other prerequisites.
|
||||
|
||||
## About Bundler
|
||||
|
||||
`gem install bundler` installs the [bundler](https://rubygems.org/gems/bundler) gem through [RubyGems](https://rubygems.org/). You only need to install it once — not every time you create a new Jekyll project. Here are some additional details:
|
||||
`gem install jekyll bundler` installs the [jekyll](https://rubygems.org/gems/jekyll/) and [bundler](https://rubygems.org/gems/bundler) gems through [RubyGems](https://rubygems.org/). You need only to install the gems one time — not every time you create a new Jekyll project. Here are some additional details:
|
||||
|
||||
* `bundler` is a gem that manages other Ruby gems. It makes sure your gems and gem versions are compatible, and that you have all necessary dependencies each gem requires.
|
||||
* The `Gemfile` and `Gemfile.lock` files inform Bundler about the gem requirements in your site. If your site doesn't have these Gemfiles, you can omit `bundle exec` and just run `jekyll serve`.
|
||||
|
||||
* When you run `bundle exec jekyll serve`, Bundler uses the gems and versions as specified in `Gemfile.lock` to ensure your Jekyll site builds with no compatibility or dependency conflicts.
|
||||
|
||||
For more information about how to use Bundler in your Jekyll project, this [tutorial](https://jekyllrb.com/tutorials/using-jekyll-with-bundler/) should provide answers to the most common questions and explain how to get up and running quickly.
|
||||
|
||||
## Options for creating a new site with Jekyll
|
||||
|
||||
`jekyll new <PATH>` installs a new Jekyll site at the path specified (relative to current directory). In this case, Jekyll will be installed in a directory called `myblog`. Here are some additional details:
|
||||
|
||||
@@ -3,60 +3,41 @@ title: Resources
|
||||
permalink: /docs/resources/
|
||||
---
|
||||
|
||||
Jekyll's growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.
|
||||
Jekyll’s growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.
|
||||
|
||||
## Editors
|
||||
### Useful Guides
|
||||
|
||||
- [jekyll-atom](https://atom.io/packages/jekyll): A collection of snippets and tools for Jekyll in Atom
|
||||
- [markdown-writer](https://atom.io/packages/markdown-writer): An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
|
||||
- [sublime-jekyll](https://github.com/23maverick23/sublime-jekyll): A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via [Package Control](https://packagecontrol.io/packages/Jekyll).
|
||||
- [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate new posts and run `jekyll build` all without leaving vim.
|
||||
- [WordPress2Jekyll](https://wordpress.org/plugins/wp2jekyll/): A WordPress plugin that allows you to use WordPress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.
|
||||
|
||||
## Useful Guides
|
||||
|
||||
- [CloudCannon Academy](https://learn.cloudcannon.com/) is a set of resources created by [CloudCannon](https://cloudcannon.com/) to help folks get up and running with Jekyll. They cover all skill levels, and even include some great video tutorials.
|
||||
- [Jekyll Cheatsheet](https://learn.cloudcannon.com/jekyll-cheat-sheet/) is a single-page resource for Jekyll filters, variables, and the like.
|
||||
- ["Creating and Hosting a Personal Site on GitHub"](http://jmcglone.com/guides/github-pages/)
|
||||
- ['Build A Blog With Jekyll And GitHub Pages' on Smashing Magazine](https://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/)
|
||||
- [Jekyll Tips](http://jekyll.tips) is a set of resources created by [CloudCannon](https://cloudcannon.com) to help folks get up and running with Jekyll. They cover all skill levels, and even include some great video tutorials.
|
||||
- [Jekyll Cheatsheet](http://jekyll.tips/jekyll-cheat-sheet/) is a single-page resource for Jekyll filters, variables, and the like.
|
||||
- [“Creating and Hosting a Personal Site on GitHub”](http://jmcglone.com/guides/github-pages/)
|
||||
- [‘Build A Blog With Jekyll And GitHub Pages’ on Smashing Magazine](https://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/)
|
||||
- Publishing to GitHub Pages? [Check out our documentation page for just that purpose](/docs/github-pages/).
|
||||
- [Blogging with Git, Emacs and Jekyll](https://metajack.im/2009/01/23/blogging-with-git-emacs-and-jekyll/)
|
||||
- [Tips for working with GitHub Pages Integration](https://gist.github.com/jedschneider/2890453)
|
||||
|
||||
## Integrations
|
||||
### Integrations
|
||||
|
||||
- Use a SaaS service as a backend for forms (contact forms, hiring forms, etc.)
|
||||
|
||||
- [Formspree (open source)](https://formspree.io/)
|
||||
- Use a saas service as a backend for forms (contact forms, hiring forms, etc.)
|
||||
- [Formspree (also open source)](https://formspree.io/)
|
||||
- [FormKeep](https://formkeep.com/guides/contact-form-jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=contact-form-jekyll)
|
||||
- [Simple Form](https://getsimpleform.com/)
|
||||
- [Formingo](https://www.formingo.co/guides/jekyll?utm_source=github&utm_medium=jekyll-docs&utm_campaign=Jekyll%20Documentation)
|
||||
- [Formester](http://www.formester.com)
|
||||
- [Talkyard](https://www.talkyard.io/blog-comments): Embedded comments for Jekyll and others (free and open source, or hosted serverless)
|
||||
- [Staticman](https://staticman.net): Add user-generated content to a Jekyll site (free and open source)
|
||||
- [Snipcart](https://snipcart.com/blog/static-site-e-commerce-part-2-integrating-snipcart-with-jekyll): Add a shopping cart to a Jekyll site
|
||||
- [Contentful](https://www.contentful.com/ecosystem/jekyll/): use Jekyll together with the API-driven Contentful CMS.
|
||||
- [Algolia](https://blog.algolia.com/instant-search-blog-documentation-jekyll-plugin/): Add a powerful instant search to your Jekyll site
|
||||
- [Jekyll Bootstrap](http://jekyllbootstrap.com), 0 to Blog in 3 minutes. Provides detailed explanations, examples, and helper-code to make getting started with Jekyll easier.
|
||||
- [Integrating Twitter with Jekyll](http://www.justkez.com/integrating-twitter-with-jekyll/)
|
||||
> “Having migrated Justkez.com to be based on Jekyll, I was pondering how I might include my recent twitterings on the front page of the site. In the WordPress world, this would have been done via a plugin which may or may not have hung the loading of the page, might have employed caching, but would certainly have had some overheads. … Not in Jekyll.”
|
||||
- [Staticman](https://staticman.net): Add user-generated content to a Jekyll site (free and open source)
|
||||
|
||||
## Other commentary
|
||||
### Other commentary
|
||||
|
||||
- [How I'm using Jekyll in 2016](https://mademistakes.com/articles/using-jekyll-2016/)
|
||||
- [‘My Jekyll Fork’, by Mike West](https://mikewest.org/2009/11/my-jekyll-fork)
|
||||
|
||||
- [Talkyard comments instructions for Jekyll](https://jekyll-demo.talkyard.io/2018/01/09/installation-instructions.html)
|
||||
> “Jekyll is a well-architected throwback to a time before WordPress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to it’s core. Here, I’ll point out some highlights of my fork in the hopes that they see usage beyond this site.”
|
||||
|
||||
- [Static Comments with Jekyll & Staticman](https://mademistakes.com/articles/improving-jekyll-static-comments/)
|
||||
- [‘About this Website’, by Carter Allen](http://cartera.me/2010/08/12/about-this-website/)
|
||||
|
||||
- [Adding Ajax pagination to Jekyll](https://eduardoboucas.com/blog/2014/11/05/adding-ajax-pagination-to-jekyll.html)
|
||||
|
||||
- ['My Jekyll Fork', by Mike West](https://mikewest.org/2009/11/my-jekyll-fork)
|
||||
|
||||
> "Jekyll is a well-architected throwback to a time before WordPress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to it's core. Here, I'll point out some highlights of my fork in the hopes that they see usage beyond this site."
|
||||
|
||||
- ['About this Website', by Carter Allen](http://cartera.me/2010/08/12/about-this-website/)
|
||||
|
||||
> "Jekyll is everything that I ever wanted in a blogging engine. Really. It isn't perfect, but what's excellent about it is that if there's something wrong, I know exactly how it works and how to fix it. It runs on the your machine only, and is essentially an added"build" step between you and the browser. I coded this entire site in TextMate using standard HTML5 and CSS3, and then at the end I added just a few little variables to the markup. Presto-chango, my site is built and I am at peace with the world."
|
||||
> “Jekyll is everything that I ever wanted in a blogging engine. Really. It isn’t perfect, but what’s excellent about it is that if there’s something wrong, I know exactly how it works and how to fix it. It runs on the your machine only, and is essentially an added”build" step between you and the browser. I coded this entire site in TextMate using standard HTML5 and CSS3, and then at the end I added just a few little variables to the markup. Presto-chango, my site is built and I am at peace with the world.”
|
||||
|
||||
- [Generating a Tag Cloud in Jekyll](http://www.justkez.com/generating-a-tag-cloud-in-jekyll/) – A guide to implementing a tag cloud and per-tag content pages using Jekyll.
|
||||
|
||||
- A way to [extend Jekyll](https://github.com/rfelix/jekyll_ext) without forking and modifying the Jekyll gem codebase and some [portable Jekyll extensions](https://wiki.github.com/rfelix/jekyll_ext/extensions) that can be reused and shared.
|
||||
- [Using your Rails layouts in Jekyll](http://numbers.brighterplanet.com/2010/08/09/sharing-rails-views-with-jekyll)
|
||||
- [Adding Ajax pagination to Jekyll](https://eduardoboucas.com/blog/2014/11/05/adding-ajax-pagination-to-jekyll.html)
|
||||
|
||||
@@ -13,8 +13,6 @@ learning purposes.
|
||||
([source](https://github.com/github/training-kit))
|
||||
- [Rasmus Andersson](https://rsms.me/)
|
||||
([source](https://github.com/rsms/rsms.github.com))
|
||||
- [MvvmCross](https://mvvmcross.github.io/MvvmCross/)
|
||||
([source](https://github.com/MvvmCross/MvvmCross/tree/master/docs))
|
||||
|
||||
If you would like to explore more examples, you can find a list of sites
|
||||
and their sources on the ["Sites" page in the Jekyll wiki][jekyll-sites].
|
||||
|
||||
@@ -65,36 +65,3 @@ following metadata:
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
Note that in the above table, `file` can be anything. It's simply an arbitrarily set variable used in your own logic (such as in a for loop). It isn't a global site or page variable.
|
||||
|
||||
## Add front matter to static files
|
||||
|
||||
Although you can't directly add front matter values to static files, you can set front matter values through the [defaults property](../configuration/#front-matter-defaults) in your configuration file. When Jekyll builds the site, it will use the front matter values you set.
|
||||
|
||||
Here's an example:
|
||||
|
||||
In your `_config.yml` file, add the following values to the `defaults` property:
|
||||
|
||||
```yaml
|
||||
defaults:
|
||||
- scope:
|
||||
path: "assets/img"
|
||||
values:
|
||||
image: true
|
||||
```
|
||||
|
||||
This assumes that your Jekyll site has a folder path of `assets/img` where you have images (static files) stored. When Jekyll builds the site, it will treat each image as if it had the front matter value of `image: true`.
|
||||
|
||||
Suppose you want to list all your image assets as contained in `assets/img`. You could use this for loop to look in the `static_files` object and get all static files that have this front matter property:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% assign image_files = site.static_files | where: "image", true %}
|
||||
{% for myimage in image_files %}
|
||||
{{ myimage.path }}
|
||||
{% endfor %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
When you build your site, the output will list the path to each file that meets this front matter condition.
|
||||
|
||||
@@ -5,8 +5,7 @@ permalink: /docs/structure/
|
||||
|
||||
Jekyll is, at its core, a text transformation engine. The concept behind the
|
||||
system is this: you give it text written in your favorite markup language, be
|
||||
that Markdown, [Textile](https://github.com/jekyll/jekyll-textile-converter)
|
||||
, or just plain HTML, and it churns that through a layout
|
||||
that Markdown, Textile, or just plain HTML, and it churns that through a layout
|
||||
or a series of layout files. Throughout that process you can tweak how you want
|
||||
the site URLs to look, what data gets displayed in the layout, and more. This
|
||||
is all done through editing text files; the static web site is the final
|
||||
@@ -137,9 +136,9 @@ An overview of what each of these does:
|
||||
<p>
|
||||
Well-formatted site data should be placed here. The Jekyll engine
|
||||
will autoload all data files (using either the <code>.yml</code>,
|
||||
<code>.yaml</code>, <code>.json</code>, <code>.csv</code> or
|
||||
<code>.tsv</code> formats and extensions) in this directory,
|
||||
and they will be accessible via `site.data`. If there's a file
|
||||
<code>.yaml</code>, <code>.json</code> or <code>.csv</code>
|
||||
formats and extensions) in this directory, and they will be
|
||||
accessible via `site.data`. If there's a file
|
||||
<code>members.yml</code> under the directory, then you can access
|
||||
contents of the file through <code>site.data.members</code>.
|
||||
</p>
|
||||
@@ -186,7 +185,7 @@ An overview of what each of these does:
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>index.html</code> or <code>index.md</code> and other HTML,
|
||||
Markdown files</p>
|
||||
Markdown, Textile files</p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
---
|
||||
title: Support
|
||||
permalink: "/docs/support/"
|
||||
note: This file is autogenerated. Edit /.github/SUPPORT.markdown instead.
|
||||
---
|
||||
|
||||
## Getting Help
|
||||
|
||||
**Jekyll's issue tracker is not a support forum.**
|
||||
|
||||
If you're looking for support for Jekyll, there are a lot of options:
|
||||
|
||||
* Read [Jekyll Documentation](https://jekyllrb.com/docs/home/)
|
||||
* If you have a question about using Jekyll, start a discussion on [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll)
|
||||
* Chat with Jekyllers — Join [our Gitter channel](https://gitter.im/jekyll/jekyll) or [our IRC channel on Freenode](irc:irc.freenode.net/jekyll)
|
||||
|
||||
There are a bunch of helpful community members on these services that should be willing to point you in the right direction.
|
||||
|
||||
## Report a bug
|
||||
|
||||
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository — First [look for the plugin on rubygems](https://rubygems.org/) then click on the `Homepage` link to access the plugin repository.
|
||||
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
|
||||
|
||||
Happy Jekyllin'!
|
||||
@@ -4,11 +4,10 @@ permalink: /docs/templates/
|
||||
---
|
||||
|
||||
Jekyll uses the [Liquid](https://shopify.github.io/liquid/) templating language to
|
||||
process templates. All of the standard Liquid [tags](https://shopify.github.io/liquid/tags/control-flow/) and
|
||||
[filters](https://shopify.github.io/liquid/filters/abs/) are
|
||||
supported. To make common tasks easier, Jekyll even adds a few handy filters
|
||||
and tags of its own, all of which you can find on this page. Jekyll even lets
|
||||
you come up with your own tags via plugins.
|
||||
process templates. All of the standard Liquid [tags](https://shopify.github.io/liquid/tags/) and
|
||||
[filters](https://shopify.github.io/liquid/filters/) are
|
||||
supported. Jekyll even adds a few handy filters and tags of its own to make
|
||||
common tasks easier.
|
||||
|
||||
## Filters
|
||||
|
||||
@@ -91,21 +90,6 @@ you come up with your own tags via plugins.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Date to String in ordinal US style</strong></p>
|
||||
<p>Format a date to ordinal, US, short format.
|
||||
{% include docs_version_badge.html version="3.8.0" %}</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ site.time | date_to_string: "ordinal", "US" }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">Nov 7th, 2008</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Date to Long String</strong></p>
|
||||
@@ -120,21 +104,6 @@ you come up with your own tags via plugins.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Date to Long String in ordinal UK style</strong></p>
|
||||
<p>Format a date to ordinal, UK, long format.
|
||||
{% include docs_version_badge.html version="3.8.0" %}</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ site.time | date_to_long_string: "ordinal" }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">7th November 2008</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Where</strong></p>
|
||||
@@ -149,8 +118,7 @@ you come up with your own tags via plugins.
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Where Expression</strong></p>
|
||||
<p>Select all the objects in an array where the expression is true.
|
||||
{% include docs_version_badge.html version="3.2.0" %}</p>
|
||||
<p>Select all the objects in an array where the expression is true. Jekyll v3.2.0 & later.</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
@@ -181,8 +149,7 @@ you come up with your own tags via plugins.
|
||||
<tr>
|
||||
<td>
|
||||
<p class="name"><strong>Group By Expression</strong></p>
|
||||
<p>Group an array's items using a Liquid expression.
|
||||
{% include docs_version_badge.html version="3.4.0" %}</p>
|
||||
<p>Group an array's items using a Liquid expression.</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
@@ -211,15 +178,15 @@ you come up with your own tags via plugins.
|
||||
<p class="name"><strong>CGI Escape</strong></p>
|
||||
<p>
|
||||
CGI escape a string for use in a URL. Replaces any special characters
|
||||
with appropriate <code>%XX</code> replacements. CGI escape normally replaces a space with a plus <code>+</code> sign.
|
||||
with appropriate %XX replacements.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ "foo, bar; baz?" | cgi_escape }}{% endraw %}</code>
|
||||
<code class="filter">{% raw %}{{ "foo,bar;baz?" | cgi_escape }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">foo%2C+bar%3B+baz%3F</code>
|
||||
<code class="output">foo%2Cbar%3Bbaz%3F</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -227,15 +194,15 @@ you come up with your own tags via plugins.
|
||||
<td>
|
||||
<p class="name"><strong>URI Escape</strong></p>
|
||||
<p>
|
||||
Percent encodes any special characters in a URI. URI escape normally replaces a space with <code>%20</code>. <a href="https://en.wikipedia.org/wiki/Percent-encoding#Types_of_URI_characters">Reserved characters</a> will not be escaped.
|
||||
URI escape a string.
|
||||
</p>
|
||||
</td>
|
||||
<td class="align-center">
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ "http://foo.com/?q=foo, \bar?" | uri_escape }}{% endraw %}</code>
|
||||
<code class="filter">{% raw %}{{ "foo, bar \baz?" | uri_escape }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">http://foo.com/?q=foo,%20%5Cbar?</code>
|
||||
<code class="output">foo,%20bar%20%5Cbaz?</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -325,18 +292,6 @@ you come up with your own tags via plugins.
|
||||
<p>
|
||||
<code class="output">the-_config.yml-file</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ "The _cönfig.yml file" | slugify: 'ascii' }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">the-c-nfig-yml-file</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="filter">{% raw %}{{ "The cönfig.yml file" | slugify: 'latin' }}{% endraw %}</code>
|
||||
</p>
|
||||
<p>
|
||||
<code class="output">the-config-yml-file</code>
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -460,25 +415,16 @@ The default is `default`. They are as follows (with what they filter):
|
||||
- `raw`: spaces
|
||||
- `default`: spaces and non-alphanumeric characters
|
||||
- `pretty`: spaces and non-alphanumeric characters except for `._~!$&'()+,;=@`
|
||||
- `ascii`: spaces, non-alphanumeric, and non-ASCII characters
|
||||
- `latin`: like `default`, except Latin characters are first transliterated (e.g. `àèïòü` to `aeiou`) {%- include docs_version_badge.html version="3.7.0" -%}
|
||||
|
||||
## Tags
|
||||
|
||||
* [Includes](#includes)
|
||||
* [Code snippet highlighting](#code-snippet-highlighting)
|
||||
* [Linking to pages, collections and posts (the new and improved way)](#links)
|
||||
* [Linking to posts (the old way)](#linking-to-posts)
|
||||
|
||||
### Includes
|
||||
|
||||
If you have small page snippets that you want to include in multiple places on your site, save the snippets as *include files* and insert them where required, by using the `include` tag:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% include footer.html %}
|
||||
{% raw %}{% include footer.html %}{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
Jekyll expects all *include files* to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file.
|
||||
|
||||
@@ -499,15 +445,15 @@ languages](http://pygments.org/languages/)
|
||||
|
||||
To render a code block with syntax highlighting, surround your code as follows:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% highlight ruby %}
|
||||
def foo
|
||||
puts 'foo'
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
The argument to the `highlight` tag (`ruby` in the example above) is the
|
||||
language identifier. To find the appropriate identifier to use for the language
|
||||
@@ -515,13 +461,6 @@ you want to highlight, look for the “short name” on the [Rouge
|
||||
wiki](https://github.com/jayferd/rouge/wiki/List-of-supported-languages-and-lexers)
|
||||
or the [Pygments' Lexers page](http://pygments.org/docs/lexers/).
|
||||
|
||||
<div class="note info">
|
||||
<h5>Jekyll processes all Liquid filters in code blocks</h5>
|
||||
<p>If you are using a language that contains curly braces, you
|
||||
will likely need to place <code>{% raw %}</code> and
|
||||
<code>{% endraw %}</code> tags around your code.</p>
|
||||
</div>
|
||||
|
||||
#### Line numbers
|
||||
|
||||
There is a second argument to `highlight` called `linenos` that is optional.
|
||||
@@ -529,15 +468,15 @@ Including the `linenos` argument will force the highlighted code to include line
|
||||
numbers. For instance, the following code block would include line numbers next
|
||||
to each line:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% highlight ruby linenos %}
|
||||
def foo
|
||||
puts 'foo'
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
#### Stylesheets for syntax highlighting
|
||||
|
||||
@@ -549,6 +488,27 @@ site. If you use `linenos`, you might want to include an additional CSS class
|
||||
definition for the `.lineno` class in `syntax.css` to distinguish the line
|
||||
numbers from the highlighted code.
|
||||
|
||||
### Gist
|
||||
|
||||
Use the `gist` tag to easily embed a GitHub Gist onto your site. This works
|
||||
with public or secret gists:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% gist parkr/931c1c8d465a04042403 %}
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
You may also optionally specify the filename in the gist to display:
|
||||
|
||||
```liquid
|
||||
{% raw %}
|
||||
{% gist parkr/931c1c8d465a04042403 jekyll-private-gist.markdown %}
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
To use the `gist` tag, you'll need to add the
|
||||
[jekyll-gist](https://github.com/jekyll/jekyll-gist) gem to your project.
|
||||
|
||||
## Links
|
||||
|
||||
@@ -558,62 +518,62 @@ To link to a post, a page, collection item, or file, the `link` tag will generat
|
||||
|
||||
You must include the file's original extension when using the `link` tag. Here are some examples:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{{ site.baseurl }}{% link _collection/name-of-document.md %}
|
||||
{{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %}
|
||||
{{ site.baseurl }}{% link news/index.html %}
|
||||
{{ site.baseurl }}{% link /assets/files/doc.pdf %}
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
You can also use the `link` tag to create a link in Markdown as follows:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
[Link to a document]({{ site.baseurl }}{% link _collection/name-of-document.md %})
|
||||
[Link to a post]({{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %})
|
||||
[Link to a page]({{ site.baseurl }}{% link news/index.html %})
|
||||
[Link to a file]({{ site.baseurl }}{% link /assets/files/doc.pdf %})
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
(Including `{% raw %}{{ site.baseurl }}{% endraw %}` is optional — it depends on whether you want to preface the page URL with the `baseurl` value.)
|
||||
|
||||
The path to the post, page, or collection is defined as the path relative to the root directory (where your config file is) to the file, not the path from your existing page to the other page.
|
||||
|
||||
For example, suppose you're creating a link in `page_a.md` (stored in `pages/folder1/folder2`) to `page_b.md` (stored in `pages/folder1`). Your path in the link would not be `../page_b.html`. Instead, it would be `/pages/folder1/page_b.md`.
|
||||
For example, suppose you're creating a link `page_a.md` (stored in `pages/folder1/folder2`) to `page_b.md` (stored in `pages/folder1`). Your path in the link would not be `../page_b.html`. Instead, it would be `/pages/folder1/page_b.md`.
|
||||
|
||||
If you're unsure of the path, add `{% raw %}{{ page.path }}{% endraw %}` to the page and it will display the path.
|
||||
|
||||
One major benefit of using the `link` or `post_url` tag is link validation. If the link doesn't exist, Jekyll won't build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).
|
||||
One major benefit of using the `link` tag is link validation. If the link doesn't exist, Jekyll won't build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).
|
||||
|
||||
Note you cannot add filters to `link` tags. For example, you cannot append a string using Liquid filters, such as `{% raw %}{% link mypage.html | append: "#section1" %} {% endraw %}`. To link to sections on a page, you will need to use regular HTML or Markdown linking techniques.
|
||||
|
||||
### Linking to posts
|
||||
|
||||
If you want to include a link to a post on your site, the `post_url` tag will generate the correct permalink URL for the post you specify.
|
||||
If you want like to include a link to a post on your site, the `post_url` tag will generate the correct permalink URL for the post you specify.
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
If you organize your posts in subdirectories, you need to include subdirectory path to the post:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %}
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
There is no need to include the file extension when using the `post_url` tag.
|
||||
|
||||
You can also use this tag to create a link to a post in Markdown as follows:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% raw %}
|
||||
[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %})
|
||||
```
|
||||
{% endraw %}
|
||||
```
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Themes
|
||||
permalink: /docs/themes/
|
||||
---
|
||||
|
||||
Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes specify plugins and package up assets, layouts, includes, and stylesheets in a way that can be overridden by your site's content.
|
||||
Jekyll has an extensive theme system that allows you to leverage community-maintained templates and styles to customize your site's presentation. Jekyll themes package up layouts, includes, and stylesheets in a way that can be overridden by your site's content.
|
||||
|
||||
## Understanding gem-based themes
|
||||
|
||||
@@ -19,8 +19,8 @@ In the case of Minima, you see only the following files in your Jekyll site dire
|
||||
├── _config.yml
|
||||
├── _posts
|
||||
│ └── 2016-12-04-welcome-to-jekyll.markdown
|
||||
├── about.markdown
|
||||
└── index.markdown
|
||||
├── about.md
|
||||
└── index.md
|
||||
```
|
||||
|
||||
The `Gemfile` and `Gemfile.lock` files are used by Bundler to keep track of the required gems and gem versions you need to build your Jekyll site.
|
||||
@@ -35,25 +35,31 @@ The goal of gem-based themes is to allow you to get all the benefits of a robust
|
||||
|
||||
Jekyll themes set default layouts, includes, and stylesheets. However, you can override any of the theme defaults with your own site content.
|
||||
|
||||
To replace layouts or includes in your theme, make a copy in your `_layouts` or `_includes` directory of the specific file you wish to modify, or create the file from scratch giving it the same name as the file you wish to override.
|
||||
|
||||
For example, if your selected theme has a `page` layout, you can override the theme's layout by creating your own `page` layout in the `_layouts` directory (that is, `_layouts/page.html`).
|
||||
|
||||
To locate a theme's files on your computer:
|
||||
Jekyll will look first to your site's content before looking to the theme's defaults for any requested file in the following folders:
|
||||
|
||||
1. Run `bundle show` followed by the name of the theme's gem, e.g., `bundle show minima` for Jekyll's default theme.
|
||||
- `/assets`
|
||||
- `/_layouts`
|
||||
- `/_includes`
|
||||
- `/_sass`
|
||||
|
||||
This returns the location of the gem-based theme files. For example, the Minima theme's files might be located in `/usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0` on macOS.
|
||||
Refer to your selected theme's documentation and source repository for more information on what files you can override.
|
||||
{: .note .info}
|
||||
|
||||
To locate theme's files on your computer:
|
||||
|
||||
1. Run `bundle show` followed by the name of the theme's gem, e.g., `bundle show minima` for default Jekyll's theme.
|
||||
|
||||
This returns the location of the gem-based theme files. For example, Minima theme's files are located in `/usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0` on macOS.
|
||||
|
||||
2. Open the theme's directory in Finder or Explorer:
|
||||
|
||||
```sh
|
||||
```shell
|
||||
# On MacOS
|
||||
open $(bundle show minima)
|
||||
# On Windows
|
||||
explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
|
||||
# On Linux
|
||||
xdg-open $(bundle show minima)
|
||||
```
|
||||
|
||||
A Finder or Explorer window opens showing the theme's files and directories. The Minima theme gem contains these files:
|
||||
@@ -86,23 +92,9 @@ To locate a theme's files on your computer:
|
||||
└── main.scss
|
||||
```
|
||||
|
||||
With a clear understanding of the theme's files, you can now override any theme file by creating a similarly named file in your Jekyll site directory.
|
||||
With a clear understanding of the theme's files, you can now override any theme file by creating a similarly named file in your Jekyll site directory.
|
||||
|
||||
Let's say, for a second example, you want to override Minima's footer. In your Jekyll site, create an `_includes` folder and add a file in it called `footer.html`. Jekyll will now use your site's `footer.html` file instead of the `footer.html` file from the Minima theme gem.
|
||||
|
||||
To modify any stylesheet you must take the extra step of also copying the main sass file (`_sass/minima.scss` in the Minima theme) into the `_sass` directory in your site's source.
|
||||
|
||||
Jekyll will look first to your site's content before looking to the theme's defaults for any requested file in the following folders:
|
||||
|
||||
- `/assets`
|
||||
- `/_layouts`
|
||||
- `/_includes`
|
||||
- `/_sass`
|
||||
|
||||
Note that making copies of theme files will prevent you from receiving any theme updates on those files. An alternative, to continue getting theme updates on all stylesheets, is to use higher specificity CSS selectors in your own additional, originally named CSS files.
|
||||
|
||||
Refer to your selected theme's documentation and source repository for more information on what files you can override.
|
||||
{: .note .info}
|
||||
Let's say you want to override Minima's footer. In your Jekyll site, create an `_includes` folder and add a file in it called `footer.html`. Jekyll will now use your site's `footer.html` file instead of the `footer.html` file from the Minima theme gem.
|
||||
|
||||
## Converting gem-based themes to regular themes
|
||||
|
||||
@@ -110,48 +102,7 @@ Suppose you want to get rid of the gem-based theme and convert it to a regular t
|
||||
|
||||
To do this, copy the files from the theme gem's directory into your Jekyll site directory. (For example, copy them to `/myblog` if you created your Jekyll site at `/myblog`. See the previous section for details.)
|
||||
|
||||
Then you must tell Jekyll about the plugins that were referenced by the theme. You can find these plugins in the theme's gemspec file as runtime dependencies. If you were converting the Minima theme, for example, you might see:
|
||||
|
||||
```
|
||||
spec.add_runtime_dependency "jekyll-feed", "~> 0.9"
|
||||
spec.add_runtime_dependency "jekyll-seo-tag", "~> 2.1"
|
||||
```
|
||||
|
||||
You should include these references in the `Gemfile` in one of two ways.
|
||||
|
||||
You could list them individually in both `Gemfile` and `_config.yml`.
|
||||
|
||||
```ruby
|
||||
# ./Gemfile
|
||||
|
||||
gem "jekyll-feed", "~> 0.9"
|
||||
gem "jekyll-seo-tag", "~> 2.1"
|
||||
```
|
||||
|
||||
```yaml
|
||||
# ./_config.yml
|
||||
|
||||
plugins:
|
||||
- jekyll-feed
|
||||
- jekyll-seo-tag
|
||||
```
|
||||
|
||||
Or you could list them explicitly as Jekyll plugins in your Gemfile, and not update `_config.yml`, like this:
|
||||
|
||||
```ruby
|
||||
# ./Gemfile
|
||||
|
||||
group :jekyll_plugins do
|
||||
gem "jekyll-feed", "~> 0.9"
|
||||
gem "jekyll-seo-tag", "~> 2.1"
|
||||
end
|
||||
```
|
||||
|
||||
Either way, don't forget to `bundle update`.
|
||||
|
||||
However, if you're publishing on GitHub Pages you should update only your `_config.yml` as GitHub Pages doesn't load plugins via Bundler.
|
||||
|
||||
Finally, remove references to the theme gem in `Gemfile` and configuration. For example, to remove `minima`:
|
||||
Then remove references to the theme gem in `Gemfile` and configuration. For example, to remove `minima`:
|
||||
|
||||
- Open `Gemfile` and remove `gem "minima", "~> 2.0"`.
|
||||
- Open `_config.yml` and remove `theme: minima`.
|
||||
@@ -166,21 +117,10 @@ For example, search for [jekyll theme on RubyGems](https://rubygems.org/search?u
|
||||
|
||||
To install a gem-based theme:
|
||||
|
||||
1. Add the theme gem to your site's `Gemfile`:
|
||||
1. Add the theme to your site's `Gemfile`:
|
||||
|
||||
```ruby
|
||||
# ./Gemfile
|
||||
|
||||
# This is an example, declare the theme gem you want to use here
|
||||
gem "jekyll-theme-minimal"
|
||||
```
|
||||
Or if you've started with the `jekyll new` command, replace `gem "minima", "~> 2.0"` with the gem you want, e.g:
|
||||
|
||||
```diff
|
||||
# ./Gemfile
|
||||
|
||||
- gem "minima", "~> 2.0"
|
||||
+ gem "jekyll-theme-minimal"
|
||||
```sh
|
||||
gem "jekyll-theme-awesome"
|
||||
```
|
||||
|
||||
2. Install the theme:
|
||||
@@ -191,8 +131,8 @@ To install a gem-based theme:
|
||||
|
||||
3. Add the following to your site's `_config.yml` to activate the theme:
|
||||
|
||||
```yaml
|
||||
theme: jekyll-theme-minimal
|
||||
```sh
|
||||
theme: jekyll-theme-awesome
|
||||
```
|
||||
|
||||
4. Build your site:
|
||||
@@ -201,10 +141,9 @@ To install a gem-based theme:
|
||||
bundle exec jekyll serve
|
||||
```
|
||||
|
||||
You can have multiple themes listed in your site's `Gemfile`, but only one theme can be selected in your site's `_config.yml`.
|
||||
{: .note .info }
|
||||
You can have multiple themes listed in your site's `Gemfile`, but only one theme can be selected in your site's `_config.yml`. {: .note .info }
|
||||
|
||||
If you're publishing your Jekyll site on [GitHub Pages](https://pages.github.com/), note that GitHub Pages supports only [some gem-based themes](https://pages.github.com/themes/). GitHub Pages also supports [using any theme hosted on GitHub](https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site/#adding-a-jekyll-theme-in-your-sites-_configyml-file) using the `remote_theme` configuration as if it were a gem-based theme.
|
||||
If you're publishing your Jekyll site on [GitHub Pages](https://pages.github.com/), note that GitHub Pages supports only some gem-based themes. See [Supported Themes](https://pages.github.com/themes/) in GitHub's documentation to see which themes are supported.
|
||||
|
||||
## Creating a gem-based theme
|
||||
|
||||
@@ -244,7 +183,7 @@ For example, if your theme has a `/_layouts/page.html` file, and a page has `lay
|
||||
|
||||
Any file in `/assets` will be copied over to the user's site upon build unless they have a file with the same relative path. You can ship any kind of asset here: SCSS, an image, a webfont, etc. These files behave like pages and static files in Jekyll:
|
||||
|
||||
- If the file has [YAML front matter](/docs/frontmatter/) at the top, it will be rendered.
|
||||
- If the file has [YAML front matter](../docs/frontmatter/) at the top, it will be rendered.
|
||||
- If the file does not have YAML front matter, it will simply be copied over into the resulting site.
|
||||
|
||||
This allows theme creators to ship a default `/assets/styles.scss` file which their layouts can depend on as `/assets/styles.css`.
|
||||
@@ -262,17 +201,9 @@ _sass
|
||||
|
||||
Your theme's styles can be included in the user's stylesheet using the `@import` directive.
|
||||
|
||||
{% raw %}
|
||||
```css
|
||||
@import "{{ site.theme }}";
|
||||
{% raw %}@import "{{ site.theme }}";{% endraw %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### Theme-gem dependencies {%- include docs_version_badge.html version="3.5.0" -%}
|
||||
|
||||
Jekyll will automatically require all whitelisted `runtime_dependencies` of your theme-gem even if they're not explicitly included under the `plugins` array in the site's config file. (Note: whitelisting is only required when building or serving with the `--safe` option.)
|
||||
|
||||
With this, the end-user need not keep track of the plugins required to be included in their config file for their theme-gem to work as intended.
|
||||
|
||||
### Documenting your theme
|
||||
|
||||
@@ -280,37 +211,28 @@ Your theme should include a `/README.md` file, which explains how site authors c
|
||||
|
||||
### Adding a screenshot
|
||||
|
||||
Themes are visual. Show users what your theme looks like by including a screenshot as `/screenshot.png` within your theme's repository where it can be retrieved programmatically. You can also include this screenshot within your theme's documentation.
|
||||
Themes are visual. Show users what your theme looks like by including a screenshot as `/screenshot.png` within your theme's repository where it can be retrieved programatically. You can also include this screenshot within your theme's documentation.
|
||||
|
||||
### Previewing your theme
|
||||
|
||||
To preview your theme as you're authoring it, it may be helpful to add dummy content in, for example, `/index.html` and `/page.html` files. This will allow you to use the `jekyll build` and `jekyll serve` commands to preview your theme, just as you'd preview a Jekyll site.
|
||||
|
||||
If you do preview your theme locally, be sure to add `/_site` to your theme's `.gitignore` file to prevent the compiled site from also being included when you distribute your theme.
|
||||
{: .info .note}
|
||||
If you do preview your theme locally, be sure to add `/_site` to your theme's `.gitignore` file to prevent the compiled site from also being included when you distribute your theme. {: .info .note}
|
||||
|
||||
### Publishing your theme
|
||||
|
||||
Themes are published via [RubyGems.org](https://rubygems.org). You will need a RubyGems account, which you can [create for free](https://rubygems.org/sign_up).
|
||||
|
||||
1. First, you need to have it in a git repository:
|
||||
|
||||
```sh
|
||||
git init # Only the first time
|
||||
git add -A
|
||||
git commit -m "Init commit"
|
||||
```
|
||||
|
||||
2. Next, package your theme, by running the following command, replacing `jekyll-theme-awesome` with the name of your theme:
|
||||
1. First, package your theme, by running the following command, replacing `jekyll-theme-awesome` with the name of your theme:
|
||||
|
||||
```sh
|
||||
gem build jekyll-theme-awesome.gemspec
|
||||
```
|
||||
|
||||
3. Finally, push your packaged theme up to the RubyGems service, by running the following command, again replacing `jekyll-theme-awesome` with the name of your theme:
|
||||
2. Next, push your packaged theme up to the RubyGems service, by running the following command, again replacing `jekyll-theme-awesome` with the name of your theme:
|
||||
|
||||
```sh
|
||||
gem push jekyll-theme-awesome-*.gem
|
||||
```
|
||||
|
||||
4. To release a new version of your theme, update the version number in the gemspec file, ( `jekyll-theme-awesome.gemspec` in this example ), and then repeat Steps 1 - 3 above. We recommend that you follow [Semantic Versioning](http://semver.org/) while bumping your theme-version.
|
||||
3. To release a new version of your theme, update the version number in the gemspec file, ( `jekyll-theme-awesome.gemspec` in this example ), and then repeat Steps 1 & 2 above. We recommend that you follow [Semantic Versioning](http://semver.org/) while bumping your theme-version.
|
||||
|
||||
@@ -17,7 +17,7 @@ that might be of help. If the problem you’re experiencing isn’t covered belo
|
||||
## Installation Problems
|
||||
|
||||
If you encounter errors during gem installation, you may need to install
|
||||
the header files for compiling extension modules for Ruby 2.x This
|
||||
the header files for compiling extension modules for Ruby 2.0.0. This
|
||||
can be done on Ubuntu or Debian by running:
|
||||
|
||||
```sh
|
||||
@@ -36,21 +36,6 @@ If you installed the above - specifically on Fedora 23 - but the extensions woul
|
||||
sudo dnf install redhat-rpm-config
|
||||
```
|
||||
|
||||
On Arch Linux you need to run:
|
||||
|
||||
```sh
|
||||
sudo pacman -S ruby-ffi
|
||||
```
|
||||
|
||||
On Ubuntu if you get stuck after `bundle exec jekyll serve` and see error
|
||||
messages like `Could not locate Gemfile` or `.bundle/ directory`, it's likely
|
||||
because all requirements have not been fully met. Recent stock Ubuntu
|
||||
distributions require the installation of both the `ruby` and `ruby-all-dev`
|
||||
packages:
|
||||
|
||||
```sh
|
||||
sudo apt-get install ruby ruby-all-dev
|
||||
```
|
||||
|
||||
On [NearlyFreeSpeech](https://www.nearlyfreespeech.net/) you need to run the
|
||||
following commands before installing Jekyll:
|
||||
@@ -71,16 +56,10 @@ sudo emerge -av dev-ruby/rubygems
|
||||
On Windows, you may need to install [RubyInstaller
|
||||
DevKit](https://wiki.github.com/oneclick/rubyinstaller/development-kit).
|
||||
|
||||
On Android (with Termux) you can install all requirements by running:
|
||||
|
||||
```sh
|
||||
apt update && apt install libffi-dev clang ruby-dev make
|
||||
```
|
||||
|
||||
On macOS, you may need to update RubyGems (using `sudo` only if necessary):
|
||||
|
||||
```sh
|
||||
gem update --system
|
||||
sudo gem update --system
|
||||
```
|
||||
|
||||
If you still have issues, you can download and install new Command Line
|
||||
@@ -90,11 +69,11 @@ Tools (such as `gcc`) using the following command:
|
||||
xcode-select --install
|
||||
```
|
||||
|
||||
which may allow you to install native gems using this command (again, using
|
||||
which may allow you to install native gems using this command (again using
|
||||
`sudo` only if necessary):
|
||||
|
||||
```sh
|
||||
gem install jekyll
|
||||
sudo gem install jekyll
|
||||
```
|
||||
|
||||
Note that upgrading macOS does not automatically upgrade Xcode itself
|
||||
@@ -103,65 +82,16 @@ Xcode.app can interfere with the command line tools downloaded above. If
|
||||
you run into this issue, upgrade Xcode and install the upgraded Command
|
||||
Line Tools.
|
||||
|
||||
### Running Jekyll as Non-Superuser (no sudo!)
|
||||
{: #no-sudo}
|
||||
|
||||
On most flavors of Linux, macOS, and Bash on Ubuntu on Windows, it is
|
||||
possible to run Jekyll as a non-superuser and without having to install
|
||||
gems to system-wide locations by adding the following lines to the end
|
||||
of your `.bashrc` file:
|
||||
|
||||
```
|
||||
# Ruby exports
|
||||
|
||||
export GEM_HOME=$HOME/gems
|
||||
export PATH=$HOME/gems/bin:$PATH
|
||||
```
|
||||
|
||||
This tells `gem` to place its gems within the user's home folder,
|
||||
not in a system-wide location, and adds the local `jekyll` command to the
|
||||
user's `PATH` ahead of any system-wide paths.
|
||||
|
||||
This is also useful for many shared webhosting services, where user accounts
|
||||
have only limited privileges. Adding these exports to `.bashrc` before running
|
||||
`gem install jekyll bundler` allows a complete non-`sudo` install of Jekyll.
|
||||
|
||||
To activate the new exports, either close and restart Bash, logout and
|
||||
log back into your shell account, or run `. .bashrc` in the
|
||||
currently-running shell.
|
||||
|
||||
If you see the following error when running the `jekyll new` command,
|
||||
you can solve it by using the above-described procedure:
|
||||
|
||||
```sh
|
||||
jekyll new test
|
||||
|
||||
Running bundle install in /home/user/test...
|
||||
|
||||
Your user account isn't allowed to install to the system RubyGems.
|
||||
You can cancel this installation and run:
|
||||
|
||||
bundle install --path vendor/bundle
|
||||
|
||||
to install the gems into ./vendor/bundle/, or you can enter your password
|
||||
and install the bundled gems to RubyGems using sudo.
|
||||
|
||||
Password:
|
||||
```
|
||||
|
||||
Once this is done, the `jekyll new` command should work properly for
|
||||
your user account.
|
||||
|
||||
### Jekyll & Mac OS X 10.11
|
||||
|
||||
With the introduction of System Integrity Protection, several directories
|
||||
that were previously writable are now considered system locations and are no
|
||||
longer available. Given these changes, there are a couple of simple ways to get
|
||||
up and running. One option is to change the location where the gem will be
|
||||
installed (again, using `sudo` only if necessary):
|
||||
installed (again using `sudo` only if necessary):
|
||||
|
||||
```sh
|
||||
gem install -n /usr/local/bin jekyll
|
||||
sudo gem install -n /usr/local/bin jekyll
|
||||
```
|
||||
|
||||
Alternatively, Homebrew can be installed and used to set up Ruby. This can be
|
||||
@@ -227,13 +157,13 @@ jekyll serve --baseurl '/blog'
|
||||
|
||||
… then make sure that you access the site at:
|
||||
|
||||
```
|
||||
```sh
|
||||
http://localhost:4000/blog/index.html
|
||||
```
|
||||
|
||||
It won’t work to just access:
|
||||
|
||||
```
|
||||
```sh
|
||||
http://localhost:4000/blog
|
||||
```
|
||||
|
||||
@@ -250,37 +180,10 @@ That is: defaults are overridden by options specified in `_config.yml`,
|
||||
and flags specified at the command-line will override all other settings
|
||||
specified elsewhere.
|
||||
|
||||
**Note: From v3.3.0 onward, Jekyll does not process `node_modules` and certain subdirectories within `vendor`, by default. But, by having an `exclude:` array defined explicitly in the config file overrides this default setting, which results in some users to encounter an error in building the site, with the following error message:**
|
||||
|
||||
```sh
|
||||
ERROR: YOUR SITE COULD NOT BE BUILT:
|
||||
------------------------------------
|
||||
Invalid date '<%= Time.now.strftime('%Y-%m-%d %H:%M:%S %z') %>':
|
||||
Document 'vendor/bundle/gems/jekyll-3.4.3/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb'
|
||||
does not have a valid date in the YAML front matter.
|
||||
```
|
||||
|
||||
Simply adding `vendor/bundle` to the `exclude:` list will solve this problem but will lead to having other sub-directories under `/vendor/` (and also `/node_modules/`, if present) be processed to the destination folder `_site`.
|
||||
|
||||
|
||||
The proper solution is to incorporate the default setting for `exclude:` rather than override it completely:
|
||||
|
||||
For versions upto `v3.4.3`, the `exclude:` setting must look like following:
|
||||
|
||||
```yaml
|
||||
exclude:
|
||||
- Gemfile
|
||||
- Gemfile.lock
|
||||
- node_modules
|
||||
- vendor/bundle/
|
||||
- vendor/cache/
|
||||
- vendor/gems/
|
||||
- vendor/ruby/
|
||||
- any_additional_item # any user-specific listing goes at the end
|
||||
```
|
||||
|
||||
From `v3.5` onward, `Gemfile` and `Gemfile.lock` are also excluded by default. So, in most cases there is no need to define another `exclude:` array in the config file. So an existing definition can either be modified as above, or removed completely, or simply commented out to enable easy edits in future.
|
||||
|
||||
If you encounter an error in building the site, with the error message
|
||||
"'0000-00-00-welcome-to-jekyll.markdown.erb' does not have a valid date in the
|
||||
YAML front matter." try including the line `exclude: [vendor]`
|
||||
in `_config.yml`.
|
||||
|
||||
## Markup Problems
|
||||
|
||||
@@ -290,8 +193,9 @@ problems.
|
||||
|
||||
### Liquid
|
||||
|
||||
Liquid version 2.0 seems to break the use of `{{ "{{" }}` in templates.
|
||||
Unlike previous versions, using `{{ "{{" }}` in 2.0 triggers the following error:
|
||||
The latest version, version 2.0, seems to break the use of `{{ "{{" }}` in
|
||||
templates. Unlike previous versions, using `{{ "{{" }}` in 2.0 triggers the
|
||||
following error:
|
||||
|
||||
```sh
|
||||
'{{ "{{" }}' was not properly terminated with regexp: /\}\}/ (Liquid::SyntaxError)
|
||||
@@ -315,7 +219,7 @@ The issue is caused by trying to copy a non-existing symlink.
|
||||
<div class="note">
|
||||
<h5>Please report issues you encounter!</h5>
|
||||
<p>
|
||||
If you come across a bug, please <a href="{{ site.repository }}/issues/new">create an issue</a>
|
||||
If you come across a bug, please <a href="{{ site.help_url }}/issues/new">create an issue</a>
|
||||
on GitHub describing the problem and any work-arounds you find so we can
|
||||
document it here for others.
|
||||
</p>
|
||||
|
||||
@@ -4,26 +4,7 @@ title: Upgrading
|
||||
permalink: /docs/upgrading/
|
||||
---
|
||||
|
||||
Upgrading from an older version of Jekyll? Upgrading to a new major version of
|
||||
Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following
|
||||
guides to aid your upgrade:
|
||||
Upgrading from an older version of Jekyll? Upgrading to a new major version of Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following guides to aid your upgrade:
|
||||
|
||||
- [From 0.x to 1.x and 2.x](/docs/upgrading/0-to-2/)
|
||||
- [From 2.x to 3.x](/docs/upgrading/2-to-3/)
|
||||
|
||||
## Minor updates
|
||||
|
||||
<div class="note">
|
||||
<h5>Stay Up to Date</h5>
|
||||
<p>We recommend you update Jekyll as often as possible to benefit from
|
||||
the latest bug fixes.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
If you followed our setup recommendations and installed [Bundler](http://bundler.io/), run `bundle update jekyll` or simply `bundle update` and all your gems will
|
||||
update to the latest versions.
|
||||
|
||||
If you don't have Bundler installed, run `gem update jekyll`.
|
||||
|
||||
The procedure is similar [if you use the `github-pages`
|
||||
gem](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#keeping-your-site-up-to-date-with-the-github-pages-gem).
|
||||
|
||||
@@ -9,7 +9,7 @@ and 2.0 that you'll want to know about.
|
||||
Before we dive in, go ahead and fetch the latest version of Jekyll:
|
||||
|
||||
```sh
|
||||
gem update jekyll
|
||||
$ gem update jekyll
|
||||
```
|
||||
|
||||
<div class="note feature">
|
||||
|
||||
@@ -3,21 +3,20 @@ title: Upgrading from 2.x to 3.x
|
||||
permalink: /docs/upgrading/2-to-3/
|
||||
---
|
||||
|
||||
Upgrading from an older version of Jekyll? A few things have changed in Jekyll 3
|
||||
Upgrading from an older version of Jekyll? A few things have changed in 3.0
|
||||
that you'll want to know about.
|
||||
|
||||
Before we dive in, go ahead and fetch the latest version of Jekyll:
|
||||
|
||||
```sh
|
||||
gem update jekyll
|
||||
$ gem update jekyll
|
||||
```
|
||||
|
||||
Since v3.2 Jekyll requires Ruby version >= 2.1
|
||||
{: .note .warning }
|
||||
Please note: Jekyll 3 requires Ruby version >= 2.0.0.
|
||||
|
||||
<div class="note feature">
|
||||
<h5>Diving in</h5>
|
||||
<p>Want to get a new Jekyll site up and running quickly? Simply
|
||||
<h5 markdown="1">Diving in</h5>
|
||||
<p markdown="1">Want to get a new Jekyll site up and running quickly? Simply
|
||||
run <code>jekyll new SITENAME</code> to create a new folder with a bare bones
|
||||
Jekyll site.</p>
|
||||
</div>
|
||||
@@ -44,10 +43,6 @@ For `site.collections.myCollection` in Jekyll 2, you now do:
|
||||
|
||||
This is a bit cumbersome at first, but is easier than a big `for` loop.
|
||||
|
||||
### Textile support
|
||||
|
||||
We dropped native support for Textile, from now on you have to install our [jekyll-textile-converter](https://github.com/jekyll/jekyll-textile-converter) plugin to work with Textile files.
|
||||
|
||||
### Dropped dependencies
|
||||
|
||||
We dropped a number of dependencies the Core Team felt were optional. As such, in 3.0, they must be explicitly installed and included if you use any of the features. They are:
|
||||
@@ -73,7 +68,7 @@ generate when running `jekyll build` or `jekyll serve`.
|
||||
<h5>Future Posts on GitHub Pages</h5>
|
||||
<p>
|
||||
An exception to the above rule are GitHub Pages sites, where the <code>--future</code> flag remains <em>enabled</em>
|
||||
by default to maintain historical consistency for those sites.
|
||||
by default to maintain historical consistency for those sites.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
title: Upgrading from 3.x to 4.x
|
||||
permalink: /docs/upgrading/3-to-4/
|
||||
---
|
||||
|
||||
Upgrading from an older version of Jekyll? A few things have changed in Jekyll 4
|
||||
that you'll want to know about.
|
||||
|
||||
Before we dive in, you need to have at least Ruby 2.3.0 installed. Run the following
|
||||
in your terminal to check
|
||||
|
||||
```sh
|
||||
ruby -v
|
||||
```
|
||||
|
||||
If you're using Ruby >= 2.3.0, go ahead and fetch the latest version of Jekyll:
|
||||
|
||||
```sh
|
||||
gem update jekyll
|
||||
```
|
||||
|
||||
|
||||
### Template rendering
|
||||
|
||||
We've slightly altered the way Jekyll parses and renders your various templates to improve
|
||||
the overall build times. Jekyll now parses a template once, caches it internally and then
|
||||
renders the parsed template multiple times as required by your pages and documents.
|
||||
|
||||
The downside to this is that some of the community-authored plugins may not work as they
|
||||
previously used to.
|
||||
|
||||
#### For Plugin-authors
|
||||
|
||||
* If your plugin depends on the following code: `site.liquid_renderer.file(path).parse(content)`,
|
||||
note that the return value (`template`, an instance of *`Liquid::Template`*), from that line will
|
||||
always be the **same object** for a given `path`. <br/>
|
||||
The *`template`* instance is then rendered as previously, with respect to the `payload` passed to it.
|
||||
You'll therefore have to ensure that *`payload`* is not memoized or cached in your plugin instance.
|
||||
|
||||
* If its a requirement that `template` you get from the above step *be different* at all times,
|
||||
you can invoke *`Liquid::Template`* directly:
|
||||
|
||||
|
||||
```diff
|
||||
- template = site.liquid_renderer.file(path).parse(content)
|
||||
+ template = Liquid::Template.parse(content)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
*Did we miss something? Please click "Improve this page" above and add a section. Thanks!*
|
||||
@@ -7,31 +7,22 @@ The Jekyll gem makes a `jekyll` executable available to you in your Terminal
|
||||
window. You can use this command in a number of ways:
|
||||
|
||||
```sh
|
||||
jekyll build
|
||||
$ jekyll build
|
||||
# => The current folder will be generated into ./_site
|
||||
|
||||
jekyll build --destination <destination>
|
||||
$ jekyll build --destination <destination>
|
||||
# => The current folder will be generated into <destination>
|
||||
|
||||
jekyll build --source <source> --destination <destination>
|
||||
$ jekyll build --source <source> --destination <destination>
|
||||
# => The <source> folder will be generated into <destination>
|
||||
|
||||
jekyll build --watch
|
||||
$ jekyll build --watch
|
||||
# => The current folder will be generated into ./_site,
|
||||
# watched for changes, and regenerated automatically.
|
||||
```
|
||||
|
||||
## Override default development settings
|
||||
|
||||
Default URL is set to `http://localhost:4000` in development environment. {% include docs_version_badge.html version="3.3.0" %}
|
||||
|
||||
If you want to build for your production environment:
|
||||
|
||||
- Set your production URL in `_config.yml` e.g. `url: https://example.com`.
|
||||
- Run `JEKYLL_ENV=production bundle exec jekyll build`.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Changes to <code>_config.yml</code> are not included during automatic regeneration.</h5>
|
||||
<h5>Changes to _config.yml are not included during automatic regeneration.</h5>
|
||||
<p>
|
||||
The <code>_config.yml</code> master configuration file contains global configurations
|
||||
and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
|
||||
@@ -61,24 +52,25 @@ Jekyll also comes with a built-in development server that will allow you to
|
||||
preview what the generated site will look like in your browser locally.
|
||||
|
||||
```sh
|
||||
jekyll serve
|
||||
$ jekyll serve
|
||||
# => A development server will run at http://localhost:4000/
|
||||
# Auto-regeneration: enabled. Use `--no-watch` to disable.
|
||||
|
||||
jekyll serve --livereload
|
||||
# LiveReload refreshes your browser after a change.
|
||||
|
||||
jekyll serve --incremental
|
||||
# Incremental will perform a partial build in order to reduce regeneration time.
|
||||
|
||||
jekyll serve --detach
|
||||
$ jekyll serve --detach
|
||||
# => Same as `jekyll serve` but will detach from the current terminal.
|
||||
# If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.
|
||||
# If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance.
|
||||
```
|
||||
|
||||
<div class="note info">
|
||||
<h5>Be aware of default behavior</h5>
|
||||
<p>
|
||||
As of version 2.4, the <code>serve</code> command will watch for changes automatically. To disable this, you can use <code>jekyll serve --no-watch</code>, which preserves the old behavior.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
```sh
|
||||
jekyll serve --no-watch
|
||||
$ jekyll serve --no-watch
|
||||
# => Same as `jekyll serve` but will not watch for changes.
|
||||
```
|
||||
|
||||
@@ -97,8 +89,8 @@ destination: _deploy
|
||||
Then the following two commands will be equivalent:
|
||||
|
||||
```sh
|
||||
jekyll build
|
||||
jekyll build --source _source --destination _deploy
|
||||
$ jekyll build
|
||||
$ jekyll build --source _source --destination _deploy
|
||||
```
|
||||
|
||||
For more about the possible configuration options, see the
|
||||
|
||||
@@ -124,7 +124,8 @@ following is a reference of the available data.
|
||||
|
||||
A list of all <a href="/docs/static-files/">static files</a> (i.e.
|
||||
files not processed by Jekyll's converters or the Liquid renderer).
|
||||
Each file has five properties: <code>path</code>, <code>modified_time</code>, <code>name</code>, <code>basename</code> and <code>extname</code>.
|
||||
Each file has three properties: <code>path</code>,
|
||||
<code>modified_time</code> and <code>extname</code>.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
@@ -184,32 +185,17 @@ following is a reference of the available data.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>site.url</code></p></td>
|
||||
<td><p>
|
||||
|
||||
Contains the url of your site as it is configured in the <code>_config.yml</code>.
|
||||
For example, if you have <code>url: http://mysite.com</code>
|
||||
in your configuration file, then it will be accessible in Liquid as
|
||||
<code>site.url</code>. For the development environment there is
|
||||
<a href="/news/#3-siteurl-is-set-by-the-development-server">an exception</a>,
|
||||
if you are running <code>jekyll serve</code> in a development environment
|
||||
<code>site.url</code> will be set to the value of <code>host</code>,
|
||||
<code>port</code>, and SSL-related options. This defaults to
|
||||
<code>url: http://localhost:4000</code>.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><p><code>site.[CONFIGURATION_DATA]</code></p></td>
|
||||
<td><p>
|
||||
|
||||
All the variables set via the command line and your
|
||||
<code>_config.yml</code> are available through the <code>site</code>
|
||||
variable. For example, if you have <code>foo: bar</code>
|
||||
in your configuration file, then it will be accessible in Liquid as <code>site.foo</code>.
|
||||
Jekyll does not parse changes to <code>_config.yml</code> in
|
||||
<code>watch</code> mode, you must restart Jekyll to see changes to variables.
|
||||
variable. For example, if you have <code>url: http://mysite.com</code>
|
||||
in your configuration file, then in your Posts and Pages it will be
|
||||
stored in <code>site.url</code>. Jekyll does not parse changes to
|
||||
<code>_config.yml</code> in <code>watch</code> mode, you must restart
|
||||
Jekyll to see changes to variables.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
@@ -249,7 +235,7 @@ following is a reference of the available data.
|
||||
<td><p><code>page.excerpt</code></p></td>
|
||||
<td><p>
|
||||
|
||||
The un-rendered excerpt of a document.
|
||||
The un-rendered excerpt of the Page.
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
@@ -279,9 +265,8 @@ following is a reference of the available data.
|
||||
<td><p><code>page.id</code></p></td>
|
||||
<td><p>
|
||||
|
||||
An identifier unique to a document in a Collection or a Post (useful in RSS feeds). e.g.
|
||||
An identifier unique to the Post (useful in RSS feeds). e.g.
|
||||
<code>/2008/12/14/my-post</code>
|
||||
<code>/my-collection/my-document</code>
|
||||
|
||||
</p></td>
|
||||
</tr>
|
||||
|
||||
@@ -3,48 +3,46 @@ title: Jekyll on Windows
|
||||
permalink: /docs/windows/
|
||||
---
|
||||
|
||||
While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users.
|
||||
While Windows is not an officially-supported platform, it can be used to run
|
||||
Jekyll with the proper tweaks. This page aims to collect some of the general
|
||||
knowledge and lessons that have been unearthed by Windows users.
|
||||
|
||||
## Installation
|
||||
|
||||
## Installing Jekyll
|
||||
The easiest way to run Jekyll is by using the [RubyInstaller][] for Windows.
|
||||
A quick way to install Jekyll is to follow the [installation instructions by David Burela](https://davidburela.wordpress.com/2015/11/28/easily-install-jekyll-on-windows-with-3-command-prompt-entries-and-chocolatey/):
|
||||
|
||||
### Installation via RubyInstaller
|
||||
1. Install a package manager for Windows called [Chocolatey](https://chocolatey.org/install)
|
||||
2. Install Ruby via Chocolatey: `choco install ruby -y`
|
||||
3. Reopen a command prompt and install Jekyll: `gem install jekyll`
|
||||
|
||||
[RubyInstaller][] is a self-contained Windows-based installer that includes the Ruby language, an execution environment, important documentation, and more.
|
||||
We only cover RubyInstaller-2.4 and newer here, older versions need to [install the Devkit][Devkit-install] manually.
|
||||
Updates in the infrastructure of Ruby may cause SSL errors when attempting to use `gem install` with versions of the RubyGems package older than 2.6. (The RubyGems package installed via the Chocolatey tool is version 2.3) If you have installed an older version, you can update the RubyGems package using the directions [here][ssl-certificate-update].
|
||||
|
||||
1. Download and Install a **Ruby+Devkit** version from [RubyInstaller Downloads][RubyInstaller-downloads].
|
||||
Use default options for installation.
|
||||
2. Open a new command prompt window from the start menu, so that changes to the `PATH` environment variable becomes effective.
|
||||
Install Jekyll and Bundler via: `gem install jekyll bundler`
|
||||
3. Check if Jekyll installed properly: `jekyll -v`
|
||||
[ssl-certificate-update]: http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages
|
||||
|
||||
That's it, you're ready to install our [default minimal blog theme](https://github.com/jekyll/minima) with `jekyll new jekyll-website`.
|
||||
For a more conventional way of installing Jekyll you can follow this [complete guide to install Jekyll 3 on Windows by Sverrir Sigmundarson][windows-installjekyll3].
|
||||
|
||||
[RubyInstaller]: https://rubyinstaller.org/
|
||||
[RubyInstaller-downloads]: https://rubyinstaller.org/downloads/
|
||||
[Devkit-install]: https://github.com/oneclick/rubyinstaller/wiki/Development-Kit
|
||||
[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/
|
||||
|
||||
## Encoding
|
||||
|
||||
### Encoding
|
||||
If you use UTF-8 encoding, make sure that no `BOM` header
|
||||
characters exist in your files or very, very bad things will happen to
|
||||
Jekyll. This is especially relevant if you're running Jekyll on Windows.
|
||||
|
||||
If you use UTF-8 encoding, make sure that no `BOM` header characters exist in your files or very, very bad things will happen to
|
||||
Jekyll. This is especially relevant when you're running Jekyll on Windows.
|
||||
|
||||
Additionally, you might need to change the code page of the console window to UTF-8 in case you get a "Liquid Exception: Incompatible character encoding" error during the site generation process. It can be done with the following command:
|
||||
Additionally, you might need to change the code page of the console window to UTF-8
|
||||
in case you get a "Liquid Exception: Incompatible character encoding" error during
|
||||
the site generation process. It can be done with the following command:
|
||||
|
||||
```sh
|
||||
chcp 65001
|
||||
$ chcp 65001
|
||||
```
|
||||
|
||||
|
||||
### Time-Zone Management
|
||||
## Timezone Management
|
||||
|
||||
Since Windows doesn't have a native source of zoneinfo data, the Ruby Interpreter would not understand IANA Timezones and hence using them had the `TZ` environment variable default to UTC/GMT 00:00.
|
||||
Though Windows users could alternatively define their blog's timezone by setting the key to use POSIX format of defining timezones, it wasn't as user-friendly when it came to having the clock altered to changing DST-rules.
|
||||
|
||||
Jekyll now uses a rubygem to internally configure Timezone based on established [IANA Timezone Database][IANA-database].
|
||||
Jekyll now uses a rubygem to internally configure Timezone based on established [IANA Timezone Database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
||||
While 'new' blogs created with Jekyll v3.4 and greater, will have the following added to their 'Gemfile' by default, existing sites *will* have to update their 'Gemfile' (and installed) to enable development on Windows:
|
||||
|
||||
```ruby
|
||||
@@ -52,87 +50,84 @@ While 'new' blogs created with Jekyll v3.4 and greater, will have the following
|
||||
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
|
||||
```
|
||||
|
||||
[IANA-database]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
## Auto-regeneration
|
||||
|
||||
### Auto Regeneration
|
||||
|
||||
Jekyll uses the `listen` gem to watch for changes when the `--watch` switch is specified during a build or serve. While `listen` has built-in support for UNIX systems, it may require an extra gem for compatibility with Windows.
|
||||
|
||||
Add the following to the Gemfile for your site if you have issues with auto-regeneration on Windows alone:
|
||||
As of v1.3.0, Jekyll uses the `listen` gem to watch for changes when the
|
||||
`--watch` switch is specified during a build or serve. While `listen` has
|
||||
built-in support for UNIX systems, it requires an extra gem for compatibility
|
||||
with Windows. Add the following to the Gemfile for your site:
|
||||
|
||||
```ruby
|
||||
gem 'wdm', '~> 0.1.1' if Gem.win_platform?
|
||||
gem 'wdm', '~> 0.1.0' if Gem.win_platform?
|
||||
```
|
||||
|
||||
You have to use a [Ruby+Devkit](https://rubyinstaller.org/downloads/) version of the RubyInstaller.
|
||||
### How to install github-pages
|
||||
|
||||
This section is part of an article written by [Jens Willmer][jwillmerPost]. To follow the instructions you need to have [Chocolatey][] installed on your system. If you already have a version of Ruby installed you need to uninstall it before you can continue.
|
||||
|
||||
#### Install Ruby and Ruby development kit
|
||||
|
||||
Open a command prompt and execute the following commands:
|
||||
|
||||
* `choco install ruby -version 2.2.4`
|
||||
* `choco install ruby2.devkit` - _needed for compilation of json gem_
|
||||
|
||||
#### Configure Ruby development kit
|
||||
|
||||
The development kit did not set the environment path for Ruby so we need to do it.
|
||||
|
||||
* Open command prompt in `C:\tools\DevKit2`
|
||||
* Execute `ruby dk.rb init` to create a file called `config.yml`
|
||||
* Edit the `config.yml` file and include the path to Ruby `- C:/tools/ruby22`
|
||||
* Execute the following command to set the path: `ruby dk.rb install`
|
||||
|
||||
#### Nokogiri gem installation
|
||||
|
||||
This gem is also needed in the github-pages and to get it running on Windows x64 we have to install a few things.
|
||||
|
||||
|
||||
## Installation via Bash on Windows 10
|
||||
|
||||
If you are using Windows 10 version 1607 or later, another option to run Jekyll is by [installing][WSL-Guide] the Windows Subsystem for Linux.
|
||||
**Note:** In the current [pre release][nokogiriFails] it works out of the box with Windows x64 but this version is not referenced in the github-pages.
|
||||
|
||||
|
||||
*Note:* You must have [Windows Subsystem for Linux][BASH-WSL] enabled.
|
||||
`choco install libxml2 -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
|
||||
|
||||
First let's make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:
|
||||
`choco install libxslt -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
|
||||
|
||||
```sh
|
||||
bash
|
||||
```
|
||||
Your Command Prompt instance should now be a Bash instance. Now we must update our repo lists and packages.
|
||||
`choco install libiconv -Source "https://www.nuget.org/api/v2/"`{:.language-ruby}
|
||||
|
||||
```sh
|
||||
sudo apt-get update -y && sudo apt-get upgrade -y
|
||||
```
|
||||
Now we can install Ruby. To do this we will use a repository from [BrightBox](https://www.brightbox.com/docs/ruby/ubuntu/), which hosts optimized versions of Ruby for Ubuntu.
|
||||
|
||||
```sh
|
||||
sudo apt-add-repository ppa:brightbox/ruby-ng
|
||||
sudo apt-get update
|
||||
sudo apt-get install ruby2.4 ruby2.4-dev build-essential dh-autoreconf
|
||||
```ruby
|
||||
gem install nokogiri --^
|
||||
--with-xml2-include=C:\Chocolatey\lib\libxml2.2.7.8.7\build\native\include^
|
||||
--with-xml2-lib=C:\Chocolatey\lib\libxml2.redist.2.7.8.7\build\native\bin\v110\x64\Release\dynamic\cdecl^
|
||||
--with-iconv-include=C:\Chocolatey\lib\libiconv.1.14.0.11\build\native\include^
|
||||
--with-iconv-lib=C:\Chocolatey\lib\libiconv.redist.1.14.0.11\build\native\bin\v110\x64\Release\dynamic\cdecl^
|
||||
--with-xslt-include=C:\Chocolatey\lib\libxslt.1.1.28.0\build\native\include^
|
||||
--with-xslt-lib=C:\Chocolatey\lib\libxslt.redist.1.1.28.0\build\native\bin\v110\x64\Release\dynamic
|
||||
```
|
||||
|
||||
Next let's update our Ruby gems:
|
||||
#### Install github-pages
|
||||
|
||||
```sh
|
||||
sudo gem update
|
||||
* Open command prompt and install [Bundler][]: `gem install bundler`
|
||||
* Create a file called `Gemfile` without any extension in your root directory of your blog
|
||||
* Copy & paste the two lines into the file:
|
||||
|
||||
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
gem 'github-pages', group: :jekyll_plugins
|
||||
```
|
||||
|
||||
Now all that is left to do is install Jekyll.
|
||||
* **Note:** We use an unsecure connection because SSL throws exceptions in the version of Ruby
|
||||
* Open a command prompt, target your local blog repository root, and install github-pages: `bundle install`
|
||||
|
||||
```sh
|
||||
sudo gem install jekyll bundler
|
||||
```
|
||||
|
||||
Check if Jekyll installed properly by running:
|
||||
After this process you should have github-pages installed on your system and you can host your blog again with `jekyll s`. \\
|
||||
There will be a warning on startup that you should include `gem 'wdm', '>= 0.1.0' if Gem.win_platform?` to your `Gemfile` but I could not get `jekyll s` working if I include that line so for the moment I ignore that warning.
|
||||
|
||||
```sh
|
||||
jekyll -v
|
||||
```
|
||||
|
||||
Configure the bundler/gem path so bundle doesn't prompt for sudo
|
||||
|
||||
```sh
|
||||
bundle config path vendor/bundle
|
||||
```
|
||||
|
||||
**And that's it!**
|
||||
|
||||
To start a new project named `my_blog`, just run:
|
||||
|
||||
```sh
|
||||
jekyll new my_blog
|
||||
```
|
||||
|
||||
You can make sure time management is working properly by inspecting your `_posts` folder. You should see a markdown file with the current date in the filename.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Non-superuser account issues</h5>
|
||||
<p>If the `jekyll new` command prints the error "Your user account isn't allowed to install to the system RubyGems", see the "Running Jekyll as Non-Superuser" instructions in <a href="/docs/troubleshooting/#no-sudo">Troubleshooting</a>.</p>
|
||||
</div>
|
||||
|
||||
**Note:** Bash on Ubuntu on Windows is still under development, so you may run into issues.
|
||||
|
||||
[WSL-Guide]: https://msdn.microsoft.com/en-us/commandline/wsl/install_guide
|
||||
[BASH-WSL]: https://msdn.microsoft.com/en-us/commandline/wsl/about
|
||||
In the future the installation process of the github-pages should be as simple as the setup of the blog. But as long as the new version of the Nokogiri ([v1.6.8][nokogiriReleases]) is not stable and referenced, it is work to get it up and running on Windows.
|
||||
|
||||
[jwillmerPost]: https://jwillmer.de/blog/tutorial/how-to-install-jekyll-and-pages-gem-on-windows-10-x46 "Installation instructions by Jens Willmer"
|
||||
[Chocolatey]: https://chocolatey.org/install "Package manager for Windows"
|
||||
[Bundler]: http://bundler.io/ "Ruby Dependencie Manager"
|
||||
[nokogiriReleases]: https://github.com/sparklemotion/nokogiri/releases "Nokogiri Releases"
|
||||
[nokogiriFails]: https://github.com/sparklemotion/nokogiri/issues/1456#issuecomment-206481794 "Nokogiri fails to install on Ruby 2.3 for Windows"
|
||||
|
||||
@@ -1,9 +1,26 @@
|
||||
{% if site.gauges_id %}
|
||||
<!-- Gauges (http://get.gaug.es/) -->
|
||||
<script>
|
||||
var _gauges = _gauges || [];
|
||||
(function() {
|
||||
var t = document.createElement('script');
|
||||
t.type = 'text/javascript';
|
||||
t.async = true;
|
||||
t.id = 'gauges-tracker';
|
||||
t.setAttribute('data-site-id', '{{ site.gauges_id }}');
|
||||
t.src = '//secure.gaug.es/track.js';
|
||||
var s = document.getElementsByTagName('script')[0];
|
||||
s.parentNode.insertBefore(t, s);
|
||||
})();
|
||||
</script>
|
||||
{% endif %}
|
||||
|
||||
{% if site.google_analytics_id %}
|
||||
<!-- Google Analytics (https://www.google.com/analytics) -->
|
||||
<script>
|
||||
!function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
|
||||
(j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
|
||||
L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
|
||||
L=e.getElementsByTagName(k)[0],l.src='//www.google-analytics.com/analytics.js',
|
||||
L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
|
||||
|
||||
ga('create', '{{ site.google_analytics_id }}', 'jekyllrb.com');
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
<span class="version-badge" title="This feature is available starting version {{ include.version }}">{{ include.version }}</span>
|
||||
@@ -11,15 +11,5 @@
|
||||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<div class="unit two-thirds align-right center-on-mobiles">
|
||||
<p>
|
||||
Sponsored by
|
||||
{% for sponsor in site.data.sponsors %}
|
||||
<a href="{{ sponsor.url }}" style="margin-left: 10px;">
|
||||
<img src="{{ sponsor.image }}" height="{{ sponsor.height }}" width="{{ sponsor.width }}" alt="{{ sponsor.name }}">
|
||||
</a>
|
||||
{% endfor %}
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
@@ -1,31 +1,18 @@
|
||||
<header>
|
||||
<div class="flexbox">
|
||||
<div class="center-on-mobiles">
|
||||
<nav class="mobile-nav show-on-mobiles">
|
||||
{% include primary-nav-items.html %}
|
||||
</nav>
|
||||
<div class="grid">
|
||||
<div class="unit one-third center-on-mobiles">
|
||||
<h1>
|
||||
<a href="/" class="logo">
|
||||
<a href="/">
|
||||
<span class="sr-only">Jekyll</span>
|
||||
<img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
|
||||
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
|
||||
</a>
|
||||
</h1>
|
||||
</div>
|
||||
<nav class="main-nav hide-on-mobiles">
|
||||
<nav class="main-nav unit two-thirds hide-on-mobiles">
|
||||
{% include primary-nav-items.html %}
|
||||
</nav>
|
||||
<div class="search hide-on-mobiles">
|
||||
{% include search/input.html %}
|
||||
</div>
|
||||
<div class="meta hide-on-mobiles">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ site.repository }}/releases/tag/v{{ site.version }}">v{{ site.version }}</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ site.repository }}">GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<nav class="mobile-nav show-on-mobiles">
|
||||
{% include mobile-nav-items.html %}
|
||||
</nav>
|
||||
</header>
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
<ul>
|
||||
<li class="{% if page.overview %}current{% endif %}">
|
||||
<a href="/">Home</a>
|
||||
</li>
|
||||
<li class="{% if page.url contains '/docs/' %}current{% endif %}">
|
||||
<a href="/docs/home/">Docs</a>
|
||||
</li>
|
||||
<li class="{% if page.author %}current{% endif %}">
|
||||
<a href="/news/">News</a>
|
||||
</li>
|
||||
<li class="{% if page.url contains '/help/' %}current{% endif %}">
|
||||
<a href="/help/">Help</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ site.repository }}">GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -13,10 +13,10 @@
|
||||
<span class="post-date">
|
||||
{{ post.date | date_to_string }}
|
||||
</span>
|
||||
{% assign author = post.author %}
|
||||
<a href="https://github.com/{{ author }}" class="post-author">
|
||||
<a href="https://github.com/{{ post.author }}" class="post-author">
|
||||
{% assign author = post.author %}
|
||||
{% avatar user=author size=24 %}
|
||||
{{ author }}
|
||||
{{ post.author }}
|
||||
</a>
|
||||
</div>
|
||||
<div class="post-content">
|
||||
|
||||
@@ -8,7 +8,13 @@
|
||||
<li class="{% if page.author %}current{% endif %}">
|
||||
<a href="/news/">News</a>
|
||||
</li>
|
||||
<li class="{% if page.url contains '/community/' %}current{% endif %}">
|
||||
<a href="/community/">Community</a>
|
||||
</li>
|
||||
<li class="{% if page.url contains '/help/' %}current{% endif %}">
|
||||
<a href="/help/">Help</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ site.repository }}"><span class="hide-on-mobiles">View on </span>GitHub</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
<input type="text" id="docsearch-input" placeholder="Search the docs…">
|
||||
@@ -1,9 +0,0 @@
|
||||
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
|
||||
<script type="text/javascript"> docsearch({
|
||||
apiKey: '50fe39c839958dfad797000f33e2ec17',
|
||||
indexName: 'jekyllrb',
|
||||
inputSelector: '#docsearch-input',
|
||||
enhancedSearchInput: true,
|
||||
debug: false // Set debug to true if you want to inspect the dropdown
|
||||
});
|
||||
</script>
|
||||
@@ -1,39 +0,0 @@
|
||||
{% comment %}
|
||||
Map grabs the tutorials sections, giving us an array of arrays. Join, flattens all
|
||||
the items to a comma delimited string. Split turns it into an array again.
|
||||
{% endcomment %}
|
||||
{% assign tutorials = site.data.tutorials | map: 'tutorials' | join: ',' | split: ',' %}
|
||||
|
||||
{% comment %}
|
||||
Because this is built for every page, lets find where we are in the ordered
|
||||
document list by comparing url strings. Then if there's something previous or
|
||||
next, lets build a link to it.
|
||||
{% endcomment %}
|
||||
|
||||
{% for tutorial in tutorials %}
|
||||
{% assign tutorial_url = tutorial | prepend:"/tutorials/" | append:"/" %}
|
||||
{% if tutorial_url == page.url %}
|
||||
<div class="section-nav">
|
||||
<div class="left align-right">
|
||||
{% if forloop.first %}
|
||||
<span class="prev disabled">Back</span>
|
||||
{% else %}
|
||||
{% assign previous = forloop.index0 | minus: 1 %}
|
||||
{% assign previous_page = tutorials[previous] | prepend:"/tutorials/" | append:"/" %}
|
||||
<a href="{{ previous_page }}" class="prev">Back</a>
|
||||
{% endif %}
|
||||
</div>
|
||||
<div class="right align-left">
|
||||
{% if forloop.last %}
|
||||
<span class="next disabled">Next</span>
|
||||
{% else %}
|
||||
{% assign next = forloop.index0 | plus: 1 %}
|
||||
{% assign next_page = tutorials[next] | prepend:"/tutorials/" | append:"/" %}
|
||||
<a href="{{ next_page }}" class="next">Next</a>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
<div class="clear"></div>
|
||||
{% break %}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
@@ -6,9 +6,7 @@
|
||||
<meta name="generator" content="Jekyll v{{ jekyll.version }}">
|
||||
{% feed_meta %}
|
||||
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="{{ site.repository }}/commits/master.atom">
|
||||
<link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
|
||||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
|
||||
<link rel="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
|
||||
<link rel="stylesheet" href="/css/screen.css">
|
||||
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
||||
{% seo %}
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
<div class="unit one-fifth hide-on-mobiles">
|
||||
<aside>
|
||||
{% for section in site.data.tutorials %}
|
||||
<h4>{{ section.title }}</h4>
|
||||
|
||||
{% include tutorials_ul.html items=section.tutorials %}
|
||||
|
||||
{% endfor %}
|
||||
</aside>
|
||||
</div>
|
||||
@@ -1,10 +0,0 @@
|
||||
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
||||
<select onchange="if (this.value) window.location.href=this.value">
|
||||
<option value="">Navigate the tutorials…</option>
|
||||
{% for section in site.data.tutorials %}
|
||||
<optgroup label="{{ section.title }}">
|
||||
{% include tutorials_option.html items=section.tutorials %}
|
||||
</optgroup>
|
||||
{% endfor %}
|
||||
</select>
|
||||
</div>
|
||||
@@ -1,5 +0,0 @@
|
||||
{% for item in include.items %}
|
||||
{% assign item_url = item | prepend:"/tutorials/" | append:"/" %}
|
||||
{% assign tutorial = site.tutorials | where: "url", item_url | first %}
|
||||
<option value="{{ tutorial.url }}">{{ tutorial.title }}</option>
|
||||
{% endfor %}
|
||||
@@ -1,7 +0,0 @@
|
||||
<ul>
|
||||
{% for item in include.items %}
|
||||
{% assign item_url = item | prepend:"/tutorials/" | append:"/" %}
|
||||
{% assign p = site.tutorials | where:"url", item_url | first %}
|
||||
<li class="{% if item_url == page.url %}current{% endif %}"><a href="{{ p.url }}">{{ p.title }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
@@ -8,6 +8,6 @@
|
||||
{% include footer.html %}
|
||||
{% include anchor_links.html %}
|
||||
{% include analytics.html %}
|
||||
{% include search/script.html %}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -5,10 +5,7 @@ layout: news
|
||||
<article>
|
||||
<h2>
|
||||
{{ page.title }}
|
||||
<a href="{{ page.url }}" class="header-link" title="Permalink">
|
||||
<span class="sr-only">Permalink</span>
|
||||
<i class="fa fa-link"></i>
|
||||
</a>
|
||||
<a href="{{ page.url }}" class="permalink" title="Permalink">∞</a>
|
||||
</h2>
|
||||
<span class="post-category">
|
||||
<span class="label">
|
||||
@@ -19,10 +16,9 @@ layout: news
|
||||
<span class="post-date">
|
||||
{{ page.date | date_to_string }}
|
||||
</span>
|
||||
{% assign author = page.author %}
|
||||
<a href="https://github.com/{{ author }}" class="post-author">
|
||||
{% avatar user=author size=24 %}
|
||||
{{ author }}
|
||||
<a href="https://github.com/{{ page.author }}" class="post-author">
|
||||
{% avatar {{ page.author}} size=24 %}
|
||||
{{ page.author }}
|
||||
</a>
|
||||
</div>
|
||||
<div class="post-content">
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
---
|
||||
layout: default
|
||||
---
|
||||
|
||||
<section class="docs">
|
||||
<div class="grid">
|
||||
|
||||
{% include tutorials_contents_mobile.html %}
|
||||
|
||||
<div class="unit four-fifths">
|
||||
<article>
|
||||
<div class="improve right hide-on-mobiles">
|
||||
<a href="https://github.com/jekyll/jekyll/edit/master/docs/{{ page.path }}"><i
|
||||
class="fa fa-pencil"></i> Improve this page</a>
|
||||
</div>
|
||||
<h1>{{ page.title }}</h1>
|
||||
{{ content }}
|
||||
{% include section_nav_tutorials.html %}
|
||||
</article>
|
||||
</div>
|
||||
|
||||
{% include tutorials_contents.html %}
|
||||
|
||||
<div class="clear"></div>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
@@ -6,18 +6,25 @@ version: 1.1.1
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Coming just 10 days after the release of v1.1.0, v1.1.1 is out with a patch for
|
||||
the nasty excerpt inception bug ([#1339]({{ site.repository }}/issues/1339)) and
|
||||
non-zero exit codes for invalid commands ([#1338]({{ site.repository
|
||||
}}/issues/1338)).
|
||||
|
||||
To all those affected by the [strange excerpt bug in v1.1.0]({{ site.repository
|
||||
}}/issues/1321), I'm sorry. I think we have it all patched up and it should be
|
||||
deployed to [GitHub Pages](https://pages.github.com/) in the next couple weeks.
|
||||
Thank you for your patience!
|
||||
Coming just 10 days after the release of v1.1.0, v1.1.1 is out with a patch for the nasty
|
||||
excerpt inception bug ([#1339][]) and non-zero exit codes for invalid commands
|
||||
([#1338][]).
|
||||
|
||||
If you're checking out v1.1.x for the first time, definitely check out [what
|
||||
shipped with v1.1.0!]({{ site.repository }}/releases/tag/v1.1.0)
|
||||
To all those affected by the [strange excerpt bug in v1.1.0][#1321], I'm sorry. I think we
|
||||
have it all patched up and it should be deployed to [GitHub Pages][gh_pages] in the next
|
||||
couple weeks. Thank you for your patience!
|
||||
|
||||
See the [GitHub Release]({{ site.repository }}/releases/tag/v1.1.1) page for
|
||||
more a more detailed changelog for this release.
|
||||
If you're checking out v1.1.x for the first time, definitely check out [what shipped with
|
||||
v1.1.0!][v1_1_0]
|
||||
|
||||
See the [GitHub Release][] page for more a more detailed changelog for this release.
|
||||
|
||||
{% assign issue_numbers = "1339|1338|1321" | split: "|" %}
|
||||
{% for issue in issue_numbers %}
|
||||
[#{{ issue }}]: {{ site.repository }}/issues/{{ issue }}
|
||||
{% endfor %}
|
||||
|
||||
[GitHub Release]: {{ site.repository }}/releases/tag/v1.1.1
|
||||
[gh_pages]: https://pages.github.com/
|
||||
[v1_1_0]: {{ site.repository }}/releases/tag/v1.1.0
|
||||
|
||||
@@ -5,7 +5,7 @@ author: parkr
|
||||
categories: [partners]
|
||||
---
|
||||
|
||||

|
||||

|
||||
|
||||
You may have heard that [@cobyism](https://github.com/cobyism)'s excellent
|
||||
Jekyll logo has been made into a sticker. You may have sat idly by, wishing
|
||||
|
||||
@@ -10,7 +10,7 @@ Happy Holidays, everyone.
|
||||
|
||||
Jekyll v2.5.3 is a quick patch release, containing some minor fixes. See the
|
||||
[full history](/docs/history/) for more info. If you notice any problems,
|
||||
please [let us know]({{ site.repository }}).
|
||||
please [let us know]({{ site.help_url }}).
|
||||
|
||||
This release also marks the start of Jekyll 3 development. I wrote about it
|
||||
over on my personal blog: [Jekyll 3 — The Road Ahead](https://byparker.com/blog/2014/jekyll-3-the-road-ahead/).
|
||||
|
||||
@@ -22,7 +22,7 @@ Some other notable changes:
|
||||
- Explicit support for Ruby 2.0.x was dropped
|
||||
- Added an `:after_init` Hook
|
||||
- Added a `where_exp` filter to provide more powerful filtering
|
||||
- Added a `link` liquid tag which can be used to generate URLs for any
|
||||
- Added a `link` liquid tag which can be used to generate URL's for any
|
||||
post or document based on its path relative to the site source
|
||||
- ... and lots more!
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ By default, `baseurl` is set to `""` and therefore yields (never set to
|
||||
|
||||
A result of `relative_url` will safely always produce a URL which is
|
||||
relative to the domain root. A similar principle applies to `absolute_url`.
|
||||
It prepends your `baseurl` and `url` values, making absolute URLs all the
|
||||
It prepends your `baseurl` and `url` values, making absolute URL's all the
|
||||
easier to make:
|
||||
|
||||
{% highlight liquid %}
|
||||
|
||||
@@ -10,8 +10,8 @@ Hey there! We have a quick update of Jekyll for you to enjoy this January.
|
||||
Packed full of bug fixes as usual, thanks to the tireless efforts of our
|
||||
exceptional Jekyll community. Three changes to call out:
|
||||
|
||||
1. If you're a big fan of [`where_by_exp`](/docs/templates/#filters), you'll be an
|
||||
even bigger fan of [`group_by_exp`](/docs/templates/#filters).
|
||||
1. If you're a big fan of [`where_by_exp`](/docs/filters/), you'll be an
|
||||
even bigger fan of [`group_by_exp`](/docs/filters/).
|
||||
2. Using a custom timezone in Jekyll on Windows? Yeah, sorry that hasn't ever worked
|
||||
properly. We made it possible to accurately [set the timezone using IANA
|
||||
timezone codes](https://jekyllrb.com/docs/windows/#timezone-management).
|
||||
|
||||
@@ -1,106 +0,0 @@
|
||||
---
|
||||
title: 'Jekyll 3.4.1, or "Unintended Consequences"'
|
||||
date: 2017-03-02 14:20:26 -0500
|
||||
author: parkr
|
||||
version: 3.4.1
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Conformity is a confounding thing.
|
||||
|
||||
We write tests to ensure that a piece of functionality that works today
|
||||
will work tomorrow, as further modifications are made to the codebase. This
|
||||
is a principle of modern software development: every change must have a
|
||||
test to guard against regressions to the functionality implemented by that
|
||||
change.
|
||||
|
||||
And yet, occasionally, our very best efforts to test functionality will be
|
||||
thwarted. This is because of how our code produces unintended
|
||||
functionality, which naturally goes untested.
|
||||
|
||||
In our documentation, we tell users to name their posts with the following
|
||||
format:
|
||||
|
||||
```text
|
||||
YYYY-MM-DD-title.extension
|
||||
```
|
||||
|
||||
That format specifies exactly four numbers for the year, e.g. 2017, two
|
||||
letters for the month, e.g. 03, and two letters for the day, e.g. 02. To
|
||||
match this, we had the following regular expression:
|
||||
|
||||
```ruby
|
||||
%r!^(?:.+/)*(\d+-\d+-\d+)-(.*)(\.[^.]+)$!
|
||||
```
|
||||
|
||||
You might already see the punchline. While our documentation specifies the
|
||||
exact number of numbers that is required for each section of the date, our
|
||||
regular expression does not enforce this precision. What happens if a user
|
||||
doesn't conform to our documentation?
|
||||
|
||||
We recently [received a bug report](https://github.com/jekyll/jekyll/issues/5603)
|
||||
that detailed how the following file was considered a post:
|
||||
|
||||
```text
|
||||
84093135-42842323-42000001-b890-136270f7e5f1.md
|
||||
```
|
||||
|
||||
Of course! It matches the above regular expression, but doesn't satisfy
|
||||
other requirements about those numbers being a valid date (unless you're
|
||||
living in a world that has 43 million months, and 42 million (and one)
|
||||
days). So, we [modified the regular expression to match our
|
||||
documentation](https://github.com/jekyll/jekyll/pull/5609):
|
||||
|
||||
```ruby
|
||||
%r!^(?:.+/)*(\d{4}-\d{2}-\d{2})-(.*)(\.[^.]+)$!
|
||||
```
|
||||
|
||||
Our tests all passed and we were properly excluding this crazy date with 43
|
||||
million months and days. This change shipped in Jekyll v3.4.0 and all was
|
||||
well.
|
||||
|
||||
Well, not so much.
|
||||
|
||||
A very common way to specify the month of February is `2`. This is true for
|
||||
all single-digit months and days of the month. Notice anything about our
|
||||
first regular expression versus our second? The second regular expression
|
||||
imposes a **minimum**, as well as maximum, number of digits. This change
|
||||
made Jekyll ignore dates with single-digit days and months.
|
||||
|
||||
The first eight years of Jekyll's existence had allowed single-digit days
|
||||
and months due to an imprecise regular expression. For some people, their
|
||||
entire blog was missing, and there were no errors that told them why.
|
||||
|
||||
After receiving a few bug reports, it became clear what had happened.
|
||||
Unintended functionality of the last eight years had been broken. Thus,
|
||||
v3.4.0 was broken for a non-negligible number of sites. With a test site
|
||||
in-hand from @andrewbanchich, I tracked it down to this regular expression
|
||||
and [reintroduced](https://github.com/jekyll/jekyll/pull/5920) a proper
|
||||
minimum number of digits for each segment:
|
||||
|
||||
```ruby
|
||||
%r!^(?:.+/)*(\d{2,4}-\d{1,2}-\d{1,2})-(.*)(\.[^.]+)$!
|
||||
```
|
||||
|
||||
And, I wrote a test.
|
||||
|
||||
This change was quickly backported to v3.4.0 and here we are: releasing
|
||||
v3.4.1. It will fix the problem for all users who were using single-digit
|
||||
months and days.
|
||||
|
||||
With this, I encourage all of you to look at your code for *unintended*
|
||||
functionality and make a judgement call: if it's allowed, *should it be*?
|
||||
If it should be allowed, make it *intended* functionality and test it! I
|
||||
know I'll be looking at my code with much greater scrutiny going forward,
|
||||
looking for unintended consequences.
|
||||
|
||||
Many thanks to our Jekyll affinity team captains who helped out, including
|
||||
@pathawks, @pnn, and @DirtyF. Thanks, too, to @ashmaroli for reviewing my
|
||||
change with an eye for consistency and precision. This was certainly a team
|
||||
effort.
|
||||
|
||||
We hope Jekyll v3.4.1 brings your variable-digit dates back to their
|
||||
previous glory. We certainly won't let that unintended functionality be
|
||||
unintended any longer.
|
||||
|
||||
As always, Happy Jekylling!
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
title: 'Jekyll 3.4.2 Released'
|
||||
date: 2017-03-09 15:41:57 -0500
|
||||
author: parkr
|
||||
version: 3.4.2
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Another one-PR patch update, though without the same [lessons as for the
|
||||
previous release]({% link _posts/2017-03-02-jekyll-3-4-1-released.markdown %}).
|
||||
|
||||
This release includes a beneficial change for a number of plugins:
|
||||
**static files now respect front matter defaults**.
|
||||
|
||||
You might be asking yourself: "why would static files, files that are
|
||||
static files explicitly because they *don't* have YAML front matter, want
|
||||
to respect YAML front matter?" That's a great question. Let me illustrate
|
||||
with an example.
|
||||
|
||||
Let's look at `jekyll-sitemap`. This plugin generates a list of documents,
|
||||
pages, and static files, and some metadata for them in an XML file for a
|
||||
Google/Yahoo/Bing/DuckDuckGo crawler to consume. If you don't want a given
|
||||
file in this list, you set `sitemap: false` in the YAML front matter. But
|
||||
what about static files, which don't have YAML front matter? Before this
|
||||
release, they could not be excluded because they had no properties in YAML
|
||||
other than [the ones we explicitly assigned](https://github.com/jekyll/jekyll/blob/v3.4.1/lib/jekyll/static_file.rb#L98-L106).
|
||||
So if you had a PDF you didn't want to be in your sitemap, you couldn't use
|
||||
`jekyll-sitemap`.
|
||||
|
||||
With this release, you can now set [front matter
|
||||
defaults](/docs/configuration/#front-matter-defaults) for static files:
|
||||
|
||||
```yaml
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
path: "pdfs/"
|
||||
values:
|
||||
sitemap: false
|
||||
```
|
||||
|
||||
Now, for every file in the Liquid `site.static_files` loop which is in the
|
||||
folder `pdfs/`, you'll see `sitemap` equal to `false`.
|
||||
|
||||
Many thanks to @benbalter for coming up with the solution and ensuring
|
||||
sitemaps everywhere are filled with just the right content.
|
||||
|
||||
As always, if you notice any bugs, please search the issues and file one if
|
||||
you can't find another related to your issue.
|
||||
|
||||
Happy Jekylling!
|
||||
@@ -1,49 +0,0 @@
|
||||
---
|
||||
title: 'Jekyll 3.4.3 Released'
|
||||
date: 2017-03-21 08:52:53 -0500
|
||||
author: pathawks
|
||||
version: 3.4.3
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Another one-PR patch update as we continue our quest to destroy all bugs. A
|
||||
fairly technical debriefing follows, but the TLDR is that we have updated the
|
||||
`uri_escape` filter to more closely follow the pre-v3.4.0 behavior.
|
||||
|
||||
In [v3.4.0]({% link _posts/2017-01-18-jekyll-3-4-0-released.markdown %}), we
|
||||
moved away from using the deprecated
|
||||
[`URI.escape`](https://ruby-doc.org/stdlib-2.3.0/libdoc/uri/rdoc/URI/Escape.html#method-i-encode)
|
||||
in favor of
|
||||
[`Addressable::URI.encode`](http://www.rubydoc.info/gems/addressable/Addressable/URI#encode-class_method).
|
||||
This is what powers our [`uri_escape`
|
||||
filter](https://jekyllrb.com/docs/templates/).
|
||||
|
||||
While this transition was mostly a smooth one, the two methods are not
|
||||
identical. While `URI.escape` was happy to escape any string,
|
||||
`Addressable::URI.encode` first turns the string into an `Addressable::URI`
|
||||
object, and will then escape each component of that object. In most cases, this
|
||||
difference was insignificant, but there were a few cases where this caused some
|
||||
unintended regressions when encoding colons.
|
||||
|
||||
While **Addressable** can understand that something like `"/example :page"` is a
|
||||
relative URI, without the slash it cannot figure out how to turn
|
||||
`"example :page"` into an `Addressable::URI` object. `URI.escape` had no such
|
||||
objection. This lead to the following Liquid code working fine in Jekyll 3.3.x
|
||||
but breaking in 3.4.0:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{{ "example :page" | uri_escape }}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
This was not an intended consequence of switching to **Addressable**.
|
||||
|
||||
Fortunately, the solution was not complicated. **Addressable** has a method
|
||||
[`Addressable::URI.normalize_component`](http://www.rubydoc.info/gems/addressable/Addressable/URI#normalize_component-class_method)
|
||||
which will simply escape the characters in a string, much like `URI.escape`.
|
||||
|
||||
Thanks to @cameronmcefee and @FriesFlorian for reporting
|
||||
[this issue](https://github.com/jekyll/jekyll/issues/5954).
|
||||
|
||||
Happy Jekylling!
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user