Compare commits
1 Commits
docs-40
...
unified-pr
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e42b37f2dd |
@@ -3,7 +3,7 @@ engines:
|
||||
enabled: false
|
||||
rubocop:
|
||||
enabled: true
|
||||
channel: rubocop-0-54
|
||||
channel: rubocop-0-49
|
||||
|
||||
exclude_paths:
|
||||
- .codeclimate.yml
|
||||
@@ -29,8 +29,6 @@ exclude_paths:
|
||||
- test/**/*
|
||||
- vendor/**/*
|
||||
|
||||
- lib/jekyll/commands/serve/livereload_assets/livereload.js
|
||||
|
||||
ratings:
|
||||
paths:
|
||||
- lib/**/*.rb
|
||||
|
||||
2
.github/ISSUE_TEMPLATE.md
vendored
@@ -48,7 +48,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.)
|
||||
|
||||
2
.github/first-timers-issue-template.md
vendored
@@ -12,7 +12,7 @@ Nothing. This issue is meant to welcome you to Open Source :) We are happy to wa
|
||||
|
||||
- [ ] 👌 **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.
|
||||
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 recieve an email inviting you to join the Jekyll organization.
|
||||
|
||||
- [ ] 🙋 **Claim this issue**: Comment below.
|
||||
|
||||
|
||||
45
.rubocop.yml
@@ -1,14 +1,6 @@
|
||||
---
|
||||
|
||||
require:
|
||||
- ./rubocop/jekyll
|
||||
|
||||
Jekyll/NoPutsAllowed:
|
||||
Exclude:
|
||||
- rake/*.rake
|
||||
|
||||
AllCops:
|
||||
TargetRubyVersion: 2.3
|
||||
TargetRubyVersion: 2.1
|
||||
Include:
|
||||
- lib/**/*.rb
|
||||
Exclude:
|
||||
@@ -46,15 +38,10 @@ Layout/MultilineMethodCallIndentation:
|
||||
EnforcedStyle: indented
|
||||
Layout/MultilineOperationIndentation:
|
||||
EnforcedStyle: indented
|
||||
Lint/NestedPercentLiteral:
|
||||
Exclude:
|
||||
- test/test_site.rb
|
||||
Layout/EmptyComment:
|
||||
Layout/SpaceInsideBrackets:
|
||||
Enabled: false
|
||||
Layout/EndAlignment:
|
||||
Lint/EndAlignment:
|
||||
Severity: error
|
||||
Lint/UnneededRequireStatement:
|
||||
Enabled: false
|
||||
Lint/UnreachableCode:
|
||||
Severity: error
|
||||
Lint/UselessAccessModifier:
|
||||
@@ -99,16 +86,6 @@ Naming/FileName:
|
||||
Enabled: false
|
||||
Naming/HeredocDelimiterNaming:
|
||||
Enabled: false
|
||||
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:
|
||||
- _
|
||||
Performance/UnfreezeString:
|
||||
Enabled: false
|
||||
Security/MarshalLoad:
|
||||
Exclude:
|
||||
- !ruby/regexp /test\/.*.rb$/
|
||||
@@ -133,9 +110,6 @@ Style/Documentation:
|
||||
- !ruby/regexp /features\/.*.rb$/
|
||||
Style/DoubleNegation:
|
||||
Enabled: false
|
||||
Style/FormatStringToken:
|
||||
Exclude:
|
||||
- lib/jekyll/utils/ansi.rb
|
||||
Style/GuardClause:
|
||||
Enabled: false
|
||||
Style/HashSyntax:
|
||||
@@ -145,15 +119,10 @@ Style/IfUnlessModifier:
|
||||
Enabled: false
|
||||
Style/InverseMethods:
|
||||
Enabled: false
|
||||
Style/MixinUsage:
|
||||
Exclude:
|
||||
- test/helper.rb
|
||||
Style/ModuleFunction:
|
||||
Enabled: false
|
||||
Style/MultilineTernaryOperator:
|
||||
Severity: error
|
||||
Style/NumericPredicate:
|
||||
Enabled: false
|
||||
Style/PercentLiteralDelimiters:
|
||||
PreferredDelimiters:
|
||||
"%q": "{}"
|
||||
@@ -163,8 +132,6 @@ Style/PercentLiteralDelimiters:
|
||||
"%w": "()"
|
||||
"%W": "()"
|
||||
"%x": "()"
|
||||
Style/RedundantFreeze:
|
||||
Enabled: false
|
||||
Style/RedundantReturn:
|
||||
Enabled: false
|
||||
Style/RedundantSelf:
|
||||
@@ -173,8 +140,6 @@ Style/RegexpLiteral:
|
||||
EnforcedStyle: percent_r
|
||||
Style/RescueModifier:
|
||||
Enabled: false
|
||||
Style/SafeNavigation:
|
||||
Enabled: false
|
||||
Style/SignalException:
|
||||
EnforcedStyle: only_raise
|
||||
Style/SingleLineMethods:
|
||||
@@ -185,7 +150,5 @@ Style/StringLiteralsInInterpolation:
|
||||
EnforcedStyle: double_quotes
|
||||
Style/SymbolArray:
|
||||
Enabled: false
|
||||
Style/TrailingCommaInArrayLiteral:
|
||||
EnforcedStyleForMultiline: consistent_comma
|
||||
Style/TrailingCommaInHashLiteral:
|
||||
Style/TrailingCommaInLiteral:
|
||||
EnforcedStyleForMultiline: consistent_comma
|
||||
|
||||
14
.travis.yml
@@ -5,17 +5,22 @@ 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.4.2
|
||||
- &ruby2 2.3.5
|
||||
- &ruby3 2.2.8
|
||||
- &ruby4 2.1.10
|
||||
- &jruby jruby-9.1.14.0
|
||||
|
||||
matrix:
|
||||
include:
|
||||
- rvm: *ruby1
|
||||
env: TEST_SUITE=test ROUGE=1.11.1
|
||||
- rvm: *ruby1
|
||||
env: TEST_SUITE=fmt
|
||||
- rvm: *ruby1
|
||||
env: TEST_SUITE=default-site
|
||||
- rvm: *ruby1
|
||||
env: ROUGE_VERSION=1.11.1 # runs everything with this version
|
||||
exclude:
|
||||
- rvm: *jruby
|
||||
env: TEST_SUITE=cucumber
|
||||
@@ -52,4 +57,3 @@ after_success:
|
||||
|
||||
before_install:
|
||||
- gem update --system
|
||||
- gem install bundler
|
||||
|
||||
24
Gemfile
@@ -5,6 +5,11 @@ gemspec :name => "jekyll"
|
||||
|
||||
gem "rake", "~> 12.0"
|
||||
|
||||
gem "rouge", ENV["ROUGE"] if ENV["ROUGE"]
|
||||
|
||||
# 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,14 +23,15 @@ end
|
||||
|
||||
group :test do
|
||||
gem "codeclimate-test-reporter", "~> 1.0.5"
|
||||
gem "cucumber", "~> 3.0"
|
||||
gem "cucumber", RUBY_VERSION >= "2.2" ? "~> 3.0" : "3.0.1"
|
||||
gem "httpclient"
|
||||
gem "jekyll_test_plugin"
|
||||
gem "jekyll_test_plugin_malicious"
|
||||
gem "nokogiri", "~> 1.7"
|
||||
# nokogiri v1.8 does not work with ruby 2.1 and below
|
||||
gem "nokogiri", RUBY_VERSION >= "2.2" ? "~> 1.7" : "~> 1.7.0"
|
||||
gem "rspec"
|
||||
gem "rspec-mocks"
|
||||
gem "rubocop", "~> 0.55.0"
|
||||
gem "rubocop", "~> 0.51.0"
|
||||
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__)
|
||||
|
||||
@@ -35,13 +41,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
|
||||
@@ -69,15 +76,16 @@ group :jekyll_optional_dependencies do
|
||||
gem "jekyll-redirect-from"
|
||||
gem "kramdown", "~> 1.14"
|
||||
gem "mime-types", "~> 3.0"
|
||||
gem "rdoc", "~> 6.0"
|
||||
gem "tomlrb", "~> 1.2"
|
||||
gem "rdoc", "~> 5.0"
|
||||
gem "toml", "~> 0.2.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 "rdiscount", "~> 2.0"
|
||||
gem "yajl-ruby", "~> 1.3"
|
||||
gem "redcarpet", "~> 3.2", ">= 3.2.3"
|
||||
gem "yajl-ruby", "~> 1.3.1"
|
||||
end
|
||||
|
||||
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||
|
||||
324
History.markdown
@@ -1,253 +1,5 @@
|
||||
## HEAD
|
||||
|
||||
### 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)
|
||||
|
||||
### 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)
|
||||
|
||||
### 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)
|
||||
|
||||
### 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)
|
||||
|
||||
## 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)
|
||||
@@ -276,14 +28,56 @@
|
||||
* 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)
|
||||
* Remove link to severly outdated asset plugin (#6613)
|
||||
|
||||
### 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)
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* 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)
|
||||
* Add LiveReload functionality to Jekyll. (#5142)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
@@ -301,9 +95,13 @@
|
||||
* 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)
|
||||
|
||||
### 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)
|
||||
|
||||
## 3.6.2 / 2017-10-21
|
||||
|
||||
@@ -853,9 +651,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)
|
||||
@@ -899,7 +697,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)
|
||||
@@ -1208,7 +1006,7 @@
|
||||
* 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)
|
||||
|
||||
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,8 +3,8 @@
|
||||
[][ruby-gems]
|
||||
[][travis]
|
||||
[][appveyor]
|
||||
[](codeclimate)
|
||||
[](coverage)
|
||||
[][coverage]
|
||||
[][codeclimate]
|
||||
[][gemnasium]
|
||||
[][hakiri]
|
||||
|
||||
|
||||
18
appveyor.yml
@@ -16,18 +16,20 @@ 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"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "24"
|
||||
TEST_SUITE: "cucumber"
|
||||
- RUBY_FOLDER_VER: "24"
|
||||
TEST_SUITE: "default-site"
|
||||
- RUBY_FOLDER_VER: "24-x64"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "23"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "22"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "21"
|
||||
TEST_SUITE: "test"
|
||||
|
||||
test_script:
|
||||
- ruby --version
|
||||
|
||||
@@ -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,48 +1,59 @@
|
||||
---
|
||||
version: 3.8.1
|
||||
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"
|
||||
sass:
|
||||
style: compressed
|
||||
|
||||
gauges_id: 503c5af6613f5d0f19000027
|
||||
google_analytics_id: UA-50755011-1
|
||||
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
|
||||
|
||||
repository: https://github.com/jekyll/jekyll
|
||||
|
||||
timezone: America/Los_Angeles
|
||||
|
||||
defaults:
|
||||
-
|
||||
scope:
|
||||
path: "_docs"
|
||||
type: "docs"
|
||||
values:
|
||||
layout: "docs"
|
||||
-
|
||||
scope:
|
||||
path: "_posts"
|
||||
type: "posts"
|
||||
values:
|
||||
layout: "news_item"
|
||||
image: /img/twitter-card.png
|
||||
|
||||
collections:
|
||||
docs:
|
||||
permalink: "/:collection/:path/"
|
||||
permalink: /:collection/:path/
|
||||
output: true
|
||||
posts:
|
||||
permalink: "/news/:year/:month/:day/:title/"
|
||||
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"
|
||||
|
||||
name: Jekyll • Simple, blog-aware, static sites
|
||||
description: Transform your plain text into static websites and blogs
|
||||
url: https://jekyllrb.com
|
||||
|
||||
twitter:
|
||||
username: jekyllrb
|
||||
|
||||
logo: /img/logo-2x.png
|
||||
|
||||
plugins:
|
||||
- jekyll-avatar
|
||||
- jekyll-feed
|
||||
- jekyll-mentions
|
||||
- jekyll-redirect-from
|
||||
- jekyll-seo-tag
|
||||
- jekyll-sitemap
|
||||
- jemoji
|
||||
sass:
|
||||
style: compressed
|
||||
- jekyll-avatar
|
||||
- jekyll-feed
|
||||
- jekyll-mentions
|
||||
- jekyll-redirect-from
|
||||
- jekyll-seo-tag
|
||||
- jekyll-sitemap
|
||||
- jemoji
|
||||
|
||||
exclude:
|
||||
- ".gitignore"
|
||||
- CNAME
|
||||
- icomoon-selection.json
|
||||
- readme.md
|
||||
- .gitignore
|
||||
- CNAME
|
||||
- icomoon-selection.json
|
||||
- readme.md
|
||||
|
||||
@@ -6,7 +6,6 @@
|
||||
- orderofinterpretation
|
||||
- custom-404-page
|
||||
- convert-site-to-jekyll
|
||||
- using-jekyll-with-bundler
|
||||
|
||||
#- title: Another section
|
||||
# tutorials:
|
||||
|
||||
@@ -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>
|
||||
|
||||
@@ -49,18 +49,12 @@ defaults:
|
||||
<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>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 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>_posts</code> directory to <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
|
||||
@@ -348,20 +342,6 @@ you specified in your `_config.yml` (if present) and the following information:
|
||||
<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
|
||||
|
||||
|
||||
@@ -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">
|
||||
@@ -549,9 +549,7 @@ 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" -%}
|
||||
It is also possible to use glob patterns 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:
|
||||
@@ -566,17 +564,6 @@ defaults:
|
||||
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.
|
||||
@@ -642,12 +629,12 @@ collections:
|
||||
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"
|
||||
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
|
||||
|
||||
# Filtering Content
|
||||
@@ -684,21 +671,24 @@ verbose: false
|
||||
defaults: []
|
||||
|
||||
liquid:
|
||||
error_mode: warn
|
||||
strict_filters: false
|
||||
strict_variables: false
|
||||
error_mode: warn
|
||||
|
||||
# Markdown Processors
|
||||
rdiscount:
|
||||
extensions: []
|
||||
|
||||
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
|
||||
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
|
||||
```
|
||||
|
||||
## Liquid Options
|
||||
@@ -710,19 +700,55 @@ 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
|
||||
available.
|
||||
|
||||
### Redcarpet
|
||||
|
||||
Redcarpet can be configured by providing an `extensions` sub-setting, whose
|
||||
value should be an array of strings. Each string should be the name of one of
|
||||
the `Redcarpet::Markdown` class's extensions; if present in the array, it will
|
||||
set the corresponding extension to `true`.
|
||||
|
||||
Jekyll handles two special Redcarpet extensions:
|
||||
|
||||
- `no_fenced_code_blocks` --- By default, Jekyll sets the `fenced_code_blocks`
|
||||
extension (for delimiting code blocks with triple tildes or triple backticks)
|
||||
to `true`, probably because GitHub's eager adoption of them is starting to make
|
||||
them inescapable. Redcarpet's normal `fenced_code_blocks` extension is inert
|
||||
when used with Jekyll; instead, you can use this inverted version of the
|
||||
extension for disabling fenced code.
|
||||
|
||||
Note that you can also specify a language for highlighting after the first
|
||||
delimiter:
|
||||
|
||||
```ruby
|
||||
# ...ruby code
|
||||
```
|
||||
|
||||
With both fenced code blocks and highlighter enabled, this will statically
|
||||
highlight the code; without any syntax highlighter, it will add a
|
||||
`class="LANGUAGE"` attribute to the `<code>` element, which can be used as a
|
||||
hint by various JavaScript code highlighting libraries.
|
||||
|
||||
- `smart` --- This pseudo-extension turns on SmartyPants, which converts
|
||||
straight quotes to curly quotes and runs of hyphens to em (`---`) and en (`--`) dashes.
|
||||
|
||||
All other extensions retain their usual names from Redcarpet, and no renderer
|
||||
options aside from `smart` can be specified in Jekyll. [A list of available
|
||||
extensions can be found in the Redcarpet README file.][redcarpet_extensions]
|
||||
Make sure you're looking at the README for the right version of
|
||||
Redcarpet: Jekyll currently uses v3.2.x. The most commonly used
|
||||
extensions are:
|
||||
|
||||
- `tables`
|
||||
- `no_intra_emphasis`
|
||||
- `autolink`
|
||||
|
||||
[redcarpet_extensions]: https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use
|
||||
|
||||
### Custom Markdown Processors
|
||||
|
||||
If you're interested in creating a custom markdown processor, you're in luck! Create a new class in the `Jekyll::Converters::Markdown` namespace:
|
||||
|
||||
@@ -66,15 +66,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
|
||||
bundle exec jekyll build -s $TMP_GIT_CLONE -d $PUBLIC_WWW
|
||||
rm -Rf $TMP_GIT_CLONE
|
||||
exit
|
||||
```
|
||||
|
||||
@@ -4,297 +4,6 @@ permalink: "/docs/history/"
|
||||
note: This file is autogenerated. Edit /History.markdown instead.
|
||||
---
|
||||
|
||||
## 3.8.1 / 2018-05-01
|
||||
{: #v3-8-1}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-8-1}
|
||||
|
||||
- Fix rendering Liquid constructs in excerpts ([#6945]({{ site.repository }}/issues/6945))
|
||||
- Liquify documents unless published == false ([#6959]({{ site.repository }}/issues/6959))
|
||||
|
||||
|
||||
## 3.8.0 / 2018-04-19
|
||||
{: #v3-8-0}
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-8-0}
|
||||
|
||||
- move duplicate code to a single private method ([#6593]({{ site.repository }}/issues/6593))
|
||||
- Test against Ruby 2.5 on AppVeyor ([#6668]({{ site.repository }}/issues/6668))
|
||||
- Replace simple regex with a native Ruby method ([#6732]({{ site.repository }}/issues/6732))
|
||||
- Codeclimate: exclude livereload.js ([#6776]({{ site.repository }}/issues/6776))
|
||||
- Add a cucumber feature to test link tag ([#6777]({{ site.repository }}/issues/6777))
|
||||
- Fix theme gem feature ([#6784]({{ site.repository }}/issues/6784))
|
||||
- Replace simple regex with equivalent Ruby methods ([#6736]({{ site.repository }}/issues/6736))
|
||||
- Rewrite `script/rubyprof` as a Ruby script ([#6813]({{ site.repository }}/issues/6813))
|
||||
- Add debug output to theme rendering ([#5195]({{ site.repository }}/issues/5195))
|
||||
- fix minitest deprecation warning in test ([#6839]({{ site.repository }}/issues/6839))
|
||||
- Memoize `Site#site_data` ([#6809]({{ site.repository }}/issues/6809))
|
||||
- Memoize document output extension ([#6814]({{ site.repository }}/issues/6814))
|
||||
- Access document permalink attribute efficiently ([#6740]({{ site.repository }}/issues/6740))
|
||||
- Minimize array allocations in the `where` filter ([#6860]({{ site.repository }}/issues/6860))
|
||||
- Bump JRuby ([#6878]({{ site.repository }}/issues/6878))
|
||||
- Assert existence of <collection>.files ([#6907]({{ site.repository }}/issues/6907))
|
||||
- Bump Rubocop to 0.54.x ([#6915]({{ site.repository }}/issues/6915))
|
||||
- Regenerate unconditionally unless its an incremental build ([#6917]({{ site.repository }}/issues/6917))
|
||||
- Centralize require statements ([#6910]({{ site.repository }}/issues/6910))
|
||||
- Bump to Rubocop 0.55 ([#6929]({{ site.repository }}/issues/6929))
|
||||
- Refactor private method `HighlightBlock#parse_options` ([#6822]({{ site.repository }}/issues/6822))
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-8-0}
|
||||
|
||||
- Two massive performance improvements for large sites ([#6730]({{ site.repository }}/issues/6730))
|
||||
- Cache the list of documents to be written ([#6741]({{ site.repository }}/issues/6741))
|
||||
- Allow Jekyll Doctor to detect stray posts dir ([#6681]({{ site.repository }}/issues/6681))
|
||||
- Excerpt relative-path should match its path ([#6597]({{ site.repository }}/issues/6597))
|
||||
- Remind user to resolve conflict in `jekyll new` with `--force` ([#6801]({{ site.repository }}/issues/6801))
|
||||
- Memoize helper methods in site-cleaner ([#6808]({{ site.repository }}/issues/6808))
|
||||
- Compute document's relative_path faster ([#6767]({{ site.repository }}/issues/6767))
|
||||
- Create a single instance of PostReader per site ([#6759]({{ site.repository }}/issues/6759))
|
||||
- Allow date filters to output ordinal days ([#6773]({{ site.repository }}/issues/6773))
|
||||
- Change regex to sanitize and normalize filenames passed to LiquidRenderer ([#6610]({{ site.repository }}/issues/6610))
|
||||
- Allow passing :strict_variables and :strict_filters options to Liquid's renderer ([#6726]({{ site.repository }}/issues/6726))
|
||||
- Debug writing files during the build process ([#6696]({{ site.repository }}/issues/6696))
|
||||
- Improve regex usage in `Tags::IncludeTag` ([#6848]({{ site.repository }}/issues/6848))
|
||||
- Improve comment included in the starter index.md ([#6916]({{ site.repository }}/issues/6916))
|
||||
- Store and retrieve converter instances for Jekyll::Filters via a hash ([#6856]({{ site.repository }}/issues/6856))
|
||||
- Implement a cache within the `where` filter ([#6868]({{ site.repository }}/issues/6868))
|
||||
- Store regexp in a constant ([#6887]({{ site.repository }}/issues/6887))
|
||||
- Optimize computing filename in LiquidRenderer ([#6841]({{ site.repository }}/issues/6841))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Adding the jekyll-algolia plugin to the list of plugins ([#6737]({{ site.repository }}/issues/6737))
|
||||
- Added Premonition plugin to list of plugins ([#6750]({{ site.repository }}/issues/6750))
|
||||
- Add document on releasing a new version ([#6745]({{ site.repository }}/issues/6745))
|
||||
- Mention Talkyard, a new commenting system for Jekyll and others. ([#6752]({{ site.repository }}/issues/6752))
|
||||
- Add 'jekyll-fontello' to plugins ([#6757]({{ site.repository }}/issues/6757))
|
||||
- Install dh-autoreconf on Windows ([#6765]({{ site.repository }}/issues/6765))
|
||||
- Fix common typos ([#6764]({{ site.repository }}/issues/6764))
|
||||
- Fix documentation for {% raw %}`{{ page.excerpt }}`{% endraw %} ([#6779]({{ site.repository }}/issues/6779))
|
||||
- Update docs on permalink configuration ([#6775]({{ site.repository }}/issues/6775))
|
||||
- Propose fix some typos ([#6785]({{ site.repository }}/issues/6785))
|
||||
- Say hello to Jekyll's New Lead Developer ([#6790]({{ site.repository }}/issues/6790))
|
||||
- Add reference to Liquid to plugin docs ([#6794]({{ site.repository }}/issues/6794))
|
||||
- Draft a release post for v3.7.3 ([#6803]({{ site.repository }}/issues/6803))
|
||||
- add missing step for gem-based theme conversion ([#6802]({{ site.repository }}/issues/6802))
|
||||
- Update windows.md to explain an issue with jekyll new. ([#6838]({{ site.repository }}/issues/6838))
|
||||
- Add Bundler Installation Instructions ([#6828]({{ site.repository }}/issues/6828))
|
||||
- Docs: describe difference between tags and categories ([#6882]({{ site.repository }}/issues/6882))
|
||||
- Add `jekyll-random` plugin to docs ([#6833]({{ site.repository }}/issues/6833))
|
||||
- Fixed typo in description of categories and tags ([#6896]({{ site.repository }}/issues/6896))
|
||||
- Add missing ul-tag ([#6897]({{ site.repository }}/issues/6897))
|
||||
- doc: add liquid tag plugin jekyll-onebox for html previews ([#6898]({{ site.repository }}/issues/6898))
|
||||
- Add `jekyll-w2m` to plugins ([#6855]({{ site.repository }}/issues/6855))
|
||||
- Fix tutorials navigation HTML ([#6919]({{ site.repository }}/issues/6919))
|
||||
- add Arch Linux instalation troubleshoot ([#6782]({{ site.repository }}/issues/6782))
|
||||
- Docs: Install Jekyll on macOS ([#6881]({{ site.repository }}/issues/6881))
|
||||
- Fix CodeClimate badges [ci skip] ([#6930]({{ site.repository }}/issues/6930))
|
||||
- Update index.md ([#6933]({{ site.repository }}/issues/6933))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-8-0}
|
||||
|
||||
- Remove links to Gists ([#6751]({{ site.repository }}/issues/6751))
|
||||
- Always load Google Fonts over HTTPS ([#6792]({{ site.repository }}/issues/6792))
|
||||
- always load analytics.js over HTTPS ([#6807]({{ site.repository }}/issues/6807))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-8-0}
|
||||
|
||||
- Append appropriate closing tag to Liquid block in an excerpt ### -minor ([#6724]({{ site.repository }}/issues/6724))
|
||||
- Bypass rendering via Liquid unless required ([#6735]({{ site.repository }}/issues/6735))
|
||||
- Delegated methods after `private` keyword are meant to be private ([#6819]({{ site.repository }}/issues/6819))
|
||||
- Improve handling non-default collection documents rendering and writing ([#6795]({{ site.repository }}/issues/6795))
|
||||
- Fix passing multiline params to include tag when using the variable syntax ([#6858]({{ site.repository }}/issues/6858))
|
||||
- `include_relative` tag should find related documents in collections gathered within custom `collections_dir` ([#6818]({{ site.repository }}/issues/6818))
|
||||
- Handle liquid tags in excerpts robustly ([#6891]({{ site.repository }}/issues/6891))
|
||||
- Allow front matter defaults to be applied properly to documents gathered under custom `collections_dir` ([#6885]({{ site.repository }}/issues/6885))
|
||||
|
||||
|
||||
## 3.7.3 / 2018-02-25
|
||||
{: #v3-7-3}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-7-3}
|
||||
|
||||
- Do not hardcode locale unless certainly necessary ([#6791]({{ site.repository }}/issues/6791))
|
||||
|
||||
|
||||
## 3.7.2 / 2018-01-25
|
||||
{: #v3-7-2}
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-7-2}
|
||||
|
||||
- CI: Test against Ruby 2.5.0 ([#6664]({{ site.repository }}/issues/6664))
|
||||
- Bump rdoc to 6.0 ([#6600]({{ site.repository }}/issues/6600))
|
||||
- Lint file and bump theme dependencies ([#6698]({{ site.repository }}/issues/6698))
|
||||
- Write a Rubocop Cop to ensure no `#p` or `#puts` calls get committed to master. ([#6615]({{ site.repository }}/issues/6615))
|
||||
- Remove redgreen gem ([#6720]({{ site.repository }}/issues/6720))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-7-2}
|
||||
|
||||
- Display latest version in header ([#6676]({{ site.repository }}/issues/6676))
|
||||
- Update version in `config.yml` via YAML load / dump ([#6677]({{ site.repository }}/issues/6677))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Fix: Add note about posts in context of collections_dir ([#6680]({{ site.repository }}/issues/6680))
|
||||
- Update deploy-script in documentation ([#6666]({{ site.repository }}/issues/6666))
|
||||
- Add note about naming of collections_dir ([#6703]({{ site.repository }}/issues/6703))
|
||||
- Update installation.md ([#6694]({{ site.repository }}/issues/6694))
|
||||
- Add `jekyll-html` to plugins. ([#6654]({{ site.repository }}/issues/6654))
|
||||
- Update plugins.md ([#6716]({{ site.repository }}/issues/6716))
|
||||
- Release v3.7.1 ([#6695]({{ site.repository }}/issues/6695))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-7-2}
|
||||
|
||||
- inform that symlinks are not allowed in safe mode ([#6670]({{ site.repository }}/issues/6670))
|
||||
- Glob scope path only if configured with a pattern ([#6692]({{ site.repository }}/issues/6692))
|
||||
- Add gem "wdm" to all newly generated Gemfiles ([#6711]({{ site.repository }}/issues/6711))
|
||||
- Fix timezone inconsistencies between different ruby version ([#6697]({{ site.repository }}/issues/6697))
|
||||
- Refactor collections_dir feature for consistency ([#6685]({{ site.repository }}/issues/6685))
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-7-2}
|
||||
|
||||
- Require external library only if necessary ([#6596]({{ site.repository }}/issues/6596))
|
||||
|
||||
|
||||
## 3.7.0 / 2018-01-02
|
||||
{: #v3-7-0}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-7-0}
|
||||
|
||||
- Add LiveReload functionality to Jekyll. ([#5142]({{ site.repository }}/issues/5142))
|
||||
- Add Utils::Internet.connected? to determine whether host machine has internet connection. ([#5870]({{ site.repository }}/issues/5870))
|
||||
- Disable default layouts for Pages with a `layout: none` declaration ([#6182]({{ site.repository }}/issues/6182))
|
||||
- Scope path glob ([#6268]({{ site.repository }}/issues/6268))
|
||||
- Allow the user to set collections_dir to put all collections under one subdirectory ([#6331]({{ site.repository }}/issues/6331))
|
||||
- Upgrade to Rouge 3 ([#6381]({{ site.repository }}/issues/6381))
|
||||
- Allow URL filters to work directly with documents ([#6478]({{ site.repository }}/issues/6478))
|
||||
- filter relative_url should keep absolute urls with scheme/authority ([#6490]({{ site.repository }}/issues/6490))
|
||||
- `.sass-cache` doesn't *always* land in `options['source']` ([#6500]({{ site.repository }}/issues/6500))
|
||||
- Allow plugins to modify the obsolete files. ([#6502]({{ site.repository }}/issues/6502))
|
||||
- Add latin mode to `slugify` ([#6509]({{ site.repository }}/issues/6509))
|
||||
- Log Kramdown warnings if log level is WARN ([#6522]({{ site.repository }}/issues/6522))
|
||||
- Add an option to configure kramdown warning output ([#6554]({{ site.repository }}/issues/6554))
|
||||
- Add `json` extension to list of directory indices ([#6550]({{ site.repository }}/issues/6550))
|
||||
- Dependency: Bump jekyll-watch to 2.0 ([#6589]({{ site.repository }}/issues/6589))
|
||||
- Remove paginate check ([#6606]({{ site.repository }}/issues/6606))
|
||||
- update classifier-reborn to 2.2.0 ([#6631]({{ site.repository }}/issues/6631))
|
||||
- Switch to an actively-maintained TOML parser. ([#6652]({{ site.repository }}/issues/6652))
|
||||
- Do not coerce layout paths in theme-gem to the source directory ([#6603]({{ site.repository }}/issues/6603))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-7-0}
|
||||
|
||||
- Raise when theme root directory is not available ([#6455]({{ site.repository }}/issues/6455))
|
||||
- Avoid block parser warning in SmartyPants ([#6565]({{ site.repository }}/issues/6565))
|
||||
- Fail gracefully if "sass" gem cannot be loaded ([#6573]({{ site.repository }}/issues/6573))
|
||||
- return correct file in dir if dir has same name as file ([#6569]({{ site.repository }}/issues/6569))
|
||||
- Register reload hooks in Server#process ([#6605]({{ site.repository }}/issues/6605))
|
||||
- Memoize path to metadata file ([#6602]({{ site.repository }}/issues/6602))
|
||||
- Use `require_relative` to load Jekyll classes ([#6609]({{ site.repository }}/issues/6609))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-7-0}
|
||||
|
||||
- Added direct collection access to future collection item feature test([#6151]({{ site.repository }}/issues/6151))
|
||||
- add failing test for non-utf8 encoding ([#6339]({{ site.repository }}/issues/6339))
|
||||
- Upgrade to Cucumber 3.0 ([#6395]({{ site.repository }}/issues/6395))
|
||||
- Provide a better default hash for tracking liquid stats ([#6417]({{ site.repository }}/issues/6417))
|
||||
- Add configuration for first-timers bot ([#6431]({{ site.repository }}/issues/6431))
|
||||
- Do not linkify escaped characters as PRs in History ([#6468]({{ site.repository }}/issues/6468))
|
||||
- Rely on jekyll-mentions for linking usernames ([#6469]({{ site.repository }}/issues/6469))
|
||||
- Update first-timers-issue-template.md ([#6472]({{ site.repository }}/issues/6472))
|
||||
- Enable `Lint/RescueWithoutErrorClass` Cop ([#6482]({{ site.repository }}/issues/6482))
|
||||
- Clean up Rubocop config ([#6495]({{ site.repository }}/issues/6495))
|
||||
- Use Gem to discover the location of bundler ([#6499]({{ site.repository }}/issues/6499))
|
||||
- Remove unnecessary encoding comment ([#6513]({{ site.repository }}/issues/6513))
|
||||
- Suggest using Rubocop to automatically fix errors ([#6514]({{ site.repository }}/issues/6514))
|
||||
- Assert raising Psych::SyntaxError when`"strict_front_matter"=>true` ([#6520]({{ site.repository }}/issues/6520))
|
||||
- Use Kernel#Array instead of explicit Array check ([#6525]({{ site.repository }}/issues/6525))
|
||||
- RuboCop: Enable `Style/UnneededCapitalW` cop ([#6526]({{ site.repository }}/issues/6526))
|
||||
- Refactor method to reduce ABC Metric size ([#6529]({{ site.repository }}/issues/6529))
|
||||
- Remove parentheses around arguments to raise ([#6532]({{ site.repository }}/issues/6532))
|
||||
- Use double-quotes around gem name ([#6535]({{ site.repository }}/issues/6535))
|
||||
- Dependencies: upgrade to toml 0.2.0 ([#6541]({{ site.repository }}/issues/6541))
|
||||
- Lock to cucumber 3.0.1 on Ruby 2.1 ([#6546]({{ site.repository }}/issues/6546))
|
||||
- Bump JRuby version in Travis config ([#6561]({{ site.repository }}/issues/6561))
|
||||
- Rescue from Psych::SyntaxError instead of SyntaxError after parsing YAML([#5828]({{ site.repository }}/issues/5828))
|
||||
- Drop forwarding to private methods by exposing those methods as public([#6577]({{ site.repository }}/issues/6577))
|
||||
- Upgrade pygments to v1.x ([#5937]({{ site.repository }}/issues/5937))
|
||||
- Bump yajl-ruby ([#6582]({{ site.repository }}/issues/6582))
|
||||
- Cleanup test_redcarpet.rb ([#6584]({{ site.repository }}/issues/6584))
|
||||
- Add PageWithoutAFile class from jekyll plugins ([#6556]({{ site.repository }}/issues/6556))
|
||||
- Cleanup LiveReloadReactor ([#6607]({{ site.repository }}/issues/6607))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Add formester to the list of saas form backend ([#6059]({{ site.repository }}/issues/6059))
|
||||
- GitHub Pages instructions ([#6384]({{ site.repository }}/issues/6384))
|
||||
- Improve documentation for theme-gem installation ([#6387]({{ site.repository }}/issues/6387))
|
||||
- Fix diff syntax-highlighting ([#6388]({{ site.repository }}/issues/6388))
|
||||
- Update instructions ([#6396]({{ site.repository }}/issues/6396))
|
||||
- Fix code-block highlighting in docs ([#6398]({{ site.repository }}/issues/6398))
|
||||
- Filtering Posts with categories, tags, or other variables ([#6399]({{ site.repository }}/issues/6399))
|
||||
- Fixes formatting on pre-formatted text. ([#6405]({{ site.repository }}/issues/6405))
|
||||
- Added new tutorial to tutorials section on docs ([#6406]({{ site.repository }}/issues/6406))
|
||||
- Updates ([#6407]({{ site.repository }}/issues/6407))
|
||||
- Fix `collections_dir` example ([#6408]({{ site.repository }}/issues/6408))
|
||||
- Renaming duplicate of "Scenario 6" to "Scenario 7" ([#6411]({{ site.repository }}/issues/6411))
|
||||
- Mark `collection_dir` as unreleased ([#6412]({{ site.repository }}/issues/6412))
|
||||
- Fix link to SUPPORT ([#6415]({{ site.repository }}/issues/6415))
|
||||
- Fix list appearance by adding missing `ol` tag ([#6421]({{ site.repository }}/issues/6421))
|
||||
- Explain how to override output collection index page ([#6424]({{ site.repository }}/issues/6424))
|
||||
- Added github-cards to the list of plugins ([#6425]({{ site.repository }}/issues/6425))
|
||||
- CoC violation correspondants ([#6429]({{ site.repository }}/issues/6429))
|
||||
- Add a note about Liquid and syntax highlighting ([#6466]({{ site.repository }}/issues/6466))
|
||||
- Remove `sudo` from macOS troubleshooting instructions ([#6486]({{ site.repository }}/issues/6486))
|
||||
- Add a note on `:jekyll_plugins` group in the docs ([#6488]({{ site.repository }}/issues/6488))
|
||||
- Updated custom-404-page.md ([#6489]({{ site.repository }}/issues/6489))
|
||||
- Fix a few minor issues in the docs ([#6494]({{ site.repository }}/issues/6494))
|
||||
- Add jekyll-pwa-plugin ([#6533]({{ site.repository }}/issues/6533))
|
||||
- Remove Jekyll-Smartify from plugins directory ([#6548]({{ site.repository }}/issues/6548))
|
||||
- Updated Jekyll-Pug listing to include official website ([#6555]({{ site.repository }}/issues/6555))
|
||||
- Remove link to severely outdated asset plugin ([#6613]({{ site.repository }}/issues/6613))
|
||||
- Default time zone depends upon server ([#6617]({{ site.repository }}/issues/6617))
|
||||
- Add `disqus-for-jekyll` to plugins. ([#6618]({{ site.repository }}/issues/6618))
|
||||
- Update "Requirements" for Ruby version ([#6623]({{ site.repository }}/issues/6623))
|
||||
- Fix: Update link to i18n_filter plugin ([#6638]({{ site.repository }}/issues/6638))
|
||||
- Correct WordPress capitalization ([#6645]({{ site.repository }}/issues/6645))
|
||||
- Add Tweetsert, Stickyposts, Paginate::Content ([#6651]({{ site.repository }}/issues/6651))
|
||||
- Post: Jekyll 3.7.0 released ([#6634]({{ site.repository }}/issues/6634))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v3-7-0}
|
||||
|
||||
- Add special styling for code-blocks run in shell ([#6389]({{ site.repository }}/issues/6389))
|
||||
- Add post about diversity ([#6447]({{ site.repository }}/issues/6447))
|
||||
- Update list of files excluded from Docs site ([#6457]({{ site.repository }}/issues/6457))
|
||||
- Update site History ([#6460]({{ site.repository }}/issues/6460))
|
||||
- Add default twitter card image ([#6476]({{ site.repository }}/issues/6476))
|
||||
- Update normalize.css to v7.0.0 ([#6491]({{ site.repository }}/issues/6491))
|
||||
- Optimize images ([#6519]({{ site.repository }}/issues/6519))
|
||||
- Back to original main navigation ([#6544]({{ site.repository }}/issues/6544))
|
||||
- Styles: mobile-docs select element ([#6545]({{ site.repository }}/issues/6545))
|
||||
- Search with DocSearch by @Algolia ([#6557]({{ site.repository }}/issues/6557))
|
||||
- Site header redesign ([#6567]({{ site.repository }}/issues/6567))
|
||||
- Move logo above site navigation on small screens ([#6570]({{ site.repository }}/issues/6570))
|
||||
- Docs: Include version badge for latest features ([#6574]({{ site.repository }}/issues/6574))
|
||||
- Use version-badge on an existing feature intro ([#6575]({{ site.repository }}/issues/6575))
|
||||
- Add jekyll-category-pages plugin ([#6632]({{ site.repository }}/issues/6632))
|
||||
- Improve docs styling for code to be run in shell ([#6641]({{ site.repository }}/issues/6641))
|
||||
- Fix permalink icon markup in news-item layout ([#6639]({{ site.repository }}/issues/6639))
|
||||
|
||||
|
||||
## 3.6.2 / 2017-10-21
|
||||
{: #v3-6-2}
|
||||
|
||||
@@ -897,9 +606,9 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Update appveyor.yml and fix optional deps for Ruby x64 ([#5180]({{ site.repository }}/issues/5180))
|
||||
- Improve tests for Jekyll::PluginManager ([#5167]({{ site.repository }}/issues/5167))
|
||||
- Update Ruby versions in travis.yml ([#5221]({{ site.repository }}/issues/5221))
|
||||
- Avoid installing unnecessary gems for site testing ([#5272]({{ site.repository }}/issues/5272))
|
||||
- Avoid installing unecessary gems for site testing ([#5272]({{ site.repository }}/issues/5272))
|
||||
- Proposal: Affinity teams and their captains ([#5273]({{ site.repository }}/issues/5273))
|
||||
- Replace duplicate with positive local test in issue template ([#5286]({{ site.repository }}/issues/5286))
|
||||
- Replace duplicate with postive local test in issue template ([#5286]({{ site.repository }}/issues/5286))
|
||||
- Update AppVeyor config. ([#5240]({{ site.repository }}/issues/5240))
|
||||
- Execute jekyll from clone instead of defined binary when running 'script/default-site' ([#5295]({{ site.repository }}/issues/5295))
|
||||
- rubocop: lib/jekyll/document.rb complexity fixes ([#5045]({{ site.repository }}/issues/5045))
|
||||
@@ -951,7 +660,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Allow collections to have documents that have no file extension ([#4545]({{ site.repository }}/issues/4545))
|
||||
- Add size property to `group_by` result ([#4557]({{ site.repository }}/issues/4557))
|
||||
- Site Template: Removed unnecessary nesting from `_base.scss` ([#4637]({{ site.repository }}/issues/4637))
|
||||
- Adding a debug log statement for skipped future documents. ([#4558]({{ site.repository }}/issues/4558))
|
||||
- Adding a debug log statment for skipped future documents. ([#4558]({{ site.repository }}/issues/4558))
|
||||
- Site Template: Changed main `<div>` to `<main>` and added accessibility info ([#4636]({{ site.repository }}/issues/4636))
|
||||
- Add array support to `where` filter ([#4555]({{ site.repository }}/issues/4555))
|
||||
- 'jekyll clean': also remove .sass-cache ([#4652]({{ site.repository }}/issues/4652))
|
||||
@@ -1289,7 +998,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- utils/drops: update Drop to support `Utils.deep_merge_hashes` ([#4289]({{ site.repository }}/issues/4289))
|
||||
- Make sure jekyll/drops/drop is loaded first. ([#4292]({{ site.repository }}/issues/4292))
|
||||
- Convertible/Page/Renderer: use payload hash accessor & setter syntax for backwards-compatibility ([#4311]({{ site.repository }}/issues/4311))
|
||||
- Drop: fix hash setter precedence ([#4312]({{ site.repository }}/issues/4312))
|
||||
- Drop: fix hash setter precendence ([#4312]({{ site.repository }}/issues/4312))
|
||||
- utils: `has_yaml_header?` should accept files with extraneous spaces ([#4290]({{ site.repository }}/issues/4290))
|
||||
- Escape html from site.title and page.title in site template ([#4307]({{ site.repository }}/issues/4307))
|
||||
- Allow custom file extensions if defined in `permalink` YAML front matter ([#4314]({{ site.repository }}/issues/4314))
|
||||
|
||||
@@ -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://shopify.github.io/liquid/) 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,69 @@
|
||||
---
|
||||
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 should be straight-forward if all requirements are met.
|
||||
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)
|
||||
- GNU/Linux, Unix, or macOS
|
||||
- [Ruby](https://www.ruby-lang.org/en/downloads/) version 2.1 or above, including all development
|
||||
headers
|
||||
- [RubyGems](https://rubygems.org/pages/download)
|
||||
- [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)
|
||||
|
||||
## Install on macOS {#macOS}
|
||||
#### Only required for Jekyll 2 and earlier
|
||||
|
||||
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).
|
||||
- [NodeJS](https://nodejs.org/), or another JavaScript runtime (for CoffeeScript support).
|
||||
- [Python 2.7](https://www.python.org/downloads/)
|
||||
|
||||
<div class="note info">
|
||||
<h5>Problems installing Jekyll?</h5>
|
||||
<p>
|
||||
Check out the <a href="../troubleshooting/">troubleshooting</a> page or
|
||||
<a href="{{ site.repository }}/issues/new">report an issue</a> so the
|
||||
Jekyll community can improve the experience for everyone.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Install on Ubuntu Linux {#ubuntu}
|
||||
<div class="note info">
|
||||
<h5>Running Jekyll on Windows</h5>
|
||||
<p>
|
||||
While Windows is not officially supported, it is possible to get Jekyll running
|
||||
on Windows. Special instructions can be found on our
|
||||
<a href="../windows/#installation">Windows-specific docs page</a>.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
Before we install Jekyll, we need to make sure we have all the required
|
||||
dependencies.
|
||||
## Install with RubyGems
|
||||
|
||||
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.
|
||||
|
||||
```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
|
||||
|
||||
@@ -199,4 +93,52 @@ 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
|
||||
bundle update jekyll
|
||||
```
|
||||
|
||||
Alternatively, if you don't have Bundler installed run:
|
||||
|
||||
```sh
|
||||
gem update jekyll
|
||||
```
|
||||
|
||||
Please refer to our [upgrading section](../upgrading/) for major updates
|
||||
detailed instructions.
|
||||
|
||||
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!
|
||||
@@ -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:
|
||||
|
||||
@@ -226,7 +226,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 +242,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 +250,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 +297,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 +330,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.:output_ext` 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.
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ You have 3 options for installing plugins:
|
||||
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 `plugins` (or `gems` for Jekyll < `3.5.0`) and the
|
||||
2. In your `_config.yml` file, add a new array with the key `plugins` and the
|
||||
values of the gem names of the plugins you'd like to use. An example:
|
||||
|
||||
```yaml
|
||||
@@ -94,11 +94,7 @@ 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.
|
||||
See the bottom of the page for a [list of available plugins](#available-plugins)
|
||||
|
||||
## Generators
|
||||
|
||||
@@ -757,6 +753,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 +772,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.
|
||||
@@ -781,21 +782,25 @@ You can find a few useful plugins at the following locations:
|
||||
- [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.
|
||||
|
||||
#### 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.
|
||||
- [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/).
|
||||
@@ -806,7 +811,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.
|
||||
@@ -825,7 +833,6 @@ 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.
|
||||
|
||||
#### Tags
|
||||
|
||||
@@ -834,16 +841,30 @@ 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.
|
||||
@@ -853,6 +874,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.
|
||||
@@ -882,11 +905,7 @@ You can find a few useful plugins at the following locations:
|
||||
- [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.
|
||||
|
||||
|
||||
#### Collections
|
||||
|
||||
@@ -896,11 +915,15 @@ 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.
|
||||
- [Analytics for Jekyll](https://github.com/hendrikschneider/jekyll-analytics) by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Piwik, 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.
|
||||
@@ -908,6 +931,7 @@ You can find a few useful plugins at the following locations:
|
||||
- [Jekyll-scholar](https://github.com/inukshuk/jekyll-scholar): Jekyll extensions for the blogging scholar.
|
||||
- [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.
|
||||
@@ -935,12 +959,12 @@ You can find a few useful plugins at the following locations:
|
||||
- [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.
|
||||
|
||||
<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>
|
||||
|
||||
@@ -201,38 +201,13 @@ 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.
|
||||
While this example is done with categories, you can easily extend your lists to
|
||||
filter by tags or 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:
|
||||
|
||||
@@ -26,15 +26,13 @@ If you encounter any unexpected errors during the above, please refer to the [tr
|
||||
|
||||
## 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:
|
||||
|
||||
@@ -11,12 +11,12 @@ Jekyll's growing use is producing a wide variety of tutorials, frameworks, exten
|
||||
- [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.
|
||||
- [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.
|
||||
- [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/).
|
||||
@@ -25,14 +25,13 @@ Jekyll's growing use is producing a wide variety of tutorials, frameworks, exten
|
||||
|
||||
## Integrations
|
||||
|
||||
- Use a SaaS service as a backend for forms (contact forms, hiring forms, etc.)
|
||||
- Use a saas service as a backend for forms (contact forms, hiring forms, etc.)
|
||||
|
||||
- [Formspree (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.
|
||||
@@ -42,8 +41,6 @@ Jekyll's growing use is producing a wide variety of tutorials, frameworks, exten
|
||||
|
||||
- [How I'm using Jekyll in 2016](https://mademistakes.com/articles/using-jekyll-2016/)
|
||||
|
||||
- [Talkyard comments instructions for Jekyll](https://jekyll-demo.talkyard.io/2018/01/09/installation-instructions.html)
|
||||
|
||||
- [Static Comments with Jekyll & Staticman](https://mademistakes.com/articles/improving-jekyll-static-comments/)
|
||||
|
||||
- [Adding Ajax pagination to Jekyll](https://eduardoboucas.com/blog/2014/11/05/adding-ajax-pagination-to-jekyll.html)
|
||||
|
||||
@@ -91,20 +91,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.</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>
|
||||
@@ -119,20 +105,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.</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>
|
||||
@@ -147,8 +119,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>
|
||||
@@ -179,8 +150,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>
|
||||
@@ -588,23 +558,6 @@ One major benefit of using the `link` or `post_url` tag is link validation. If t
|
||||
|
||||
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.
|
||||
|
||||
The name of the file you want to link can be specified as a variable instead of an actual file name. For example, suppose you defined a variable in your page's front matter like this:
|
||||
|
||||
```yaml
|
||||
---
|
||||
title: My page
|
||||
my_variable: footer_company_a.html
|
||||
---
|
||||
```
|
||||
|
||||
You could then reference that variable in your link:
|
||||
|
||||
```liquid
|
||||
{% raw %}{% link {{ page.my_variable }} %}{% endraw %}
|
||||
```
|
||||
|
||||
In this example, the link would add link to the file `footer_company_a.html`.
|
||||
|
||||
### 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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -108,48 +108,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`.
|
||||
@@ -277,7 +236,7 @@ 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
|
||||
|
||||
|
||||
@@ -36,12 +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
|
||||
@@ -103,55 +97,6 @@ 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
|
||||
@@ -227,13 +172,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
|
||||
```
|
||||
|
||||
@@ -252,7 +197,7 @@ 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') %>':
|
||||
@@ -290,8 +235,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)
|
||||
|
||||
@@ -65,17 +65,15 @@ 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
|
||||
# => 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 tip">
|
||||
<h5>Livereload</h5>
|
||||
<p>If you want to enable Livereload, you can enable the <a href="https://github.com/RobertDeRose/jekyll-livereload">jekyll-livereload</a> plugin in a <a href="../configuration/#build-command-options">development config file</a>.</p>
|
||||
</div>
|
||||
|
||||
```sh
|
||||
jekyll serve --no-watch
|
||||
|
||||
@@ -250,7 +250,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>
|
||||
|
||||
@@ -7,72 +7,13 @@ While Windows is not an officially-supported platform, it can be used to run Jek
|
||||
|
||||
|
||||
## Installing Jekyll
|
||||
The easiest way to run Jekyll is by using the [RubyInstaller][] for Windows.
|
||||
|
||||
### Installation via RubyInstaller
|
||||
|
||||
[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.
|
||||
|
||||
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`
|
||||
|
||||
That's it, you're ready to install our [default minimal blog theme](https://github.com/jekyll/minima) with `jekyll new jekyll-website`.
|
||||
|
||||
[RubyInstaller]: https://rubyinstaller.org/
|
||||
[RubyInstaller-downloads]: https://rubyinstaller.org/downloads/
|
||||
[Devkit-install]: https://github.com/oneclick/rubyinstaller/wiki/Development-Kit
|
||||
If you are using Windows 10 Anniversary Update, the easiest way to run Jekyll is by [installing][WSL-Guide] the new Bash on Ubuntu on Windows.
|
||||
|
||||
|
||||
### Encoding
|
||||
### Installation via Bash on Windows 10
|
||||
|
||||
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:
|
||||
|
||||
```sh
|
||||
chcp 65001
|
||||
```
|
||||
|
||||
|
||||
### Time-Zone 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].
|
||||
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
|
||||
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
|
||||
```
|
||||
|
||||
[IANA-database]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
|
||||
### 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:
|
||||
|
||||
```ruby
|
||||
gem 'wdm', '~> 0.1.1' if Gem.win_platform?
|
||||
```
|
||||
|
||||
You have to use a [Ruby+Devkit](https://rubyinstaller.org/downloads/) version of the RubyInstaller.
|
||||
|
||||
|
||||
## 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:* You must have [Windows Subsystem for Linux][BASH-WSL] enabled.
|
||||
*Note:* You must have [Bash on Ubuntu on Windows][BASH-WSL] enabled.
|
||||
|
||||
First let's make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:
|
||||
|
||||
@@ -89,7 +30,7 @@ Now we can install Ruby. To do this we will use a repository from [BrightBox](ht
|
||||
```sh
|
||||
sudo apt-add-repository ppa:brightbox/ruby-ng
|
||||
sudo apt-get update
|
||||
sudo apt-get install ruby2.3 ruby2.3-dev build-essential dh-autoreconf
|
||||
sudo apt-get install ruby2.3 ruby2.3-dev build-essential
|
||||
```
|
||||
|
||||
Next let's update our Ruby gems:
|
||||
@@ -110,12 +51,6 @@ Check if Jekyll installed properly by running:
|
||||
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:
|
||||
@@ -126,13 +61,154 @@ 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
|
||||
|
||||
|
||||
### Installation via RubyInstaller
|
||||
|
||||
[RubyInstaller][] is a self-contained Windows-based installer that includes the Ruby language, an execution environment, important documentation, and more.
|
||||
|
||||
1. Download and Install a package manager version from [RubyInstaller Downloads][RubyInstaller-downloads].
|
||||
2. Install Jekyll and Bundler via a command prompt window: `gem install jekyll bundler`
|
||||
3. Check if Jekyll installed properly: `jekyll -v`
|
||||
|
||||
[RubyInstaller]: https://rubyinstaller.org/
|
||||
[RubyInstaller-downloads]: https://rubyinstaller.org/downloads/
|
||||
|
||||
|
||||
### Installation via Chocolatey
|
||||
|
||||
A quick way to install Jekyll using Chocolatey 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/):
|
||||
|
||||
1. Install a package manager for Windows called [Chocolatey][]
|
||||
2. Install Ruby via Chocolatey: `choco install ruby -y`
|
||||
3. Reopen a command prompt and install Jekyll: `gem install jekyll`
|
||||
|
||||
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].
|
||||
|
||||
[ssl-certificate-update]: http://guides.rubygems.org/ssl-certificate-update/#installing-using-update-packages
|
||||
|
||||
|
||||
### Installing *github-pages* via Chocolatey
|
||||
|
||||
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.
|
||||
|
||||
**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.
|
||||
|
||||
```sh
|
||||
choco install libxml2 -Source "https://www.nuget.org/api/v2/"
|
||||
|
||||
choco install libxslt -Source "https://www.nuget.org/api/v2/"
|
||||
|
||||
choco install libiconv -Source "https://www.nuget.org/api/v2/
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
#### Install github-pages
|
||||
|
||||
* 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
|
||||
```
|
||||
|
||||
* **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`
|
||||
|
||||
|
||||
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.
|
||||
|
||||
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"
|
||||
[nokogiriFails]: https://github.com/sparklemotion/nokogiri/issues/1456#issuecomment-206481794 "Nokogiri fails to install on Ruby 2.3 for Windows"
|
||||
[Bundler]: http://bundler.io/ "Ruby Dependencie Manager"
|
||||
[nokogiriReleases]: https://github.com/sparklemotion/nokogiri/releases "Nokogiri Releases"
|
||||
|
||||
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].
|
||||
|
||||
Optionally you can use [Autoinstall Jekyll for Windows][fastjekyll-autoinstall].
|
||||
|
||||
[windows-installjekyll3]: https://labs.sverrirs.com/jekyll/
|
||||
[fastjekyll-autoinstall]: https://github.com/KeJunMao/fastjekyll#autoinstall-jekyll-for-windows
|
||||
|
||||
|
||||
## 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 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:
|
||||
|
||||
```sh
|
||||
chcp 65001
|
||||
```
|
||||
|
||||
|
||||
## Time-Zone 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].
|
||||
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
|
||||
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
|
||||
```
|
||||
|
||||
[IANA-database]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
|
||||
|
||||
## 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:
|
||||
|
||||
```ruby
|
||||
gem 'wdm', '~> 0.1.1' if Gem.win_platform?
|
||||
```
|
||||
|
||||
You may first have to download and install the [Ruby DevKit](https://rubyinstaller.org/downloads/) by following [the instructions here](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit).
|
||||
|
||||
@@ -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');
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
<div class="meta hide-on-mobiles">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="{{ site.repository }}/releases/tag/v{{ site.version }}">v{{ site.version }}</a>
|
||||
<a href="{{ site.repository }}/releases/tag/v{{ jekyll.version }}">v{{ jekyll.version }}</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="{{ site.repository }}">GitHub</a>
|
||||
|
||||
@@ -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">
|
||||
|
||||
@@ -6,8 +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="//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="/css/screen.css">
|
||||
<link rel="icon" type="image/x-icon" href="/favicon.ico">
|
||||
|
||||
@@ -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">
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Diversity in Open Source, and Jekyll's role in it"
|
||||
date: 2017-10-19 21:33:00 +0200
|
||||
author: oe
|
||||
author: pup
|
||||
categories: [community]
|
||||
---
|
||||
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
title: "Jekyll 3.7.0 Released"
|
||||
description: "Jekyll 3.7.0 brings LiveReload, a directory for your collections and much more…"
|
||||
date: 2018-01-02 11:21:40 +0100
|
||||
author: DirtyF
|
||||
version: 3.7.0
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
We're happy to release a new minor for the new year.
|
||||
Here are a few of the latest additions from our contributors:
|
||||
|
||||
* LiveReload is available as an option during development: with `jekyll serve --livereload` no more manual page refresh. A big thanks to @awood for this feature and to @andreyvit, LiveReload author.
|
||||
* New `collections_dir` configuration option allows you to store all your [collections](/docs/collections) in a single folder. Your source root folder should now look cleaner :sparkles: .
|
||||
* If you're using a [gem-based theme](/docs/themes/) in coordination with the `--incremental` option, you should notice some significant speed during the regeneration process, we did see build time went down **from 12s to 2s** with @mmistakes [minimal-mistakes theme](https://github.com/mmistakes/minimal-mistakes) during our tests.
|
||||
* Jekyll will now check to determine whether host machine has internet connection.
|
||||
* A new `latin` option is available to better [handle URLs slugs](/docs/templates/#options-for-the-slugify-filter).
|
||||
* And of course many bug fixes and updates to our documentation — which you can now search thanks to our friends @Algolia.
|
||||
* [Full history is here](/docs/history/#v3-7-0).
|
||||
|
||||
This release wouldn't have been possible without all the following people:
|
||||
|
||||
Aaron Borden, Alex Tsui, Alex Wood, Alexey Pelykh, Andrew Dassonville, Angelika Tyborska, Ankit Singhaniya, Ashwin Maroli, bellvat, Brandon Dusseau, Chris Finazzo, Doug Beney, Dr. Wolfram Schroers, Edward Shen, Florian Thomas, Frank Taillandier, Gert-jan Theunissen, Goulven Champenois, János Rusiczki, Jed Fox, Johannes Müller, Jon Anning, Jonathan Hooper, Jordon Bedwell, Junko Suzuki, Kacper Duras, Kenton Hansen, Kewin Dousse, Matt Rogers, Maximiliano Kotvinsky, mrHoliday, Olivia, Parker Moore, Pat Hawks, Sebastian Kulig, Vishesh Ruparelia, Xiaoiver and Yashu Mittal.
|
||||
|
||||
A big thanks to everyone!
|
||||
|
||||
Oh, one last thing…
|
||||
|
||||
### :pray: upgrade your Ruby
|
||||
|
||||
Prepare for the next major update, as next major version Jekyll 4.0 will drop support for Ruby 2.1 and 2.2.
|
||||
|
||||
> Ruby 2.2 is now under the state of the security maintenance phase, until the end of the March of 2018. After the date, maintenance of Ruby 2.2 will be ended. We recommend you start planning migration to newer versions of Ruby, such as 2.4 or 2.3. — [Ruby Core Team](https://www.ruby-lang.org/en/news/2017/12/14/ruby-2-2-9-released/)
|
||||
|
||||
We strongly encourage you to upgrade to at least Ruby 2.4.x [like our friends at GitHub Pages](https://pages.github.com/versions/) or even go with [Ruby 2.5](https://www.ruby-lang.org/en/news/2017/12/25/ruby-2-5-0-released/).
|
||||
|
||||
Happy new year to all from the Jekyll team!
|
||||
@@ -1,67 +0,0 @@
|
||||
---
|
||||
title: "Jekyll 3.7.2 Released"
|
||||
date: 2018-01-25 22:22:22 +0530
|
||||
author: ashmaroli
|
||||
version: 3.7.2
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Close on the heels of shipping 3.7.0, we were informed of a couple of
|
||||
regressions due to the changes made in that release. In due time, Team Jekyll
|
||||
set out to address those issues as early as possible.
|
||||
|
||||
Days later here we're, announcing 3.7.2 (sorry for skipping 3.7.1,
|
||||
RubyGems didn't want to play nice) that fixes numerous issues! :tada:
|
||||
The highlights being:
|
||||
|
||||
* A major regression in 3.7.0 was that when a Front Matter Default was
|
||||
configured with a `scope["path"]` set to a directory, Jekyll would scan
|
||||
that directory for any subfolders and files, for each document in that
|
||||
`path`.
|
||||
Though this is intended, it increases build times in proportion to the size
|
||||
of the directory.
|
||||
|
||||
We addressed this by having Jekyll scan the directory path only if the user
|
||||
explicitly configures the `scope["path"]` using wildcards.
|
||||
|
||||
Read our [documentation](/docs/configuration/#glob-patterns-in-front-matter-defaults)
|
||||
for more details.
|
||||
|
||||
A huge shout-out to @mmistakes for bringing this to our notice and
|
||||
additionally providing us with a test repository to aid in resolving the issue.
|
||||
|
||||
* Another regression reported was related to our "Custom collections
|
||||
directory" feature introduced in 3.7.0.
|
||||
|
||||
Users setting `collection_dir` to a certain directory would have *altered*
|
||||
paths to their posts still at the root of their site's source. This
|
||||
roughly translated to 404 errors on URLs to their posts.
|
||||
|
||||
Props to @localheinz for bringing this regression to our notice.
|
||||
|
||||
We decided to resolve this by having Jekyll ignore posts and drafts at the
|
||||
root of the site's source directory if the user customizes the
|
||||
`collection_dir` setting.
|
||||
|
||||
Ergo, if you set a custom location for your collections, please ensure you
|
||||
move all of your collections into that directory. **This includes posts and
|
||||
drafts as well**. Your links generated by
|
||||
`{% raw %}{% post_url %}{% endraw %}` or `{% raw %}{% link %}{% endraw %}`
|
||||
will adapt automatically.
|
||||
|
||||
* We also found out that `gem "wdm"` boosts performance while directories are
|
||||
being watched on Windows. So we recommend having it included in your Gemfile
|
||||
for a better development experience on Windows. (Newly generated Gemfiles
|
||||
will hereafter have that gem listed automatically :wink:)
|
||||
|
||||
In addition to the above, numerous other minor fixes and documentation updates
|
||||
have been made that should improve your Jekyll experience. All of which, would
|
||||
not have been possible without our wonderful contributors:
|
||||
|
||||
Alexandr, Andreas Möller, Ashwin Maroli, Chayoung You, Florian Thomas,
|
||||
Frank Taillandier, Hendrik Schneider, Kacper Duras, Olivia, Parker Moore and
|
||||
Paul Robert Lloyd.
|
||||
|
||||
As always, you can see our full changelog on [the History page](/docs/history/).
|
||||
|
||||
Happy Jekylling! :sparkles:
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
layout: news_item
|
||||
title: "Meet Jekyll's New Lead Developer"
|
||||
date: "2018-02-19 20:48:09 -0500"
|
||||
author: parkr
|
||||
categories: [team]
|
||||
---
|
||||
|
||||
Jekyll has a new Lead Developer: [Olivia](https://liv.cat/)!
|
||||
|
||||
After over 5 years of leading Jekyll, many releases from 0.12.1 to 3.6.0, and
|
||||
countless conversations in GitHub Issues, Pull Requests, Jekyll Talk, and
|
||||
more, I am passing on the torch as Lead Developer of Jekyll.
|
||||
|
||||
Olivia has been working with the Jekyll community for some time now. You
|
||||
may have seen her around in issues and pull requests on the various Jekyll
|
||||
repositories. She started as a contributor, then joined the Core team as our
|
||||
community lead. Olivia joined the Jekyll Core Team with experience in the
|
||||
Node.js community, both online and as a volunteer organizer with JSConf EU.
|
||||
|
||||
In my conversations with Olivia, it is clear that Jekyll's vision of
|
||||
simplicity for the user ([no magic!](/philosophy#1-no-magic)) and letting
|
||||
users' [content be king](/philosophy#3-content-is-king) will remain a top
|
||||
priority. In just the last few weeks as the transition has been occurring,
|
||||
we have seen some incredible work on performance that will make future
|
||||
versions of Jekyll work better at scale. She will be prioritizing work on
|
||||
innovative improvements to make Jekyll that much better for all of us.
|
||||
Olivia balances an eye for quality with the need for shipping well.
|
||||
|
||||
When Tom Preston-Werner met me at GitHub HQ 2.0 in January 2013 to pass on
|
||||
the torch, I could never have dreamed of all the amazing experiences this
|
||||
community would share with me over the next 5 years. From visiting @qrush
|
||||
in Buffalo, NY for a hack night on Jekyll to attending a Jekyll planning
|
||||
session hosted by @benbalter at GitHub to Google Summer of Code which gave
|
||||
us jekyll-admin, I am eternally grateful to all of you for the opportunity
|
||||
to lead this excellent community. I'm confident Olivia will continue to
|
||||
lead Jekyll to even greater heights.
|
||||
|
||||
As always, Happy Jekylling!
|
||||
|
||||
Parker
|
||||
|
||||
*Curious about who else runs this show? [Check out our excellent team.](/team/)*
|
||||
@@ -1,19 +0,0 @@
|
||||
---
|
||||
title: 'Jekyll 3.7.3 Released'
|
||||
date: 2018-02-25 13:02:08 +0530
|
||||
author: ashmaroli
|
||||
version: 3.7.3
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Hello Jekyllers!! :wave:
|
||||
|
||||
We're pleased to announce the release of `v3.7.3` which fixes a bug one might encounter while using `Jekyll - 3.7.x` along with a
|
||||
Jekyll plugin that in turn uses the `I18n` library.
|
||||
|
||||
When [v3.7.0]({% link _posts/2018-01-02-jekyll-3-7-0-released.md %}) enhanced our `slugify` filter with a `latin` option, we also
|
||||
hardcoded a default fallback locale for the `I18n` library to avoid an exception raised in the event the library fails to find
|
||||
any locale. This led to issues with third-party i18n plugins for Jekyll, especially since the default locale got assigned before
|
||||
the plugin was loaded, irrespective of whether the `slugify` filter was used.
|
||||
|
||||
Jekyll will henceforth set the default locale if and only if necessary.
|
||||
@@ -1,28 +0,0 @@
|
||||
---
|
||||
title: "Jekyll 4.0 is on the Horizon!"
|
||||
date: "2018-04-19 16:07:00 +0100"
|
||||
author: oe
|
||||
categories: [community]
|
||||
---
|
||||
|
||||
With the release of Jekyll 3.8.0, it's been 2 and a half years since the last major release. Jekyll 3.0.0 was released in late October of 2015! That's a long time ago, and we've been working towards the next major release of Jekyll for a couple of months now. Here's a small preview of what's to come:
|
||||
|
||||
- Dropping support for Ruby 2.1 and 2.2. Both versions have reached their EOL period.
|
||||
- Dropping Pygments as a dependency. We're already defaulting to Rouge, and this removes the implicit Python dependency. (finally!)
|
||||
- Making the `link` tag use relative URLs. This is a big breaking change, but it's the cleaner solution.
|
||||
|
||||
We're open to more ideas, though. If the development cost isn't too high, or if someone volunteers to take care of the implementation, it's likely that your suggestion might make it into Jekyll 4.0. Head over to this [issue] for more details. Some interesting topics might be improving Internationalization support in Jekyll, creating convenience Liquid tags, et cetera.
|
||||
|
||||
That being said, the development period of version 4.0 begins _now_. This means a couple of things:
|
||||
|
||||
- New features will only be implemented in Jekyll 4.0. There will be no 3.9.0 or the like.
|
||||
- Same with bug fixes, unless they concern something introduced in Jekyll 3.7 or 3.8, in which case we will backport the fixes and release a patch version.
|
||||
- Now is a great time to finally take on the feature you've wanted to see in Jekyll for ages! Just open an issue or experiment with the code to get going!
|
||||
|
||||
As for a release date, we're currently aiming for late summer, around September or so. However, keep in mind that this project is purely volunteer-run, and as such, delays might occur and we might not hit that release date.
|
||||
|
||||
Finally, this is a great time for newcomers to open-source to make their first contribution. We'll be doing our best to mark recommended contributions and create newcomer-friendly issues, as well as to provide mentoring throughout the contribution process (although we'd like to think that we're already pretty proficient at that). So if you've always been hestitant about contributing to a large open-source project, Jekyll is a good place to start!
|
||||
|
||||
Happy Jekylling! :wave:
|
||||
|
||||
[issue]: https://github.com/jekyll/jekyll/issues/6948
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
title: 'Jekyll 3.8.0 Released'
|
||||
date: 2018-04-19 19:45:15 +0530
|
||||
author: ashmaroli
|
||||
version: 3.8.0
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Aloha Jekyllers!! :wave:
|
||||
|
||||
After months of toiling on the codebase and shipping a couple of release-candidates, the Jekyll Team is delighted to finally
|
||||
present `v3.8.0`, packed with optimizations, improvements, some new features and a couple of bug-fixes. Yay!!!
|
||||
|
||||
Under the hood, Jekyll has undergone many minor changes that will allow it to run more performantly in the coming years. :smiley:
|
||||
Rest assured, our users should see minor improvements in their site's build times.
|
||||
|
||||
Speaking of improvements, users running a site containing a huge amount of posts or those who like to use our `where` filter
|
||||
frequently in a single template, are going to see a massive reduction in their total build times!! :tada:
|
||||
|
||||
Hold on, this version is not just about optimizations, there are some new features as well..:
|
||||
* Detect non-existent variables and filters specified in a template by enabling `strict_variables` and `strict_filters` under the
|
||||
`liquid` key in your config file.
|
||||
* Allow *date filters* to output ordinal days.
|
||||
* `jekyll doctor` now warns you if you have opted for custom `collections_dir` but placed `_posts` directory outside that
|
||||
directory.
|
||||
|
||||
..and yes, a couple of bug-fixes, notably:
|
||||
* Jekyll now handles future-dated documents properly.
|
||||
* Jekyll is able to handle Liquid blocks intelligently in excerpts.
|
||||
* A few methods that were *not meant to be publically accessible* have been entombed properly.
|
||||
* A few bugs that still plagued our `collections_dir` feature from `v3.7` got crushed.
|
||||
|
||||
As always, the full list of changes since last release can be viewed [here](/docs/history/#v3-8-0).
|
||||
|
||||
A big thanks to the following people who contributed to our repository with pull-requests that improved our codebase, documentation
|
||||
and tests:
|
||||
|
||||
Ana María Martínez Gómez, Antonio Argote, Ashwin Maroli, Awjin Ahn, Ben Balter, Benjamin Høegh, Christian Oliff, Damien Solodow,
|
||||
David Zhang, Delson Lima, Eric Cornelissen, Florian Thomas, Frank Taillandier, Heinrich Hartmann, Jakob Vad Nielsen, John Eismeier,
|
||||
Kacper Duras, KajMagnus, Mario Cekic, Max Vilimpoc, Michael H, Mike Kasberg, Parker Moore, Pat Hawks, Paweł Kuna, Robert Riemann,
|
||||
Roger Rohrbach, Semen Zhydenko, Stefan Dellmuth, Tim Carry, olivia, and steelman.
|
||||
|
||||
Happy Jekylling!! :sparkles:
|
||||
@@ -1,20 +0,0 @@
|
||||
---
|
||||
title: 'Jekyll 3.8.1 Released'
|
||||
date: 2018-05-01 11:56:01 -0500
|
||||
author: pathawks
|
||||
version: 3.8.1
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Happy May Day :tada:
|
||||
|
||||
The Jekyll team is happy to announce the release of `v3.8.1`, which fixes
|
||||
a couple of bugs that were introduced two weeks ago in `v3.8.0`. If you have
|
||||
experienced trouble regarding post excerpts or non-published posts, this release
|
||||
should be the remedy. Thanks to @Chaosed0 and @domLocalHeroes for originally
|
||||
reporting these issues, and to @ashmaroli for fixing them so quickly.
|
||||
|
||||
As a reminder, we have started work on Jekyll 4.0. If there are any
|
||||
features that you would love to see added to Jekyll, or any pain points you
|
||||
would like to see removed, please do add your ideas to the [Jekyll 4.0 idea
|
||||
list](https://github.com/jekyll/jekyll/issues/6948).
|
||||
@@ -1,6 +1,6 @@
|
||||
.highlight {
|
||||
.hll { background-color: #ffffcc }
|
||||
.c { color: #999; font-style: italic } /* Comment */
|
||||
.c { color: #87ceeb} /* Comment */
|
||||
.err { color: #ffffff} /* Error */
|
||||
.g { color: #ffffff} /* Generic */
|
||||
.k { color: #f0e68c} /* Keyword */
|
||||
|
||||
@@ -1126,33 +1126,21 @@ code.output {
|
||||
}
|
||||
|
||||
.language-sh {
|
||||
position: relative;
|
||||
&:before {
|
||||
display: table;
|
||||
padding: 8px;
|
||||
padding: 5px 8px;
|
||||
width: 100%;
|
||||
padding: 5px 0;
|
||||
font: 400 16px/24px 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||
color: #444;
|
||||
text-shadow: 0 1px 0 rgba(255,255,255,.5);
|
||||
background-color: #f7f7f7;
|
||||
background-image: url(data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/Pgo8c3ZnIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgdmlld0JveD0iMCAwIDEgMSIgcHJlc2VydmVBc3BlY3RSYXRpbz0ibm9uZSI+CiAgPGxpbmVhckdyYWRpZW50IGlkPSJncmFkLXVjZ2ctZ2VuZXJhdGVkIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgeDE9IjAlIiB5MT0iMCUiIHgyPSIwJSIgeTI9IjEwMCUiPgogICAgPHN0b3Agb2Zmc2V0PSIwJSIgc3RvcC1jb2xvcj0iI2Y3ZjdmNyIgc3RvcC1vcGFjaXR5PSIxIi8+CiAgICA8c3RvcCBvZmZzZXQ9IjclIiBzdG9wLWNvbG9yPSIjY2ZjZmNmIiBzdG9wLW9wYWNpdHk9IjEiLz4KICAgIDxzdG9wIG9mZnNldD0iMTAwJSIgc3RvcC1jb2xvcj0iI2FhYWFhYSIgc3RvcC1vcGFjaXR5PSIxIi8+CiAgPC9saW5lYXJHcmFkaWVudD4KICA8cmVjdCB4PSIwIiB5PSIwIiB3aWR0aD0iMSIgaGVpZ2h0PSIxIiBmaWxsPSJ1cmwoI2dyYWQtdWNnZy1nZW5lcmF0ZWQpIiAvPgo8L3N2Zz4=);
|
||||
background-image: -webkit-gradient(linear, left top, left bottom, from(#f7f7f7), color-stop(7%, #cfcfcf), to(#aaaaaa));
|
||||
background-image: -webkit-linear-gradient(top, #f7f7f7 0%, #cfcfcf 7%, #aaaaaa 100%);
|
||||
background-image: -moz-linear-gradient(top, #f7f7f7 0%, #cfcfcf 7%, #aaaaaa 100%);
|
||||
background-image: -o-linear-gradient(top, #f7f7f7 0%, #cfcfcf 7%, #aaaaaa 100%);
|
||||
background-image: linear-gradient(top, #f7f7f7 0%,#cfcfcf 7%,#aaaaaa 100%);
|
||||
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f7f7f7', endColorstr='#aaaaaa',GradientType=0 );
|
||||
border-bottom: 1px solid #111;
|
||||
text-align: center;
|
||||
content: "terminal";
|
||||
color: #272727;
|
||||
text-shadow: none;
|
||||
font-size: 14px;
|
||||
line-height: 1.25;
|
||||
font-weight: 700;
|
||||
content: "TERMINAL";
|
||||
background: #7a7a7a;
|
||||
border: 1px solid #333;
|
||||
@include border-radius(5px 5px 0 0);
|
||||
@include box-shadow(0 3px 10px rgba(0,0,0,.5));
|
||||
}
|
||||
.highlight {
|
||||
@include border-radius(0 0 5px 5px);
|
||||
}
|
||||
pre.highlight {
|
||||
background: #1c1c1c;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -261,7 +261,7 @@ toc2:
|
||||
{% if item.subfolderitems[0] %}
|
||||
<ul>
|
||||
{% for entry in item.subfolderitems %}
|
||||
<li><a href="{{ entry.url }}">{{ entry.page }}</a>
|
||||
<li><a href="{{ entry.url }}">{{ entry.page }}</a></li>
|
||||
{% if entry.subsubfolderitems[0] %}
|
||||
<ul>
|
||||
{% for subentry in entry.subsubfolderitems %}
|
||||
@@ -269,7 +269,6 @@ toc2:
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
@@ -397,11 +396,9 @@ In addition to inserting items from the YAML data file into your list, you also
|
||||
</style>
|
||||
|
||||
<div class="highlight result">
|
||||
<ul>
|
||||
<li class=""><a href="#">Introduction</a></li>
|
||||
<li class=""><a href="#">Configuration</a></li>
|
||||
<li class="active"><a href="#">Deployment</a></li>
|
||||
</ul>
|
||||
<li class=""><a href="#">Introduction</a></li>
|
||||
<li class=""><a href="#">Configuration</a></li>
|
||||
<li class="active"><a href="#">Deployment</a></li>
|
||||
</div>
|
||||
|
||||
In this case, assume `Deployment` is the current page.
|
||||
|
||||
@@ -1,106 +0,0 @@
|
||||
---
|
||||
layout: tutorials
|
||||
permalink: /tutorials/using-jekyll-with-bundler/
|
||||
title: Using Jekyll with Bundler
|
||||
---
|
||||
|
||||
> Bundler provides a consistent environment for Ruby projects by tracking and
|
||||
> installing the exact gems and versions that are needed.
|
||||
|
||||
[Bundler](https://bundler.io) can be a great tool to use with Jekyll. Because it
|
||||
tracks dependencies on a per-project basis, it is particularly useful if you
|
||||
need to run different versions of Jekyll in different projects, or if you don't
|
||||
want to install Jekyll at the system or user level. This tutorial will show you
|
||||
how to create a new Jekyll project using Bundler and without installing Jekyll
|
||||
outside the project.
|
||||
|
||||
## Before You Begin
|
||||
|
||||
To complete this tutorial, you'll need to have
|
||||
[Ruby](https://www.ruby-lang.org/en/) and [Bundler](https://bundler.io/)
|
||||
installed. You can find the installation instructions on their websites.
|
||||
|
||||
## Initialize Bundler
|
||||
|
||||
The first thing to do is create a new directory for your project and run
|
||||
`bundle init`. This creates a new Bundler project (by creating an empty
|
||||
Gemfile).
|
||||
|
||||
```sh
|
||||
mkdir my-jekyll-website
|
||||
cd my-jekyll-website
|
||||
bundle init
|
||||
```
|
||||
|
||||
## Configure Bundler
|
||||
|
||||
This step is optional, but encouraged. We're going to configure Bundler to install
|
||||
gems in the `./vendor/bundle/` project subdirectory. This allows us to install
|
||||
our dependencies in an isolated environment, ensuring they don't conflict with
|
||||
other gems on your system. If you skip this step, Bundler will install your
|
||||
dependencies globally on your system.
|
||||
|
||||
```sh
|
||||
bundle install --path vendor/bundle
|
||||
```
|
||||
|
||||
<div class="note info">
|
||||
<h5>Bundler Config is Persistent</h5>
|
||||
<p>
|
||||
This step is only required once per project. Bundler saves your config in
|
||||
<code>./.bundle/config</code>, so future gems will be installed to the same
|
||||
location.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Add Jekyll
|
||||
|
||||
Now, we're going to use Bundler to add Jekyll as a dependency of our new
|
||||
project. This command will add the Jekyll gem to our Gemfile and install it to
|
||||
the `./vendor/bundle/` folder.
|
||||
|
||||
```sh
|
||||
bundle add jekyll
|
||||
```
|
||||
|
||||
## Create A Jekyll Scaffold
|
||||
|
||||
Now that Jekyll is installed, we can use it to create the scaffolding for our
|
||||
site. We need the `--force` parameter because our folder isn't empty - it
|
||||
already has some Bundler files in it. We run the `bundle install` separately
|
||||
because Jekyll gets confused if the Gemfile already exists.
|
||||
|
||||
```sh
|
||||
bundle exec jekyll new --force --skip-bundle .
|
||||
bundle install
|
||||
```
|
||||
|
||||
## Serve the Site
|
||||
|
||||
Your new website is ready! You can serve the website with
|
||||
`bundle exec jekyll serve` and visit it at
|
||||
[http://127.0.0.1:4000](http://127.0.0.1:4000). From here, you're ready to
|
||||
continue developing the site on your own. All of the normal Jekyll commands are
|
||||
available to you, but you should prefix them with `bundle exec` so that Bundler
|
||||
runs the version of Jekyll that is installed in your project folder.
|
||||
|
||||
## Commit to Source Control
|
||||
|
||||
If you're storing your new site in version control, you'll want to ignore the
|
||||
`./vendor/` and `./.bundle/` folders since they contain user- or
|
||||
platform-specific information. New users will be able to install the correct
|
||||
dependencies based on `Gemfile` and `Gemfile.lock`, which should both be checked
|
||||
in. You can use this `.gitigonre` to get started, if you want.
|
||||
|
||||
**.gitignore**
|
||||
|
||||
```
|
||||
# Ignore folders generated by Bundler
|
||||
vendor
|
||||
.bundle
|
||||
|
||||
# Ignore folders generated by Jekyll
|
||||
.sass-cache
|
||||
_site
|
||||
```
|
||||
|
||||
@@ -5,15 +5,10 @@ title: Getting Help
|
||||
|
||||
Need help with Jekyll? Try these resources.
|
||||
|
||||
### [Documentation](/docs/home/)
|
||||
|
||||
Start with our official guide to Jekyll covering installation, writing, customization, deployment, and more.
|
||||
|
||||
### [Jekyll Talk](https://talk.jekyllrb.com/)
|
||||
|
||||
Our official Discourse forum. Here, users and contributors
|
||||
Jekyll Talk is our official Discourse forum. Here, users and contributors
|
||||
can ask questions and discuss all aspects of Jekyll.
|
||||
Also the place to [showcase your jekyll sites](https://talk.jekyllrb.com/t/jekyll-showcase-share-your-sites-built-with-jekyll/44/80) and [share your jekyll themes](https://talk.jekyllrb.com/t/jekyll-theme-showcase-share-your-jekyll-themes/1382/2).
|
||||
|
||||
### [Jekyll on StackOverflow](https://stackoverflow.com/questions/tagged/jekyll)
|
||||
|
||||
@@ -26,9 +21,9 @@ question!
|
||||
Get live support at **#jekyll** on **irc.freenode.net**, the official
|
||||
Jekyll IRC channel.
|
||||
|
||||
### View source
|
||||
### [Documentation](/docs/home/)
|
||||
|
||||
Learn from the source of others, you'll find plenty of [jekyll sites](https://github.com/topics/jekyll-site) and [jekyll themes](https://github.com/topics/jekyll-themes) carefully handcrafted on GitHub.
|
||||
Our guide to Jekyll covering installation, writing, customization, deployment, and more.
|
||||
|
||||
### [Tutorials](/tutorials/home)
|
||||
|
||||
@@ -43,6 +38,10 @@ Known breaking changes are listed in the upgrading docs.
|
||||
|
||||
Watch videos from members of the Jekyll community speak about interesting use cases, tricks they've learned or meta Jekyll topics.
|
||||
|
||||
### [View source](https://github.com/jekyll/jekyll/wiki/sites)
|
||||
|
||||
Learn from the source of others' Jekyll-powered sites.
|
||||
|
||||
### [Google](https://www.google.com/?q=jekyll)
|
||||
|
||||
Add **jekyll** to almost any query, and you'll find just what you need.
|
||||
|
||||
|
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 112 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
@@ -45,7 +45,7 @@ overview: true
|
||||
<p class="line">
|
||||
<span class="path">~</span>
|
||||
<span class="prompt">$</span>
|
||||
<span class="command">gem install bundler jekyll</span>
|
||||
<span class="command">gem install jekyll bundler</span>
|
||||
</p>
|
||||
<p class="line">
|
||||
<span class="path">~</span>
|
||||
|
||||
@@ -1 +1 @@
|
||||
3.8.1
|
||||
3.6.2
|
||||
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
layout: page
|
||||
title: The Jekyll Team
|
||||
---
|
||||
|
||||
## Core Team
|
||||
|
||||
*The Jekyll Core Team's responsibility is to ensure the development and
|
||||
community around the Jekyll ecosystem thrive.*
|
||||
|
||||
1. Olivia (@oe, Lead Developer)
|
||||
2. Frank (@DirtyF, Documentation)
|
||||
3. Pat (@pathawks)
|
||||
4. Matt (@mattr-)
|
||||
|
||||
## Plugin Core
|
||||
|
||||
*The Jekyll Plugin Core Team's responsibility is to ensure the development and
|
||||
community around the core plugins thrive. They also provide guidance in
|
||||
conversations about extensibility of Core Jekyll.*
|
||||
|
||||
1. Ashwin (@ashmaroli)
|
||||
2. Florian (@Crunch09)
|
||||
3. Mert (@mertkahyaoglu, jekyll-admin)
|
||||
4. Alfred Xing (@alfredxing)
|
||||
|
||||
## Affinity Team Captains
|
||||
|
||||
*The Affinity Team Captains lead [Jekyll's Affinity
|
||||
Teams](https://teams.jekyllrb.com/). Each team is tasked with maintaining
|
||||
and addressing issues for a specific aspect of Jekyll.*
|
||||
|
||||
1. [Build](https://github.com/orgs/jekyll/teams/build): @mattr-
|
||||
2. [Documentation](https://github.com/orgs/jekyll/teams/documentation): @DirtyF, @mattr-
|
||||
3. [Ecosystem](https://github.com/orgs/jekyll/teams/ecosystem): @pathawks
|
||||
4. [Performance](https://github.com/orgs/jekyll/teams/performance): @mattr-, @parkr
|
||||
5. [Stability](https://github.com/orgs/jekyll/teams/stability): @oe, @parkr
|
||||
6. [Windows](https://github.com/orgs/jekyll/teams/windows): @XhmikosR
|
||||
|
||||
## Emeritus Core Team Members
|
||||
|
||||
*Emeritus Core Team Members were once members of Jekyll's Core Team.*
|
||||
|
||||
1. Parker (@parkr)
|
||||
2. Tom (@mojombo)
|
||||
3. Nick (@qrush)
|
||||
4. Alfred (@alfredxing)
|
||||
@@ -116,69 +116,7 @@ Feature: Collections
|
||||
And the _site directory should exist
|
||||
And the "_site/puppies/fido.html" file should exist
|
||||
|
||||
Scenario: Access rendered collection with future dated document via Liquid
|
||||
Given I have a _puppies directory
|
||||
And I have the following documents under the puppies collection:
|
||||
| title | date | content |
|
||||
| Rover | 2007-12-31 | content for Rover. |
|
||||
| Fido | 2120-12-31 | content for Fido. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: true
|
||||
"""
|
||||
And I have a "index.html" page that contains "Newest puppy: {% assign puppy = site.puppies.last %}{{ puppy.title }}"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "Newest puppy: Fido" in "_site/index.html"
|
||||
But the "_site/puppies/fido.html" file should not exist
|
||||
When I run jekyll build --future
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "Newest puppy: Fido" in "_site/index.html"
|
||||
And the "_site/puppies/fido.html" file should exist
|
||||
|
||||
Scenario: Access rendered and published collection documents via Liquid
|
||||
Given I have a _puppies directory
|
||||
And I have the following documents under the puppies collection:
|
||||
| title | date | content | published |
|
||||
| Rover | 2007-12-31 | content for Rover. | true |
|
||||
| Figor | 2007-12-31 | content for Figor. | false |
|
||||
| Snowy | 2199-12-31 | content for Snowy. | true |
|
||||
| Hardy | 2199-12-31 | content for Hardy. | false |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: true
|
||||
"""
|
||||
And I have a "index.md" page that contains "{% for puppy in site.puppies %}<div>{{ puppy.title }}</div>{% endfor %}"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<div>Rover</div>" in "_site/index.html"
|
||||
But I should see "<div>Snowy</div>" in "_site/index.html"
|
||||
And I should not see "<div>Figor</div>" in "_site/index.html"
|
||||
And I should not see "<div>Hardy</div>" in "_site/index.html"
|
||||
And the "_site/puppies/rover.html" file should exist
|
||||
And the "_site/puppies/figor.html" file should not exist
|
||||
And the "_site/puppies/snowy.html" file should not exist
|
||||
And the "_site/puppies/hardy.html" file should not exist
|
||||
When I run jekyll build --future
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<div>Rover</div>" in "_site/index.html"
|
||||
And I should see "<div>Snowy</div>" in "_site/index.html"
|
||||
And I should not see "<div>Figor</div>" in "_site/index.html"
|
||||
But I should not see "<div>Hardy</div>" in "_site/index.html"
|
||||
And the "_site/puppies/rover.html" file should exist
|
||||
And the "_site/puppies/figor.html" file should not exist
|
||||
And the "_site/puppies/hardy.html" file should not exist
|
||||
But the "_site/puppies/snowy.html" file should exist
|
||||
|
||||
Scenario: Unrendered collection with future dated document
|
||||
Scenario: Hidden collection with document with future date
|
||||
Given I have a _puppies directory
|
||||
And I have the following documents under the puppies collection:
|
||||
| title | date | content |
|
||||
@@ -201,68 +139,6 @@ Feature: Collections
|
||||
And the _site directory should exist
|
||||
And the "_site/puppies/fido.html" file should not exist
|
||||
|
||||
Scenario: Access unrendered collection with future dated document via Liquid
|
||||
Given I have a _puppies directory
|
||||
And I have the following documents under the puppies collection:
|
||||
| title | date | content |
|
||||
| Rover | 2007-12-31 | content for Rover. |
|
||||
| Fido | 2120-12-31 | content for Fido. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: false
|
||||
"""
|
||||
And I have a "index.html" page that contains "Newest puppy: {% assign puppy = site.puppies.last %}{{ puppy.title }}"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "Newest puppy: Fido" in "_site/index.html"
|
||||
But the "_site/puppies/fido.html" file should not exist
|
||||
When I run jekyll build --future
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "Newest puppy: Fido" in "_site/index.html"
|
||||
And the "_site/puppies/fido.html" file should not exist
|
||||
|
||||
Scenario: Access unrendered but publishable collection documents via Liquid
|
||||
Given I have a _puppies directory
|
||||
And I have the following documents under the puppies collection:
|
||||
| title | date | content | published |
|
||||
| Rover | 2007-12-31 | content for Rover. | true |
|
||||
| Figor | 2007-12-31 | content for Figor. | false |
|
||||
| Snowy | 2199-12-31 | content for Snowy. | true |
|
||||
| Hardy | 2199-12-31 | content for Hardy. | false |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: false
|
||||
"""
|
||||
And I have a "index.md" page that contains "{% for puppy in site.puppies %}<div>{{ puppy.title }}</div>{% endfor %}"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<div>Rover</div>" in "_site/index.html"
|
||||
But I should see "<div>Snowy</div>" in "_site/index.html"
|
||||
And I should not see "<div>Figor</div>" in "_site/index.html"
|
||||
And I should not see "<div>Hardy</div>" in "_site/index.html"
|
||||
And the "_site/puppies/rover.html" file should not exist
|
||||
And the "_site/puppies/figor.html" file should not exist
|
||||
And the "_site/puppies/snowy.html" file should not exist
|
||||
And the "_site/puppies/hardy.html" file should not exist
|
||||
When I run jekyll build --future
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<div>Rover</div>" in "_site/index.html"
|
||||
And I should see "<div>Snowy</div>" in "_site/index.html"
|
||||
And I should not see "<div>Figor</div>" in "_site/index.html"
|
||||
But I should not see "<div>Hardy</div>" in "_site/index.html"
|
||||
And the "_site/puppies/rover.html" file should not exist
|
||||
And the "_site/puppies/figor.html" file should not exist
|
||||
And the "_site/puppies/snowy.html" file should not exist
|
||||
And the "_site/puppies/hardy.html" file should not exist
|
||||
|
||||
Scenario: All the documents
|
||||
Given I have an "index.html" page that contains "All documents: {% for doc in site.documents %}{{ doc.relative_path }} {% endfor %}"
|
||||
And I have fixture collections
|
||||
|
||||
@@ -1,285 +0,0 @@
|
||||
Feature: Collections Directory
|
||||
As a hacker who likes to structure content without clutter
|
||||
I want to be able to organize my collections under a single directory
|
||||
And render them from there
|
||||
|
||||
Scenario: Custom collections_dir containing only posts
|
||||
And I have a collections/_posts directory
|
||||
And I have the following post within the "collections" directory:
|
||||
| title | date | content |
|
||||
| Gathered Post | 2009-03-27 | Random Content. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections_dir: collections
|
||||
"""
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "Random Content." in "_site/2009/03/27/gathered-post.html"
|
||||
|
||||
Scenario: Rendered collection in custom collections_dir also containing posts
|
||||
Given I have a collections/_puppies directory
|
||||
And I have the following document under the "puppies" collection within the "collections" directory:
|
||||
| title | date | content |
|
||||
| Rover | 2007-12-31 | content for Rover. |
|
||||
And I have a collections/_posts directory
|
||||
And I have the following post within the "collections" directory:
|
||||
| title | date | content |
|
||||
| Gathered Post | 2009-03-27 | Random Content. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: true
|
||||
|
||||
collections_dir: collections
|
||||
"""
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And the "_site/puppies/rover.html" file should exist
|
||||
And I should see "Random Content." in "_site/2009/03/27/gathered-post.html"
|
||||
|
||||
Scenario: Rendered collection in custom collections_dir with posts at the site root
|
||||
Given I have a collections/_puppies directory
|
||||
And I have the following document under the "puppies" collection within the "collections" directory:
|
||||
| title | date | content |
|
||||
| Rover | 2007-12-31 | content for Rover. |
|
||||
And I have a _posts directory
|
||||
And I have the following post:
|
||||
| title | date | content |
|
||||
| Post At Root | 2009-03-27 | Random Content. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: true
|
||||
|
||||
collections_dir: collections
|
||||
"""
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And the "_site/puppies/rover.html" file should exist
|
||||
And the "_site/2009/03/27/post-at-root.html" file should not exist
|
||||
And the _site/_posts directory should not exist
|
||||
|
||||
Scenario: Rendered collection in custom collections_dir also containing drafts
|
||||
Given I have a collections/_puppies directory
|
||||
And I have the following document under the "puppies" collection within the "collections" directory:
|
||||
| title | date | content |
|
||||
| Rover | 2007-12-31 | content for Rover. |
|
||||
And I have a collections/_drafts directory
|
||||
And I have the following draft within the "collections" directory:
|
||||
| title | date | content |
|
||||
| Gathered Draft | 2009-03-27 | Random Content. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: true
|
||||
|
||||
collections_dir: collections
|
||||
"""
|
||||
When I run jekyll build --drafts
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And the "_site/puppies/rover.html" file should exist
|
||||
And I should see "Random Content." in "_site/2009/03/27/gathered-draft.html"
|
||||
And the _site/collections directory should not exist
|
||||
|
||||
Scenario: Rendered collection in custom collections_dir with drafts at the site root
|
||||
Given I have a collections/_puppies directory
|
||||
And I have the following document under the "puppies" collection within the "collections" directory:
|
||||
| title | date | content |
|
||||
| Rover | 2007-12-31 | content for Rover. |
|
||||
And I have a _drafts directory
|
||||
And I have the following draft:
|
||||
| title | date | content |
|
||||
| Draft At Root | 2009-03-27 | Random Content. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: true
|
||||
|
||||
collections_dir: collections
|
||||
"""
|
||||
When I run jekyll build --drafts
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And the "_site/puppies/rover.html" file should exist
|
||||
And the "_site/2009/03/27/draft-at-root.html" file should not exist
|
||||
|
||||
Scenario: A complex site with collections posts and drafts at various locations
|
||||
Given I have a gathering/_puppies directory
|
||||
And I have a gathering/_posts directory
|
||||
And I have a gathering/_drafts directory
|
||||
And I have a _puppies directory
|
||||
And I have a _posts directory
|
||||
And I have a _drafts directory
|
||||
And I have the following document under the "puppies" collection within the "gathering" directory:
|
||||
| title | date | content |
|
||||
| Rover in Gathering | 2007-12-31 | content for Rover. |
|
||||
And I have the following document under the puppies collection:
|
||||
| title | date | content |
|
||||
| Rover At Root | 2007-12-31 | content for Rover. |
|
||||
And I have the following post within the "gathering" directory:
|
||||
| title | date | content |
|
||||
| Post in Gathering | 2009-03-27 | Totally nothing. |
|
||||
And I have the following post:
|
||||
| title | date | content |
|
||||
| Post At Root | 2009-03-27 | Totally nothing. |
|
||||
And I have the following draft within the "gathering" directory:
|
||||
| title | date | content |
|
||||
| Draft In Gathering | 2009-03-27 | This is a draft. |
|
||||
And I have the following draft:
|
||||
| title | date | content |
|
||||
| Draft At Root | 2009-03-27 | This is a draft. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: true
|
||||
|
||||
collections_dir: gathering
|
||||
"""
|
||||
And I have a "gathering/_puppies/static_file.txt" file that contains "Static content."
|
||||
And I have a gathering/_puppies/nested directory
|
||||
And I have a "gathering/_puppies/nested/static_file.txt" file that contains "Nested Static content."
|
||||
When I run jekyll build --drafts
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And the "_site/puppies/rover-in-gathering.html" file should exist
|
||||
And the "_site/2009/03/27/post-in-gathering.html" file should exist
|
||||
And the "_site/2009/03/27/draft-in-gathering.html" file should exist
|
||||
And the "_site/2009/03/27/draft-at-root.html" file should not exist
|
||||
And the "_site/puppies/rover-at-root.html" file should not exist
|
||||
And I should see exactly "Static content." in "_site/puppies/static_file.txt"
|
||||
And I should see exactly "Nested Static content." in "_site/puppies/nested/static_file.txt"
|
||||
And the _site/gathering directory should not exist
|
||||
And the _site/_posts directory should not exist
|
||||
|
||||
Scenario: Rendered collection with a document that includes a relative document
|
||||
Given I have a _puppies directory
|
||||
And I have the following documents under the puppies collection:
|
||||
| title | date | content |
|
||||
| INTRO | 2007-12-31 | excerpt for all docs. |
|
||||
| Rover | 2007-12-31 | {% include_relative intro.md %} |
|
||||
And I have a _posts directory
|
||||
And I have the following post:
|
||||
| title | date | content |
|
||||
| Gathered Post | 2009-03-27 | Random Content. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: true
|
||||
"""
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And the "_site/puppies/rover.html" file should exist
|
||||
And I should see "excerpt for all docs." in "_site/puppies/rover.html"
|
||||
And I should see "Random Content." in "_site/2009/03/27/gathered-post.html"
|
||||
|
||||
Scenario: Rendered collection in custom collections_dir with a document that includes a relative document
|
||||
Given I have a collections/_puppies directory
|
||||
And I have the following documents under the "puppies" collection within the "collections" directory:
|
||||
| title | date | content |
|
||||
| INTRO | 2007-12-31 | excerpt for all docs. |
|
||||
| Rover | 2007-12-31 | {% include_relative intro.md %} |
|
||||
And I have a collections/_posts directory
|
||||
And I have the following post within the "collections" directory:
|
||||
| title | date | content |
|
||||
| Gathered Post | 2009-03-27 | Random Content. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections:
|
||||
puppies:
|
||||
output: true
|
||||
|
||||
collections_dir: collections
|
||||
"""
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And the "_site/puppies/rover.html" file should exist
|
||||
And I should see "excerpt for all docs." in "_site/puppies/rover.html"
|
||||
And I should see "Random Content." in "_site/2009/03/27/gathered-post.html"
|
||||
|
||||
Scenario: Front matter defaults and custom collections directory
|
||||
Given I have a gathering/_players/managers directory
|
||||
And I have a gathering/_players/recruits directory
|
||||
And I have a gathering/_players/standby directory
|
||||
And I have the following documents nested inside "managers" directory under the "players" collection within the "gathering" directory:
|
||||
| title | content |
|
||||
| Tony Stark | content for Tony. |
|
||||
| Steve Rogers | content for Steve. |
|
||||
And I have the following documents nested inside "recruits" directory under the "players" collection within the "gathering" directory:
|
||||
| title | content |
|
||||
| Peter Parker | content for Peter. |
|
||||
| Wanda Maximoff | content for Wanda. |
|
||||
And I have the following documents nested inside "standby" directory under the "players" collection within the "gathering" directory:
|
||||
| title | content |
|
||||
| Thanos | content for Thanos. |
|
||||
| Loki | content for Loki. |
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
collections_dir: gathering
|
||||
collections: ["players"]
|
||||
defaults:
|
||||
- scope:
|
||||
path: ""
|
||||
type: players
|
||||
values:
|
||||
recruit: false
|
||||
manager: false
|
||||
villain: false
|
||||
- scope:
|
||||
path: gathering/_players/standby/thanos.md
|
||||
type: players
|
||||
values:
|
||||
villain: true
|
||||
- scope:
|
||||
path: gathering/_players/managers/*
|
||||
type: players
|
||||
values:
|
||||
manager: true
|
||||
- scope:
|
||||
path: gathering/_players/recruits/*
|
||||
type: players
|
||||
values:
|
||||
recruit: true
|
||||
"""
|
||||
And I have a "index.md" file with content:
|
||||
"""
|
||||
---
|
||||
---
|
||||
{% for player in site.players %}
|
||||
<p>{{ player.title }}: Manager: {{ player.manager }}</p>
|
||||
<p>{{ player.title }}: Recruit: {{ player.recruit }}</p>
|
||||
<p>{{ player.title }}: Villain: {{ player.villain }}</p>
|
||||
{% endfor %}
|
||||
"""
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<p>Tony Stark: Manager: true</p>" in "_site/index.html"
|
||||
And I should see "<p>Tony Stark: Recruit: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Tony Stark: Villain: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Peter Parker: Manager: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Peter Parker: Recruit: true</p>" in "_site/index.html"
|
||||
And I should see "<p>Peter Parker: Villain: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Steve Rogers: Manager: true</p>" in "_site/index.html"
|
||||
And I should see "<p>Steve Rogers: Recruit: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Steve Rogers: Villain: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Wanda Maximoff: Manager: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Wanda Maximoff: Recruit: true</p>" in "_site/index.html"
|
||||
And I should see "<p>Wanda Maximoff: Villain: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Thanos: Manager: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Thanos: Recruit: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Thanos: Villain: true</p>" in "_site/index.html"
|
||||
And I should see "<p>Loki: Manager: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Loki: Recruit: false</p>" in "_site/index.html"
|
||||
And I should see "<p>Loki: Villain: false</p>" in "_site/index.html"
|
||||
@@ -104,28 +104,3 @@ Feature: Include tags
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "include" in "_site/index.html"
|
||||
|
||||
Scenario: Include a file-path with non-alphanumeric character sequences
|
||||
Given I have an _includes directory
|
||||
And I have an "_includes/header-en.html" file that contains "include"
|
||||
And I have an "index.html" page that contains "{% include ./header-en.html %}"
|
||||
When I run jekyll build
|
||||
Then I should get a non-zero exit status
|
||||
And I should see "Invalid syntax for include tag." in the build output
|
||||
When I have an "index.html" page that contains "{% include foo/.header-en.html %}"
|
||||
When I run jekyll build
|
||||
Then I should get a non-zero exit status
|
||||
And I should see "Invalid syntax for include tag." in the build output
|
||||
When I have an "index.html" page that contains "{% include //header-en.html %}"
|
||||
When I run jekyll build
|
||||
Then I should get a non-zero exit status
|
||||
And I should see "Invalid syntax for include tag." in the build output
|
||||
When I have an "index.html" page that contains "{% include ..header-en.html %}"
|
||||
When I run jekyll build
|
||||
Then I should get a non-zero exit status
|
||||
And I should see "Invalid syntax for include tag." in the build output
|
||||
When I have an "index.html" page that contains "{% include header-en.html %}"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "include" in "_site/index.html"
|
||||
|
||||
@@ -66,20 +66,3 @@ Feature: Incremental rebuild
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "Basic Site with include tag: Regenerated by Jekyll" in "_site/index.html"
|
||||
|
||||
Scenario: A themed-site and incremental regeneration
|
||||
Given I have a configuration file with "theme" set to "test-theme"
|
||||
And I have an "index.md" page that contains "Themed site"
|
||||
When I run jekyll build --incremental --verbose
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "Rendering: index.md" in the build output
|
||||
And I should see "Themed site" in "_site/index.html"
|
||||
When I wait 1 second
|
||||
And I have an "about.md" page that contains "About Themed site"
|
||||
When I run jekyll build --incremental --verbose
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should not see "Rendering: index.md" in the build output
|
||||
But I should see "Themed site" in "_site/index.html"
|
||||
And I should see "About Themed site" in "_site/about.html"
|
||||
|
||||
@@ -1,78 +0,0 @@
|
||||
Feature: Link Tag
|
||||
As a hacker who likes to write a variety of content
|
||||
I want to be able to link to pages and documents
|
||||
And render them without much hassle
|
||||
|
||||
Scenario: Basic site with two pages
|
||||
Given I have an "index.md" page that contains "[About my projects]({% link about.md %})"
|
||||
And I have an "about.md" page that contains "[Home]({% link index.md %})"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<p><a href=\"/about.html\">About my projects</a></p>" in "_site/index.html"
|
||||
And I should see "<p><a href=\"/\">Home</a></p>" in "_site/about.html"
|
||||
|
||||
Scenario: Basic site with custom page-permalinks
|
||||
Given I have an "index.md" page that contains "[About my projects]({% link about.md %})"
|
||||
And I have an "about.md" page with permalink "/about/" that contains "[Home]({% link index.md %})"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<p><a href=\"/about/\">About my projects</a></p>" in "_site/index.html"
|
||||
And I should see "<p><a href=\"/\">Home</a></p>" in "_site/about/index.html"
|
||||
|
||||
Scenario: Basic site with custom site-wide-permalinks
|
||||
Given I have an "index.md" page that contains "[About my projects]({% link about.md %})"
|
||||
And I have an "about.md" page that contains "[Home]({% link index.md %})"
|
||||
And I have a configuration file with "permalink" set to "pretty"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<p><a href=\"/about/\">About my projects</a></p>" in "_site/index.html"
|
||||
And I should see "<p><a href=\"/\">Home</a></p>" in "_site/about/index.html"
|
||||
|
||||
Scenario: Basic site with two pages and custom baseurl
|
||||
Given I have an "index.md" page that contains "[About my projects]({% link about.md %})"
|
||||
And I have an "about.md" page that contains "[Home]({% link index.md %})"
|
||||
And I have a configuration file with "baseurl" set to "/blog"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<p><a href=\"/about.html\">About my projects</a></p>" in "_site/index.html"
|
||||
And I should see "<p><a href=\"/\">Home</a></p>" in "_site/about.html"
|
||||
|
||||
Scenario: Basic site with two pages and custom baseurl and permalinks
|
||||
Given I have an "index.md" page that contains "[About my projects]({% link about.md %})"
|
||||
And I have an "about.md" page that contains "[Home]({% link index.md %})"
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
baseurl: /blog
|
||||
permalink: pretty
|
||||
"""
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<p><a href=\"/about/\">About my projects</a></p>" in "_site/index.html"
|
||||
And I should see "<p><a href=\"/\">Home</a></p>" in "_site/about/index.html"
|
||||
|
||||
Scenario: Linking to a ghost file
|
||||
Given I have an "index.md" page that contains "[About my projects]({% link about.md %})"
|
||||
And I have an "about.md" page that contains "[Contact]({% link contact.md %})"
|
||||
When I run jekyll build
|
||||
Then I should get a non-zero exit status
|
||||
And the _site directory should not exist
|
||||
And I should see "Could not find document 'contact.md' in tag 'link'" in the build output
|
||||
|
||||
Scenario: Complex site with a variety of files
|
||||
Given I have an "index.md" page that contains "[About my projects]({% link about.md %})"
|
||||
And I have an "about.md" page that contains "[Latest Hack]({% link _posts/2018-02-15-metaprogramming.md %})"
|
||||
And I have a _posts directory
|
||||
And I have an "_posts/2018-02-15-metaprogramming.md" page that contains "[Download This]({% link script.txt %})"
|
||||
And I have a "script.txt" file that contains "Static Alert!"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<p><a href=\"/about.html\">About my projects</a></p>" in "_site/index.html"
|
||||
And I should see "<p><a href=\"/2018/02/15/metaprogramming.html\">Latest Hack</a></p>" in "_site/about.html"
|
||||
And I should see "<p><a href=\"/script.txt\">Download This</a></p>" in "_site/2018/02/15/metaprogramming.html"
|
||||
And I should see "Static Alert!" in "_site/script.txt"
|
||||
@@ -71,14 +71,14 @@ Feature: Fancy permalinks
|
||||
And I should see "Totally custom." in "_site/03-27-2009/custom-permalink-schema.html"
|
||||
|
||||
Scenario: Use custom permalink schema with date and time
|
||||
Given I have a configuration file with:
|
||||
| key | value |
|
||||
| permalink | "/:year:month:day:hour:minute:second.html" |
|
||||
| timezone | UTC |
|
||||
And I have a _posts directory
|
||||
Given I have a _posts directory
|
||||
And I have the following post:
|
||||
| title | category | date | content |
|
||||
| Custom Permalink Schema | stuff | 2009-03-27 22:31:07 | Totally custom. |
|
||||
And I have a configuration file with:
|
||||
| key | value |
|
||||
| permalink | "/:year:month:day:hour:minute:second.html" |
|
||||
| timezone | UTC |
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
|
||||
@@ -34,25 +34,6 @@ Feature: Post excerpts
|
||||
And I should see exactly "<p>content for entry1.</p>" in "_site/2007/12/31/entry1.html"
|
||||
And I should see exactly "<p>content for entry1.</p>" in "_site/index.html"
|
||||
|
||||
Scenario: An excerpt with Liquid constructs from a post with a layout
|
||||
Given I have an "index.html" page that contains "{% for post in site.posts %}{{ post.excerpt }}{% endfor %}"
|
||||
And I have a configuration file with "baseurl" set to "/blog"
|
||||
And I have a _posts directory
|
||||
And I have a _layouts directory
|
||||
And I have a post layout that contains "{{ page.excerpt }}"
|
||||
And I have the following posts:
|
||||
| title | date | layout | content |
|
||||
| entry1 | 2007-12-31 | post | {{ 'assets/style.css' \| relative_url }} |
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And the _site/2007 directory should exist
|
||||
And the _site/2007/12 directory should exist
|
||||
And the _site/2007/12/31 directory should exist
|
||||
And the "_site/2007/12/31/entry1.html" file should exist
|
||||
And I should see exactly "<p>/blog/assets/style.css</p>" in "_site/2007/12/31/entry1.html"
|
||||
And I should see exactly "<p>/blog/assets/style.css</p>" in "_site/index.html"
|
||||
|
||||
Scenario: An excerpt from a post with a layout which has context
|
||||
Given I have an "index.html" page that contains "{% for post in site.posts %}{{ post.excerpt }}{% endfor %}"
|
||||
And I have a _posts directory
|
||||
|
||||
@@ -30,50 +30,6 @@ Feature: Rendering
|
||||
Then I should get a non-zero exit-status
|
||||
And I should see "Liquid Exception: Liquid error \(.+/_includes/invalid\.html line 1\): wrong number of arguments (\(given 1, expected 2\)|\(1 for 2\)) included in index\.html" in the build output
|
||||
|
||||
Scenario: Rendering a default site containing a file with rogue Liquid constructs
|
||||
Given I have a "index.html" page with title "Simple Test" that contains "{{ page.title | foobar }}\n\n{{ page.author }}"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit-status
|
||||
And I should not see "Liquid Exception:" in the build output
|
||||
|
||||
Scenario: Rendering a custom site containing a file with a non-existent Liquid variable
|
||||
Given I have a "index.html" file with content:
|
||||
"""
|
||||
---
|
||||
title: Simple Test
|
||||
---
|
||||
{{ page.title }}
|
||||
|
||||
{{ page.author }}
|
||||
"""
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
liquid:
|
||||
strict_variables: true
|
||||
"""
|
||||
When I run jekyll build
|
||||
Then I should get a non-zero exit-status
|
||||
And I should see "Liquid error \(line 3\): undefined variable author in index.html" in the build output
|
||||
|
||||
Scenario: Rendering a custom site containing a file with a non-existent Liquid filter
|
||||
Given I have a "index.html" file with content:
|
||||
"""
|
||||
---
|
||||
author: John Doe
|
||||
---
|
||||
{{ page.title }}
|
||||
|
||||
{{ page.author | foobar }}
|
||||
"""
|
||||
And I have a "_config.yml" file with content:
|
||||
"""
|
||||
liquid:
|
||||
strict_filters: true
|
||||
"""
|
||||
When I run jekyll build
|
||||
Then I should get a non-zero exit-status
|
||||
And I should see "Liquid error \(line 3\): undefined filter foobar in index.html" in the build output
|
||||
|
||||
Scenario: Render Liquid and place in layout
|
||||
Given I have a "index.html" page with layout "simple" that contains "Hi there, Jekyll {{ jekyll.environment }}!"
|
||||
And I have a simple layout that contains "{{ content }}Ahoy, indeed!"
|
||||
|
||||
@@ -81,6 +81,14 @@ Feature: Site configuration
|
||||
And the _site directory should exist
|
||||
And I should see "<a href=\"https://www.google.com\">Google</a>" in "_site/index.html"
|
||||
|
||||
Scenario: Use Redcarpet for markup
|
||||
Given I have an "index.markdown" page that contains "[Google](https://www.google.com)"
|
||||
And I have a configuration file with "markdown" set to "redcarpet"
|
||||
When I run jekyll build
|
||||
Then I should get a zero exit status
|
||||
And the _site directory should exist
|
||||
And I should see "<a href=\"https://www.google.com\">Google</a>" in "_site/index.html"
|
||||
|
||||
Scenario: Highlight code with pygments
|
||||
Given I have an "index.html" page that contains "{% highlight ruby %} puts 'Hello world!' {% endhighlight %}"
|
||||
When I run jekyll build
|
||||
|
||||
@@ -4,7 +4,6 @@ Before do
|
||||
FileUtils.rm_rf(Paths.test_dir) if Paths.test_dir.exist?
|
||||
FileUtils.mkdir_p(Paths.test_dir) unless Paths.test_dir.directory?
|
||||
Dir.chdir(Paths.test_dir)
|
||||
@timezone_before_scenario = ENV["TZ"]
|
||||
end
|
||||
|
||||
#
|
||||
@@ -14,7 +13,6 @@ After do
|
||||
Paths.output_file.delete if Paths.output_file.exist?
|
||||
Paths.status_file.delete if Paths.status_file.exist?
|
||||
Dir.chdir(Paths.test_dir.parent)
|
||||
ENV["TZ"] = @timezone_before_scenario
|
||||
end
|
||||
|
||||
#
|
||||
@@ -36,7 +34,7 @@ end
|
||||
Given(%r!^I have an? "(.*)" page(?: with (.*) "(.*)")? that contains "(.*)"$!) do |file, key, value, text|
|
||||
File.write(file, Jekyll::Utils.strip_heredoc(<<-DATA))
|
||||
---
|
||||
#{key || "layout"}: #{value || "none"}
|
||||
#{key || "layout"}: #{value || "nil"}
|
||||
---
|
||||
|
||||
#{text}
|
||||
@@ -87,7 +85,6 @@ Given(%r!^I have the following (draft|page|post)s?(?: (in|under) "([^"]+)")?:$!)
|
||||
|
||||
if status == "post"
|
||||
parsed_date = Time.xmlschema(input_hash["date"]) rescue Time.parse(input_hash["date"])
|
||||
input_hash["date"] = parsed_date
|
||||
filename = "#{parsed_date.strftime("%Y-%m-%d")}-#{title}.#{ext}"
|
||||
end
|
||||
|
||||
@@ -98,20 +95,6 @@ end
|
||||
|
||||
#
|
||||
|
||||
Given(%r!^I have the following (draft|post)s? within the "(.*)" directory:$!) do |type, folder, table|
|
||||
table.hashes.each do |input_hash|
|
||||
title = slug(input_hash["title"])
|
||||
parsed_date = Time.xmlschema(input_hash["date"]) rescue Time.parse(input_hash["date"])
|
||||
|
||||
filename = type == "draft" ? "#{title}.markdown" : "#{parsed_date.strftime("%Y-%m-%d")}-#{title}.markdown"
|
||||
|
||||
path = File.join(folder, "_#{type}s", filename)
|
||||
File.write(path, file_content_from_hash(input_hash))
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
|
||||
Given(%r!^I have the following documents? under the (.*) collection:$!) do |folder, table|
|
||||
table.hashes.each do |input_hash|
|
||||
title = slug(input_hash["title"])
|
||||
@@ -125,26 +108,6 @@ end
|
||||
|
||||
#
|
||||
|
||||
Given(%r!^I have the following documents? under the "(.*)" collection within the "(.*)" directory:$!) do |label, dir, table|
|
||||
table.hashes.each do |input_hash|
|
||||
title = slug(input_hash["title"])
|
||||
path = File.join(dir, "_#{label}", "#{title}.md")
|
||||
File.write(path, file_content_from_hash(input_hash))
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
|
||||
Given(%r!^I have the following documents? nested inside "(.*)" directory under the "(.*)" collection within the "(.*)" directory:$!) do |subdir, label, dir, table|
|
||||
table.hashes.each do |input_hash|
|
||||
title = slug(input_hash["title"])
|
||||
path = File.join(dir, "_#{label}", subdir, "#{title}.md")
|
||||
File.write(path, file_content_from_hash(input_hash))
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
|
||||
Given(%r!^I have a configuration file with "(.*)" set to "(.*)"$!) do |key, value|
|
||||
config = \
|
||||
if source_dir.join("_config.yml").exist?
|
||||
@@ -153,7 +116,6 @@ Given(%r!^I have a configuration file with "(.*)" set to "(.*)"$!) do |key, valu
|
||||
{}
|
||||
end
|
||||
config[key] = YAML.load(value)
|
||||
Jekyll.set_timezone(value) if key == "timezone"
|
||||
File.write("_config.yml", YAML.dump(config))
|
||||
end
|
||||
|
||||
@@ -226,6 +188,8 @@ end
|
||||
|
||||
When(%r!^I decide to build the theme gem$!) do
|
||||
Dir.chdir(Paths.theme_gem_dir)
|
||||
gemspec = "my-cool-theme.gemspec"
|
||||
File.write(gemspec, File.read(gemspec).sub("TODO: ", ""))
|
||||
File.new("_includes/blank.html", "w")
|
||||
File.new("_sass/blank.scss", "w")
|
||||
File.new("assets/blank.scss", "w")
|
||||
|
||||
@@ -17,7 +17,7 @@ Feature: Building Theme Gems
|
||||
Then the "assets/blank.scss" file should exist
|
||||
When I run git add .
|
||||
Then I should get an updated git index
|
||||
When I run gem build --force my-cool-theme.gemspec
|
||||
When I run gem build my-cool-theme.gemspec
|
||||
Then the "./my-cool-theme-0.1.0.gem" file should exist
|
||||
When I run gem unpack my-cool-theme-0.1.0.gem
|
||||
Then the my-cool-theme-0.1.0 directory should exist
|
||||
|
||||
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
|
||||
s.specification_version = 2 if s.respond_to? :specification_version=
|
||||
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
||||
s.rubygems_version = "2.2.2"
|
||||
s.required_ruby_version = ">= 2.3.0"
|
||||
s.required_ruby_version = ">= 2.1.0"
|
||||
|
||||
s.name = "jekyll"
|
||||
s.version = Jekyll::VERSION
|
||||
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
|
||||
s.homepage = "https://github.com/jekyll/jekyll"
|
||||
|
||||
all_files = `git ls-files -z`.split("\x0")
|
||||
s.files = all_files.grep(%r!^(exe|lib|rubocop)/|^.rubocop.yml$!)
|
||||
s.files = all_files.grep(%r!^(exe|lib)/|^.rubocop.yml$!)
|
||||
s.executables = all_files.grep(%r!^exe/!) { |f| File.basename(f) }
|
||||
s.bindir = "exe"
|
||||
s.require_paths = ["lib"]
|
||||
@@ -33,13 +33,14 @@ Gem::Specification.new do |s|
|
||||
s.add_runtime_dependency("addressable", "~> 2.4")
|
||||
s.add_runtime_dependency("colorator", "~> 1.0")
|
||||
s.add_runtime_dependency("em-websocket", "~> 0.5")
|
||||
s.add_runtime_dependency("i18n", "~> 1.0")
|
||||
s.add_runtime_dependency("i18n", "~> 0.7")
|
||||
s.add_runtime_dependency("jekyll-sass-converter", "~> 1.0")
|
||||
s.add_runtime_dependency("jekyll-watch", "~> 2.0")
|
||||
s.add_runtime_dependency("kramdown", "~> 1.14")
|
||||
s.add_runtime_dependency("liquid", "~> 4.0")
|
||||
s.add_runtime_dependency("mercenary", "~> 0.3.3")
|
||||
s.add_runtime_dependency("pathutil", "~> 0.9")
|
||||
s.add_runtime_dependency("rouge", "~> 3.0")
|
||||
rouge_versions = ENV["ROUGE_VERSION"] ? ["~> #{ENV["ROUGE_VERSION"]}"] : [">= 1.7", "< 4"]
|
||||
s.add_runtime_dependency("rouge", *rouge_versions)
|
||||
s.add_runtime_dependency("safe_yaml", "~> 1.0")
|
||||
end
|
||||
|
||||
@@ -18,6 +18,7 @@ end
|
||||
require "rubygems"
|
||||
|
||||
# stdlib
|
||||
require "pathutil"
|
||||
require "forwardable"
|
||||
require "fileutils"
|
||||
require "time"
|
||||
@@ -25,12 +26,8 @@ require "English"
|
||||
require "pathname"
|
||||
require "logger"
|
||||
require "set"
|
||||
require "csv"
|
||||
require "json"
|
||||
|
||||
# 3rd party
|
||||
require "pathutil"
|
||||
require "addressable/uri"
|
||||
require "safe_yaml/load"
|
||||
require "liquid"
|
||||
require "kramdown"
|
||||
@@ -38,6 +35,7 @@ require "colorator"
|
||||
require "i18n"
|
||||
|
||||
SafeYAML::OPTIONS[:suppress_warnings] = true
|
||||
I18n.config.available_locales = :en
|
||||
|
||||
module Jekyll
|
||||
# internal requires
|
||||
@@ -65,6 +63,7 @@ module Jekyll
|
||||
autoload :Page, "jekyll/page"
|
||||
autoload :PageWithoutAFile, "jekyll/page_without_a_file"
|
||||
autoload :PluginManager, "jekyll/plugin_manager"
|
||||
autoload :Profiler, "jekyll/profiler"
|
||||
autoload :Publisher, "jekyll/publisher"
|
||||
autoload :Reader, "jekyll/reader"
|
||||
autoload :Regenerator, "jekyll/regenerator"
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "set"
|
||||
|
||||
module Jekyll
|
||||
# Handles the cleanup of a site's destination before it is built.
|
||||
class Cleaner
|
||||
@@ -55,9 +57,9 @@ module Jekyll
|
||||
#
|
||||
# Returns a Set with the file paths
|
||||
def new_files
|
||||
@new_files ||= Set.new.tap do |files|
|
||||
site.each_site_file { |item| files << item.destination(site.dest) }
|
||||
end
|
||||
files = Set.new
|
||||
site.each_site_file { |item| files << item.destination(site.dest) }
|
||||
files
|
||||
end
|
||||
|
||||
# Private: The list of directories to be created when site is built.
|
||||
@@ -65,7 +67,7 @@ module Jekyll
|
||||
#
|
||||
# Returns a Set with the directory paths
|
||||
def new_dirs
|
||||
@new_dirs ||= new_files.map { |file| parent_dirs(file) }.flatten.to_set
|
||||
new_files.map { |file| parent_dirs(file) }.flatten.to_set
|
||||
end
|
||||
|
||||
# Private: The list of parent directories of a given file
|
||||
|
||||
@@ -95,13 +95,14 @@ module Jekyll
|
||||
end
|
||||
end
|
||||
|
||||
# The directory for this Collection, relative to the site source or the directory
|
||||
# containing the collection.
|
||||
# The directory for this Collection, relative to the site source.
|
||||
#
|
||||
# Returns a String containing the directory name where the collection
|
||||
# is stored on the filesystem.
|
||||
def relative_directory
|
||||
@relative_directory ||= "_#{label}"
|
||||
@relative_directory ||= Pathname.new(directory).relative_path_from(
|
||||
Pathname.new(site.source)
|
||||
).to_s
|
||||
end
|
||||
|
||||
# The full path to the directory containing the collection.
|
||||
@@ -110,7 +111,7 @@ module Jekyll
|
||||
# is stored on the filesystem.
|
||||
def directory
|
||||
@directory ||= site.in_source_dir(
|
||||
File.join(container, relative_directory)
|
||||
File.join(site.config["collections_dir"], "_#{label}")
|
||||
)
|
||||
end
|
||||
|
||||
@@ -124,7 +125,7 @@ module Jekyll
|
||||
# is stored on the filesystem.
|
||||
def collection_dir(*files)
|
||||
return directory if files.empty?
|
||||
site.in_source_dir(container, relative_directory, *files)
|
||||
site.in_source_dir(relative_directory, *files)
|
||||
end
|
||||
|
||||
# Checks whether the directory "exists" for this collection.
|
||||
@@ -203,16 +204,14 @@ module Jekyll
|
||||
|
||||
private
|
||||
|
||||
def container
|
||||
@container ||= site.config["collections_dir"]
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def read_document(full_path)
|
||||
doc = Document.new(full_path, :site => site, :collection => self)
|
||||
doc = Jekyll::Document.new(full_path, :site => site, :collection => self)
|
||||
doc.read
|
||||
docs << doc unless doc.data["published"] == false
|
||||
if site.publisher.publish?(doc) || !write?
|
||||
docs << doc
|
||||
else
|
||||
Jekyll.logger.debug "Skipped From Publishing:", doc.relative_path
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
@@ -45,58 +45,34 @@ module Jekyll
|
||||
|
||||
# Add common options to a command for building configuration
|
||||
#
|
||||
# cmd - the Jekyll::Command to add these options to
|
||||
# c - the Jekyll::Command to add these options to
|
||||
#
|
||||
# Returns nothing
|
||||
# rubocop:disable Metrics/MethodLength
|
||||
def add_build_options(cmd)
|
||||
cmd.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]",
|
||||
def add_build_options(c)
|
||||
c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]",
|
||||
Array, "Custom configuration file"
|
||||
cmd.option "destination", "-d", "--destination DESTINATION",
|
||||
c.option "destination", "-d", "--destination DESTINATION",
|
||||
"The current folder will be generated into DESTINATION"
|
||||
cmd.option "source", "-s", "--source SOURCE", "Custom source directory"
|
||||
cmd.option "future", "--future", "Publishes posts with a future date"
|
||||
cmd.option "limit_posts", "--limit_posts MAX_POSTS", Integer,
|
||||
c.option "source", "-s", "--source SOURCE", "Custom source directory"
|
||||
c.option "future", "--future", "Publishes posts with a future date"
|
||||
c.option "limit_posts", "--limit_posts MAX_POSTS", Integer,
|
||||
"Limits the number of posts to parse and publish"
|
||||
cmd.option "watch", "-w", "--[no-]watch", "Watch for changes and rebuild"
|
||||
cmd.option "baseurl", "-b", "--baseurl URL",
|
||||
c.option "watch", "-w", "--[no-]watch", "Watch for changes and rebuild"
|
||||
c.option "baseurl", "-b", "--baseurl URL",
|
||||
"Serve the website from the given base URL"
|
||||
cmd.option "force_polling", "--force_polling", "Force watch to use polling"
|
||||
cmd.option "lsi", "--lsi", "Use LSI for improved related posts"
|
||||
cmd.option "show_drafts", "-D", "--drafts", "Render posts in the _drafts folder"
|
||||
cmd.option "unpublished", "--unpublished",
|
||||
c.option "force_polling", "--force_polling", "Force watch to use polling"
|
||||
c.option "lsi", "--lsi", "Use LSI for improved related posts"
|
||||
c.option "show_drafts", "-D", "--drafts", "Render posts in the _drafts folder"
|
||||
c.option "unpublished", "--unpublished",
|
||||
"Render posts that were marked as unpublished"
|
||||
cmd.option "quiet", "-q", "--quiet", "Silence output."
|
||||
cmd.option "verbose", "-V", "--verbose", "Print verbose output."
|
||||
cmd.option "incremental", "-I", "--incremental", "Enable incremental rebuild."
|
||||
cmd.option "strict_front_matter", "--strict_front_matter",
|
||||
c.option "quiet", "-q", "--quiet", "Silence output."
|
||||
c.option "verbose", "-V", "--verbose", "Print verbose output."
|
||||
c.option "incremental", "-I", "--incremental", "Enable incremental rebuild."
|
||||
c.option "strict_front_matter", "--strict_front_matter",
|
||||
"Fail if errors are present in front matter"
|
||||
end
|
||||
# rubocop:enable Metrics/MethodLength
|
||||
|
||||
# Run ::process method in a given set of Jekyll::Command subclasses and suggest
|
||||
# re-running the associated command with --trace switch to obtain any additional
|
||||
# information or backtrace regarding the encountered Exception.
|
||||
#
|
||||
# cmd - the Jekyll::Command to be handled
|
||||
# options - configuration overrides
|
||||
# klass - an array of Jekyll::Command subclasses associated with the command
|
||||
#
|
||||
# Note that all exceptions are rescued..
|
||||
# rubocop: disable RescueException
|
||||
def process_with_graceful_fail(cmd, options, *klass)
|
||||
klass.each { |k| k.process(options) if k.respond_to?(:process) }
|
||||
rescue Exception => e
|
||||
raise e if cmd.trace
|
||||
|
||||
msg = " Please append `--trace` to the `#{cmd.name}` command "
|
||||
dashes = "-" * msg.length
|
||||
Jekyll.logger.error "", dashes
|
||||
Jekyll.logger.error "Jekyll #{Jekyll::VERSION} ", msg
|
||||
Jekyll.logger.error "", " for any additional information or backtrace. "
|
||||
Jekyll.logger.abort_with "", dashes
|
||||
end
|
||||
# rubocop: enable RescueException
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -15,7 +15,7 @@ module Jekyll
|
||||
|
||||
c.action do |_, options|
|
||||
options["serving"] = false
|
||||
process_with_graceful_fail(c, options, self)
|
||||
Jekyll::Commands::Build.process(options)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "addressable/uri"
|
||||
|
||||
module Jekyll
|
||||
module Commands
|
||||
class Doctor < Command
|
||||
@@ -39,22 +41,9 @@ module Jekyll
|
||||
!conflicting_urls(site),
|
||||
!urls_only_differ_by_case(site),
|
||||
proper_site_url?(site),
|
||||
properly_gathered_posts?(site),
|
||||
].all?
|
||||
end
|
||||
|
||||
def properly_gathered_posts?(site)
|
||||
return true if site.config["collections_dir"].empty?
|
||||
posts_at_root = site.in_source_dir("_posts")
|
||||
return true unless File.directory?(posts_at_root)
|
||||
Jekyll.logger.warn "Warning:",
|
||||
"Detected '_posts' directory outside custom `collections_dir`!"
|
||||
Jekyll.logger.warn "",
|
||||
"Please move '#{posts_at_root}' into the custom directory at " \
|
||||
"'#{site.in_source_dir(site.config["collections_dir"])}'"
|
||||
false
|
||||
end
|
||||
|
||||
def deprecated_relative_permalinks(site)
|
||||
if site.config["relative_permalinks"]
|
||||
Jekyll::Deprecator.deprecation_message "Your site still uses relative" \
|
||||
|
||||
@@ -12,9 +12,9 @@ module Jekyll
|
||||
c.action do |args, _|
|
||||
cmd = (args.first || "").to_sym
|
||||
if args.empty?
|
||||
Jekyll.logger.info prog.to_s
|
||||
puts prog
|
||||
elsif prog.has_command? cmd
|
||||
Jekyll.logger.info prog.commands[cmd].to_s
|
||||
puts prog.commands[cmd]
|
||||
else
|
||||
invalid_command(prog, cmd)
|
||||
abort
|
||||
|
||||
@@ -27,9 +27,8 @@ module Jekyll
|
||||
new_blog_path = File.expand_path(args.join(" "), Dir.pwd)
|
||||
FileUtils.mkdir_p new_blog_path
|
||||
if preserve_source_location?(new_blog_path, options)
|
||||
Jekyll.logger.error "Conflict:", "#{new_blog_path} exists and is not empty."
|
||||
Jekyll.logger.abort_with "", "Ensure #{new_blog_path} is empty or else " \
|
||||
"try again with `--force` to proceed and overwrite any files."
|
||||
Jekyll.logger.abort_with "Conflict:",
|
||||
"#{new_blog_path} exists and is not empty."
|
||||
end
|
||||
|
||||
if options["blank"]
|
||||
@@ -90,9 +89,6 @@ end
|
||||
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||
gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
|
||||
|
||||
# Performance-booster for watching directories on Windows
|
||||
gem "wdm", "~> 0.1.0" if Gem.win_platform?
|
||||
|
||||
RUBY
|
||||
end
|
||||
|
||||
|
||||
@@ -70,27 +70,35 @@ module Jekyll
|
||||
cmd.action do |_, opts|
|
||||
opts["livereload_port"] ||= LIVERELOAD_PORT
|
||||
opts["serving"] = true
|
||||
opts["watch"] = true unless opts.key?("watch")
|
||||
opts["watch" ] = true unless opts.key?("watch")
|
||||
|
||||
# Set the reactor to nil so any old reactor will be GCed.
|
||||
# We can't unregister a hook so while running tests we don't want to
|
||||
# inadvertently keep using a reactor created by a previous test.
|
||||
@reload_reactor = nil
|
||||
|
||||
config = configuration_from_options(opts)
|
||||
config["url"] = default_url(config) if Jekyll.env == "development"
|
||||
|
||||
process_with_graceful_fail(cmd, config, Build, Serve)
|
||||
start(opts)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
|
||||
def start(opts)
|
||||
# Set the reactor to nil so any old reactor will be GCed.
|
||||
# We can't unregister a hook so in testing when Serve.start is
|
||||
# called multiple times we don't want to inadvertently keep using
|
||||
# a reactor created by a previous test when our test might not
|
||||
@reload_reactor = nil
|
||||
|
||||
register_reload_hooks(opts) if opts["livereload"]
|
||||
config = configuration_from_options(opts)
|
||||
if Jekyll.env == "development"
|
||||
config["url"] = default_url(config)
|
||||
end
|
||||
[Build, Serve].each { |klass| klass.process(config) }
|
||||
end
|
||||
|
||||
#
|
||||
|
||||
def process(opts)
|
||||
opts = configuration_from_options(opts)
|
||||
destination = opts["destination"]
|
||||
register_reload_hooks(opts) if opts["livereload"]
|
||||
setup(destination)
|
||||
|
||||
start_up_webrick(opts, destination)
|
||||
@@ -165,7 +173,6 @@ module Jekyll
|
||||
@changed_pages = nil
|
||||
end
|
||||
end
|
||||
# rubocop:enable Metrics/AbcSize
|
||||
|
||||
# Do a base pre-setup of WEBRick so that everything is in place
|
||||
# when we get ready to party, checking for an setting up an error page
|
||||
@@ -329,7 +336,7 @@ module Jekyll
|
||||
require "webrick/https"
|
||||
|
||||
opts[:SSLCertificate] = OpenSSL::X509::Certificate.new(read_file(src, cert))
|
||||
opts[:SSLPrivateKey] = OpenSSL::PKey::RSA.new(read_file(src, key))
|
||||
opts[:SSLPrivateKey ] = OpenSSL::PKey::RSA.new(read_file(src, key))
|
||||
opts[:SSLEnable] = true
|
||||
end
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "json"
|
||||
require "em-websocket"
|
||||
|
||||
require_relative "websockets"
|
||||
@@ -13,6 +14,7 @@ module Jekyll
|
||||
attr_reader :thread
|
||||
|
||||
def initialize
|
||||
@thread = nil
|
||||
@websockets = []
|
||||
@connections_count = 0
|
||||
@started_event = Utils::ThreadEvent.new
|
||||
@@ -23,26 +25,40 @@ module Jekyll
|
||||
# There is only one EventMachine instance per Ruby process so stopping
|
||||
# it here will stop the reactor thread we have running.
|
||||
EM.stop if EM.reactor_running?
|
||||
Jekyll.logger.debug "LiveReload Server:", "halted"
|
||||
Jekyll.logger.debug("LiveReload Server:", "halted")
|
||||
end
|
||||
|
||||
def running?
|
||||
EM.reactor_running?
|
||||
end
|
||||
|
||||
def handle_websockets_event(websocket)
|
||||
websocket.onopen { |handshake| connect(websocket, handshake) }
|
||||
websocket.onclose { disconnect(websocket) }
|
||||
websocket.onmessage { |msg| print_message(msg) }
|
||||
websocket.onerror { |error| log_error(error) }
|
||||
def handle_websockets_event(ws)
|
||||
ws.onopen do |handshake|
|
||||
connect(ws, handshake)
|
||||
end
|
||||
|
||||
ws.onclose do
|
||||
disconnect(ws)
|
||||
end
|
||||
|
||||
ws.onmessage do |msg|
|
||||
print_message(msg)
|
||||
end
|
||||
|
||||
ws.onerror do |error|
|
||||
log_error(error)
|
||||
end
|
||||
end
|
||||
|
||||
# rubocop:disable Metrics/MethodLength
|
||||
def start(opts)
|
||||
@thread = Thread.new do
|
||||
# Use epoll if the kernel supports it
|
||||
EM.epoll
|
||||
EM.run do
|
||||
EM.error_handler { |e| log_error(e) }
|
||||
EM.error_handler do |e|
|
||||
log_error(e)
|
||||
end
|
||||
|
||||
EM.start_server(
|
||||
opts["host"],
|
||||
@@ -54,11 +70,17 @@ module Jekyll
|
||||
end
|
||||
|
||||
# Notify blocked threads that EventMachine has started or shutdown
|
||||
EM.schedule { @started_event.set }
|
||||
EM.add_shutdown_hook { @stopped_event.set }
|
||||
EM.schedule do
|
||||
@started_event.set
|
||||
end
|
||||
|
||||
Jekyll.logger.info "LiveReload address:",
|
||||
"http://#{opts["host"]}:#{opts["livereload_port"]}"
|
||||
EM.add_shutdown_hook do
|
||||
@stopped_event.set
|
||||
end
|
||||
|
||||
Jekyll.logger.info(
|
||||
"LiveReload address:", "#{opts["host"]}:#{opts["livereload_port"]}"
|
||||
)
|
||||
end
|
||||
end
|
||||
@thread.abort_on_exception = true
|
||||
@@ -68,27 +90,29 @@ module Jekyll
|
||||
# http://feedback.livereload.com/knowledgebase/articles/86174-livereload-protocol
|
||||
def reload(pages)
|
||||
pages.each do |p|
|
||||
json_message = JSON.dump({
|
||||
msg = {
|
||||
:command => "reload",
|
||||
:path => p.url,
|
||||
:liveCSS => true,
|
||||
})
|
||||
}
|
||||
|
||||
Jekyll.logger.debug "LiveReload:", "Reloading #{p.url}"
|
||||
Jekyll.logger.debug "", json_message
|
||||
@websockets.each { |ws| ws.send(json_message) }
|
||||
Jekyll.logger.debug("LiveReload:", "Reloading #{p.url}")
|
||||
Jekyll.logger.debug(JSON.dump(msg))
|
||||
@websockets.each do |ws|
|
||||
ws.send(JSON.dump(msg))
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def connect(websocket, handshake)
|
||||
def connect(ws, handshake)
|
||||
@connections_count += 1
|
||||
if @connections_count == 1
|
||||
message = "Browser connected"
|
||||
message += " over SSL/TLS" if handshake.secure?
|
||||
Jekyll.logger.info "LiveReload:", message
|
||||
Jekyll.logger.info("LiveReload:", message)
|
||||
end
|
||||
websocket.send(
|
||||
ws.send(
|
||||
JSON.dump(
|
||||
:command => "hello",
|
||||
:protocols => ["http://livereload.com/protocols/official-7"],
|
||||
@@ -96,12 +120,12 @@ module Jekyll
|
||||
)
|
||||
)
|
||||
|
||||
@websockets << websocket
|
||||
@websockets << ws
|
||||
end
|
||||
|
||||
private
|
||||
def disconnect(websocket)
|
||||
@websockets.delete(websocket)
|
||||
def disconnect(ws)
|
||||
@websockets.delete(ws)
|
||||
end
|
||||
|
||||
private
|
||||
@@ -110,15 +134,18 @@ module Jekyll
|
||||
# Not sure what the 'url' command even does in LiveReload. The spec is silent
|
||||
# on its purpose.
|
||||
if msg["command"] == "url"
|
||||
Jekyll.logger.info "LiveReload:", "Browser URL: #{msg["url"]}"
|
||||
Jekyll.logger.info("LiveReload:", "Browser URL: #{msg["url"]}")
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def log_error(error)
|
||||
Jekyll.logger.error "LiveReload experienced an error. " \
|
||||
"Run with --trace for more information."
|
||||
raise error
|
||||
def log_error(e)
|
||||
Jekyll.logger.warn(
|
||||
"LiveReload experienced an error. "\
|
||||
"Run with --verbose for more information."
|
||||
)
|
||||
Jekyll.logger.debug("LiveReload Error:", e.message)
|
||||
Jekyll.logger.debug("LiveReload Error:", e.backtrace.join("\n"))
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -88,7 +88,6 @@ module Jekyll
|
||||
end
|
||||
@new_body = @new_body.join
|
||||
end
|
||||
# rubocop:enable Metrics/MethodLength
|
||||
|
||||
def template
|
||||
# Unclear what "snipver" does. Doc at
|
||||
@@ -176,7 +175,6 @@ module Jekyll
|
||||
res.header.merge!(@headers)
|
||||
rtn
|
||||
end
|
||||
# rubocop:enable Naming/MethodName
|
||||
|
||||
#
|
||||
|
||||
|
||||
@@ -74,7 +74,6 @@ module Jekyll
|
||||
close_connection_after_writing
|
||||
end
|
||||
end
|
||||
# rubocop:enable Metrics/MethodLength
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -61,15 +61,17 @@ module Jekyll
|
||||
"defaults" => [],
|
||||
|
||||
"liquid" => {
|
||||
"error_mode" => "warn",
|
||||
"strict_filters" => false,
|
||||
"strict_variables" => false,
|
||||
"error_mode" => "warn",
|
||||
},
|
||||
|
||||
"rdiscount" => {
|
||||
"extensions" => [],
|
||||
},
|
||||
|
||||
"redcarpet" => {
|
||||
"extensions" => [],
|
||||
},
|
||||
|
||||
"kramdown" => {
|
||||
"auto_ids" => true,
|
||||
"toc_levels" => "1..6",
|
||||
@@ -95,7 +97,7 @@ module Jekyll
|
||||
# problems and backwards-compatibility.
|
||||
def from(user_config)
|
||||
Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
|
||||
.add_default_collections
|
||||
.fix_common_issues.add_default_collections
|
||||
end
|
||||
end
|
||||
|
||||
@@ -132,8 +134,8 @@ module Jekyll
|
||||
def safe_load_file(filename)
|
||||
case File.extname(filename)
|
||||
when %r!\.toml!i
|
||||
Jekyll::External.require_with_graceful_fail("tomlrb") unless defined?(Tomlrb)
|
||||
Tomlrb.load_file(filename)
|
||||
Jekyll::External.require_with_graceful_fail("toml") unless defined?(TOML)
|
||||
TOML.load_file(filename)
|
||||
when %r!\.ya?ml!i
|
||||
SafeYAML.load_file(filename) || {}
|
||||
else
|
||||
@@ -208,7 +210,7 @@ module Jekyll
|
||||
warn err
|
||||
end
|
||||
|
||||
configuration.backwards_compatibilize.add_default_collections
|
||||
configuration.fix_common_issues.backwards_compatibilize.add_default_collections
|
||||
end
|
||||
|
||||
# Public: Split a CSV string into an array containing its values
|
||||
@@ -244,9 +246,18 @@ module Jekyll
|
||||
config
|
||||
end
|
||||
|
||||
# DEPRECATED.
|
||||
def fix_common_issues
|
||||
self
|
||||
config = clone
|
||||
|
||||
if config.key?("paginate") && (!config["paginate"].is_a?(Integer) ||
|
||||
config["paginate"] < 1)
|
||||
|
||||
Jekyll.logger.warn "Config Warning:", "The `paginate` key must be a positive" \
|
||||
" integer or nil. It's currently set to '#{config["paginate"].inspect}'."
|
||||
config["paginate"] = nil
|
||||
end
|
||||
|
||||
config
|
||||
end
|
||||
|
||||
def add_default_collections
|
||||
|
||||
@@ -30,6 +30,7 @@ module Jekyll
|
||||
# rubocop:disable Naming/AccessorMethodName
|
||||
def get_processor
|
||||
case @config["markdown"].downcase
|
||||
when "redcarpet" then return RedcarpetParser.new(@config)
|
||||
when "kramdown" then return KramdownParser.new(@config)
|
||||
when "rdiscount" then return RDiscountParser.new(@config)
|
||||
else
|
||||
@@ -43,7 +44,7 @@ module Jekyll
|
||||
# are not in safe mode.)
|
||||
|
||||
def valid_processors
|
||||
%w(rdiscount kramdown) + third_party_processors
|
||||
%w(rdiscount kramdown redcarpet) + third_party_processors
|
||||
end
|
||||
|
||||
# Public: A list of processors that you provide via plugins.
|
||||
@@ -52,7 +53,7 @@ module Jekyll
|
||||
|
||||
def third_party_processors
|
||||
self.class.constants - \
|
||||
%w(KramdownParser RDiscountParser PRIORITIES).map(
|
||||
%w(KramdownParser RDiscountParser RedcarpetParser PRIORITIES).map(
|
||||
&:to_sym
|
||||
)
|
||||
end
|
||||
|
||||
@@ -14,6 +14,7 @@ module Jekyll
|
||||
}.freeze
|
||||
|
||||
def initialize(config)
|
||||
Jekyll::External.require_with_graceful_fail "kramdown"
|
||||
@main_fallback_highlighter = config["highlighter"] || "rouge"
|
||||
@config = config["kramdown"] || {}
|
||||
@highlighter = nil
|
||||
@@ -47,12 +48,14 @@ module Jekyll
|
||||
end
|
||||
|
||||
private
|
||||
# rubocop:disable Performance/HashEachMethods
|
||||
def make_accessible(hash = @config)
|
||||
hash.keys.each do |key|
|
||||
hash[key.to_sym] = hash[key]
|
||||
make_accessible(hash[key]) if hash[key].is_a?(Hash)
|
||||
end
|
||||
end
|
||||
# rubocop:enable Performance/HashEachMethods
|
||||
|
||||
# config[kramdown][syntax_higlighter] >
|
||||
# config[kramdown][enable_coderay] >
|
||||
|
||||
@@ -5,9 +5,7 @@ module Jekyll
|
||||
class Markdown
|
||||
class RDiscountParser
|
||||
def initialize(config)
|
||||
unless defined?(RDiscount)
|
||||
Jekyll::External.require_with_graceful_fail "rdiscount"
|
||||
end
|
||||
Jekyll::External.require_with_graceful_fail "rdiscount"
|
||||
@config = config
|
||||
@rdiscount_extensions = @config["rdiscount"]["extensions"].map(&:to_sym)
|
||||
end
|
||||
@@ -22,9 +20,9 @@ module Jekyll
|
||||
end
|
||||
|
||||
private
|
||||
def replace_generated_toc(rd_instance, html, toc_token)
|
||||
if rd_instance.generate_toc && html.include?(toc_token)
|
||||
utf8_toc = rd_instance.toc_content
|
||||
def replace_generated_toc(rd, html, toc_token)
|
||||
if rd.generate_toc && html.include?(toc_token)
|
||||
utf8_toc = rd.toc_content
|
||||
utf8_toc.force_encoding("utf-8") if utf8_toc.respond_to?(:force_encoding)
|
||||
html.gsub(toc_token, utf8_toc)
|
||||
else
|
||||
|
||||
108
lib/jekyll/converters/markdown/redcarpet_parser.rb
Normal file
@@ -0,0 +1,108 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
class Jekyll::Converters::Markdown::RedcarpetParser
|
||||
module CommonMethods
|
||||
def add_code_tags(code, lang)
|
||||
code = code.to_s
|
||||
code = code.sub(
|
||||
%r!<pre>!,
|
||||
"<pre><code class=\"language-#{lang}\" data-lang=\"#{lang}\">"
|
||||
)
|
||||
code = code.sub(%r!</pre>!, "</code></pre>")
|
||||
code
|
||||
end
|
||||
end
|
||||
|
||||
module WithPygments
|
||||
include CommonMethods
|
||||
def block_code(code, lang)
|
||||
Jekyll::External.require_with_graceful_fail("pygments")
|
||||
lang = lang && lang.split.first || "text"
|
||||
add_code_tags(
|
||||
Pygments.highlight(
|
||||
code,
|
||||
{
|
||||
:lexer => lang,
|
||||
:options => { :encoding => "utf-8" },
|
||||
}
|
||||
),
|
||||
lang
|
||||
)
|
||||
end
|
||||
end
|
||||
|
||||
module WithoutHighlighting
|
||||
require "cgi"
|
||||
|
||||
include CommonMethods
|
||||
|
||||
def code_wrap(code)
|
||||
"<figure class=\"highlight\"><pre>#{CGI.escapeHTML(code)}</pre></figure>"
|
||||
end
|
||||
|
||||
def block_code(code, lang)
|
||||
lang = lang && lang.split.first || "text"
|
||||
add_code_tags(code_wrap(code), lang)
|
||||
end
|
||||
end
|
||||
|
||||
module WithRouge
|
||||
def block_code(_code, lang)
|
||||
code = "<pre>#{super}</pre>"
|
||||
|
||||
"<div class=\"highlight\">#{add_code_tags(code, lang)}</div>"
|
||||
end
|
||||
|
||||
protected
|
||||
def rouge_formatter(_lexer)
|
||||
Jekyll::Utils::Rouge.html_formatter(:wrap => false)
|
||||
end
|
||||
end
|
||||
|
||||
def initialize(config)
|
||||
Jekyll::External.require_with_graceful_fail("redcarpet")
|
||||
@config = config
|
||||
@redcarpet_extensions = {}
|
||||
@config["redcarpet"]["extensions"].each do |e|
|
||||
@redcarpet_extensions[e.to_sym] = true
|
||||
end
|
||||
|
||||
@renderer ||= class_with_proper_highlighter(@config["highlighter"])
|
||||
end
|
||||
|
||||
def class_with_proper_highlighter(highlighter)
|
||||
Class.new(Redcarpet::Render::HTML) do
|
||||
case highlighter
|
||||
when "pygments"
|
||||
include WithPygments
|
||||
when "rouge"
|
||||
Jekyll::External.require_with_graceful_fail(%w(
|
||||
rouge rouge/plugins/redcarpet
|
||||
))
|
||||
|
||||
unless Gem::Version.new(Rouge.version) > Gem::Version.new("1.3.0")
|
||||
abort "Please install Rouge 1.3.0 or greater and try running Jekyll again."
|
||||
end
|
||||
|
||||
include Rouge::Plugins::Redcarpet
|
||||
include CommonMethods
|
||||
include WithRouge
|
||||
else
|
||||
include WithoutHighlighting
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def convert(content)
|
||||
@redcarpet_extensions[:fenced_code_blocks] = \
|
||||
!@redcarpet_extensions[:no_fenced_code_blocks]
|
||||
if @redcarpet_extensions[:smart]
|
||||
@renderer.send :include, Redcarpet::Render::SmartyPants
|
||||
end
|
||||
markdown = Redcarpet::Markdown.new(
|
||||
@renderer.new(@redcarpet_extensions),
|
||||
@redcarpet_extensions
|
||||
)
|
||||
markdown.render(content)
|
||||
end
|
||||
end
|
||||
@@ -20,9 +20,7 @@ module Jekyll
|
||||
priority :low
|
||||
|
||||
def initialize(config)
|
||||
unless defined?(Kramdown)
|
||||
Jekyll::External.require_with_graceful_fail "kramdown"
|
||||
end
|
||||
Jekyll::External.require_with_graceful_fail "kramdown"
|
||||
@config = config["kramdown"].dup || {}
|
||||
@config[:input] = :SmartyPants
|
||||
end
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require "set"
|
||||
|
||||
# Convertible provides methods for converting a pagelike item
|
||||
# from a certain type of markup into actual content
|
||||
#
|
||||
@@ -107,6 +109,7 @@ module Jekyll
|
||||
def render_liquid(content, payload, info, path)
|
||||
_renderer.render_liquid(content, payload, info, path)
|
||||
end
|
||||
# rubocop: enable RescueException
|
||||
|
||||
# Convert this Convertible's data to a Hash suitable for use by Liquid.
|
||||
#
|
||||
@@ -162,9 +165,9 @@ module Jekyll
|
||||
|
||||
# Determine whether the file should be rendered with Liquid.
|
||||
#
|
||||
# Returns true if the file has Liquid Tags or Variables, false otherwise.
|
||||
# Always returns true.
|
||||
def render_with_liquid?
|
||||
Jekyll::Utils.has_liquid_construct?(content)
|
||||
true
|
||||
end
|
||||
|
||||
# Determine whether the file should be placed into layouts.
|
||||
@@ -224,7 +227,6 @@ module Jekyll
|
||||
def write(dest)
|
||||
path = destination(dest)
|
||||
FileUtils.mkdir_p(File.dirname(path))
|
||||
Jekyll.logger.debug "Writing:", path
|
||||
File.write(path, output, :mode => "wb")
|
||||
Jekyll::Hooks.trigger hook_owner, :post_write, self
|
||||
end
|
||||
|
||||
@@ -78,19 +78,19 @@ module Jekyll
|
||||
collection.label == "posts"
|
||||
end
|
||||
|
||||
# The path to the document, relative to the collections_dir.
|
||||
# The path to the document, relative to the site source.
|
||||
#
|
||||
# Returns a String path which represents the relative path from the collections_dir
|
||||
# to this document.
|
||||
# Returns a String path which represents the relative path
|
||||
# from the site source to this document
|
||||
def relative_path
|
||||
@relative_path ||= path.sub("#{site.collections_path}/", "")
|
||||
@relative_path ||= Pathutil.new(path).relative_path_from(site.source).to_s
|
||||
end
|
||||
|
||||
# The output extension of the document.
|
||||
#
|
||||
# Returns the output extension
|
||||
def output_ext
|
||||
@output_ext ||= Jekyll::Renderer.new(site, self).output_ext
|
||||
Jekyll::Renderer.new(site, self).output_ext
|
||||
end
|
||||
|
||||
# The base filename of the document, without the file extname.
|
||||
@@ -156,10 +156,9 @@ module Jekyll
|
||||
# Determine whether the file should be rendered with Liquid.
|
||||
#
|
||||
# Returns false if the document is either an asset file or a yaml file,
|
||||
# or if the document doesn't contain any Liquid Tags or Variables,
|
||||
# true otherwise.
|
||||
def render_with_liquid?
|
||||
!(coffeescript_file? || yaml_file? || !Utils.has_liquid_construct?(content))
|
||||
!(coffeescript_file? || yaml_file?)
|
||||
end
|
||||
|
||||
# Determine whether the file should be rendered with a layout.
|
||||
@@ -239,7 +238,6 @@ module Jekyll
|
||||
def write(dest)
|
||||
path = destination(dest)
|
||||
FileUtils.mkdir_p(File.dirname(path))
|
||||
Jekyll.logger.debug "Writing:", path
|
||||
File.write(path, output, :mode => "wb")
|
||||
|
||||
trigger_hooks(:post_write)
|
||||
@@ -312,10 +310,9 @@ module Jekyll
|
||||
# Based on the Collection to which it belongs.
|
||||
#
|
||||
# True if the document has a collection and if that collection's #write?
|
||||
# method returns true, and if the site's Publisher will publish the document.
|
||||
# False otherwise.
|
||||
# method returns true, otherwise false.
|
||||
def write?
|
||||
collection && collection.write? && site.publisher.publish?(self)
|
||||
collection && collection.write?
|
||||
end
|
||||
|
||||
# The Document excerpt_separator, from the YAML Front-Matter or site
|
||||
@@ -360,7 +357,7 @@ module Jekyll
|
||||
#
|
||||
# Returns an Array of related Posts.
|
||||
def related_posts
|
||||
@related_posts ||= Jekyll::RelatedPosts.new(self).build
|
||||
Jekyll::RelatedPosts.new(self).build
|
||||
end
|
||||
|
||||
# Override of normal respond_to? to match method_missing's logic for
|
||||
@@ -402,9 +399,11 @@ module Jekyll
|
||||
def populate_categories
|
||||
merge_data!({
|
||||
"categories" => (
|
||||
Array(data["categories"]) + Utils.pluralized_array_from_hash(
|
||||
data, "category", "categories"
|
||||
)
|
||||
Array(data["categories"]) + Utils.pluralized_array_from_hash(
|
||||
data,
|
||||
"category",
|
||||
"categories"
|
||||
)
|
||||
).map(&:to_s).flatten.uniq,
|
||||
})
|
||||
end
|
||||
@@ -419,7 +418,7 @@ module Jekyll
|
||||
def merge_categories!(other)
|
||||
if other.key?("categories") && !other["categories"].nil?
|
||||
if other["categories"].is_a?(String)
|
||||
other["categories"] = other["categories"].split
|
||||
other["categories"] = other["categories"].split(%r!\s+!).map(&:strip)
|
||||
end
|
||||
other["categories"] = (data["categories"] || []) | other["categories"]
|
||||
end
|
||||
@@ -427,7 +426,7 @@ module Jekyll
|
||||
|
||||
private
|
||||
def merge_date!(source)
|
||||
if data.key?("date")
|
||||
if data.key?("date") && !data["date"].is_a?(Time)
|
||||
data["date"] = Utils.parse_date(
|
||||
data["date"].to_s,
|
||||
"Document '#{relative_path}' does not have a valid date in the #{source}."
|
||||
|
||||
@@ -11,11 +11,12 @@ module Jekyll
|
||||
def_delegators :@obj, :label, :docs, :files, :directory,
|
||||
:relative_directory
|
||||
|
||||
private def_delegator :@obj, :metadata, :fallback_data
|
||||
|
||||
def to_s
|
||||
docs.to_s
|
||||
end
|
||||
|
||||
private
|
||||
def_delegator :@obj, :metadata, :fallback_data
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -14,8 +14,6 @@ module Jekyll
|
||||
def_delegator :@obj, :relative_path, :path
|
||||
def_delegators :@obj, :id, :output, :content, :to_s, :relative_path, :url
|
||||
|
||||
private def_delegator :@obj, :data, :fallback_data
|
||||
|
||||
def collection
|
||||
@obj.collection.label
|
||||
end
|
||||
@@ -63,6 +61,9 @@ module Jekyll
|
||||
result[key] = doc[key] unless NESTED_OBJECT_FIELD_BLACKLIST.include?(key)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
def_delegator :@obj, :data, :fallback_data
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -137,6 +137,7 @@ module Jekyll
|
||||
#
|
||||
# Returns a pretty generation of the hash representation of the Drop.
|
||||
def inspect
|
||||
require "json"
|
||||
JSON.pretty_generate to_h
|
||||
end
|
||||
|
||||
@@ -154,6 +155,7 @@ module Jekyll
|
||||
#
|
||||
# Returns a JSON representation of the Drop in a String.
|
||||
def to_json(state = nil)
|
||||
require "json"
|
||||
JSON.generate(hash_for_json(state), state)
|
||||
end
|
||||
|
||||
|
||||
@@ -25,6 +25,7 @@ module Jekyll
|
||||
end
|
||||
|
||||
def to_json(state = nil)
|
||||
require "json"
|
||||
JSON.generate(to_h, state)
|
||||
end
|
||||
end
|
||||
|
||||