Compare commits

..

1698 Commits

Author SHA1 Message Date
mattr-
d520211505 Deploy docs from 202df57131
mariuslp: docs: update wsl installation procedure (#9968)

This is a 🔦 documentation change.

## Summary

The install documentation for WSL offers to install Ruby through
BrightBox. However, BrightBox does not support Ubuntu Jammy (which is
the default for latest WSL builds). Instead, this commit just redirects
the WSL user to the Ubuntu installation procedure to avoid duplicate
documentation.
2026-04-22 14:50:11 +00:00
jekyllbot
8be8cb919b Deploy docs from 3ed83f6450
Waishnav: Add GitCMS to resources docs (#9960)

Merge pull request 9960
2026-04-14 17:58:26 +00:00
jekyllbot
18ef29fa28 Deploy docs from f07d4f77bc
Mike Dalton: Allow configuring future metadata for individual collections (#9925)

Merge pull request 9925
2026-03-11 15:41:19 +00:00
jekyllbot
d11d4f7c3a Deploy docs from 6da6739952
Y.D.X.: Update WDM (0.1.1 → 0.2.0) in the Windows docs (#9897)

Merge pull request 9897
2025-12-21 20:48:58 +00:00
jekyllbot
1e1c79d4d4 Deploy docs from a2c27b70ec
Ian: Add jekyllup.com to themes documentation (#9882)

Merge pull request 9882
2025-10-14 14:58:43 +00:00
jekyllbot
a6eefe3fde Deploy docs from 59d5d9ae62
Sam Cole: Add ruby-erb prerequisite for Arch Linux installations (#9832)

Merge pull request 9832
2025-06-05 15:31:23 +00:00
jekyllbot
68ba1c545c Deploy docs from 79a8e16f22
Jefferson Quesado: feat: Allowing post_url tag to receive liquid variables (#9776)

Merge pull request 9776
2025-06-05 14:51:50 +00:00
jekyllbot
9d28b11181 Deploy docs from 5f877c347b
Bruno Germano: Add Azion to the 3rd party deployment docs (#9811)

Merge pull request 9811
2025-04-22 14:33:50 +00:00
mattr-
d67ed17262 Deploy docs from 1b617d7281
Molly Exten: Updated note on Gemfiles in 10-deployment.md (#9805)

This is a 🔦 documentation change.

I've adjusted the documentation to include a note that Gemfile is
already installed if the reader has completed step 1 in this tutorial. I
thought it was kind of confusing to see instructions on adding a Gemfile
when I had already done that step in the first part of the tutorial.

---------

Co-authored-by: Matt Rogers <mattr-@github.com>
2025-04-08 16:16:01 +00:00
jekyllbot
27cb1546ef Deploy docs from 1e4696457d
Fernando Tapia Rico: Add Supranode to third-party deployment guide (#9786)

Merge pull request 9786
2025-04-08 15:09:04 +00:00
jekyllbot
9aac3e4338 Deploy docs from e4f0c58395
Molly Exten: Small documentation update for 09-collections.md (#9803)

Merge pull request 9803
2025-04-08 15:08:22 +00:00
ashmaroli
e9b51b02cf Deploy docs from 1f319fb273
Ashwin Maroli: Release 💎 v4.4.1
2025-01-29 12:47:45 +00:00
ashmaroli
9aa95c8541 Deploy docs from cda8c3a402
Ashwin Maroli: Release 💎 v4.4.0
2025-01-27 15:28:29 +00:00
jekyllbot
8d43a4ae79 Deploy docs from e68b3e3e16
Ashwin Maroli: Add release post for v4.4.0 (#9759)

Merge pull request 9759
2025-01-27 15:17:59 +00:00
ashmaroli
4625eb0c0d Deploy docs from dfa5f036f7
Ashwin Maroli: Improve rendering of site footer
2025-01-02 16:59:04 +00:00
jekyllbot
f0bba31086 Deploy docs from 61c9708264
naoki kodama: remove: inaccessible links and their descriptions (#9745)

Merge pull request 9745
2025-01-01 13:56:10 +00:00
jekyllbot
79e92543b8 Deploy docs from 70e4e87945
Khalila: Fix broken link on third-party.md (#9704)

Merge pull request 9704
2024-12-16 14:28:04 +00:00
jekyllbot
aa1f25c52f Deploy docs from 6a4a630bdf
Silent: Link to GitHub Pages Dependency versions page instead of explicitly specifying Jekyll version (#9715)

Merge pull request 9715
2024-11-20 15:06:53 +00:00
jekyllbot
90664f3d1b Deploy docs from 6b0af7144d
林博仁 Buo-ren Lin: Fix missing `url` configuration option documentation (#9699)

Merge pull request 9699
2024-10-20 15:42:32 +00:00
jekyllbot
00781e413f Deploy docs from 0c4a453e2c
林博仁 Buo-ren Lin: Fix missing glob matching pattern support description in the documentation of the `include` and `exclude` configuration options (#9697)

Merge pull request 9697
2024-10-20 14:23:32 +00:00
jekyllbot
22ea84ee2b Deploy docs from 8ba078f95d
林博仁 Buo-ren Lin: Fix HTML attribute separation whitespace placement in the Navigation include code of Assets step of the Step by Step Tutorial (#9695)

Merge pull request 9695
2024-10-10 15:10:24 +00:00
jekyllbot
7fd6b9b107 Deploy docs from f8a456d16e
Ashwin Maroli: Render HTML tables at `/docs/permalinks/` using a data file (#9666)

Merge pull request 9666
2024-09-22 18:22:35 +00:00
jekyllbot
03052d22bd Deploy docs from 27805c97ec
Seth Louis: Fix grammar in the description of `page.excerpt` variable (#9689)

Merge pull request 9689
2024-09-22 18:02:11 +00:00
jekyllbot
a85a62461e Deploy docs from 860c5d6394
nisbet-hubbard: Improve docs around using GitHub Actions to build and deploy Jekyll sites (#9682)

Merge pull request 9682
2024-09-22 12:26:17 +00:00
ashmaroli
082d71b2b0 Deploy docs from ef6ae0305e
Ashwin Maroli: Publish Release Post for v4.3.4
2024-09-16 16:21:18 +00:00
jekyllbot
a430552001 Deploy docs from 32074ef944
Ashwin Maroli: Render theme-gem root only in development (#9680)

Merge pull request 9680
2024-09-16 15:41:31 +00:00
ashmaroli
cc6e5e419c Deploy docs from 5861d3ab28
Moncef Belyamani: Update current Ruby version to 3.3.5 (#9614)

This is a documentation change to update the current version of Ruby to the
latest as of today: 3.3.5

As for the macOS docs, I updated the supported macOS versions to be in line with what Homebrew supports. I also removed `xz` from the  prerequisites that need to be installed with Homebrew since it gets installed automatically when you install ruby-install.

Co-authored-by: Moncef Belyamani <git@rubyonmac.dev>
2024-09-16 14:39:26 +00:00
jekyllbot
346464342c Deploy docs from 34e35284aa
Simon Wagar: Fix of a bug in the pagination section (#8890)

Merge pull request 8890
2024-09-15 14:11:11 +00:00
jekyllbot
bba799de34 Deploy docs from 192360dd6a
KenHV: docs: Fix incorrect parentheses (#9629)

Merge pull request 9629
2024-09-15 13:28:23 +00:00
jekyllbot
594961a305 Deploy docs from 75d70a0ba8
Ashwin Maroli: Extract markup for `Improve this page` into an inclusion (#9675)

Merge pull request 9675
2024-09-12 06:47:34 +00:00
jekyllbot
32ef288515 Deploy docs from 0fde781f2b
Mike Slinn: Fix `--livereload-ignore` option (#9570)

Merge pull request 9570
2024-09-11 13:56:06 +00:00
ashmaroli
514e38c59d Deploy docs from aa8c2466ca
Ashwin Maroli: [Docs] Mention introduced version for config key
2024-09-08 18:10:18 +00:00
jekyllbot
e770385667 Deploy docs from f63a68bedd
Gourav Khunger: fix: acknowledge livereload_port from site config too (#9606)

Merge pull request 9606
2024-09-08 17:17:45 +00:00
jekyllbot
2522de618e Deploy docs from c59e59091d
QuinnG8: Add note about VSCode warning for SCSS files (#9609)

Merge pull request 9609
2024-09-08 13:30:48 +00:00
jekyllbot
63747c1458 Deploy docs from c458e1413a
Ashwin Maroli: Fix lapses in documentation of page variables (#9667)

Merge pull request 9667
2024-09-06 18:21:41 +00:00
jekyllbot
3c8ab8d4fd Deploy docs from a6739dcfd2
iulianOnofrei (U-lee-aan): Fix incorrect and inconsistent variables in the permalinks page (#9591)

Merge pull request 9591
2024-09-06 09:25:21 +00:00
jekyllbot
8d8194d2fb Deploy docs from e300964879
Ashwin Maroli: Windows CI on GitHub Actions (#9659)

Merge pull request 9659
2024-09-06 06:10:42 +00:00
jekyllbot
b77aa71c6d Deploy docs from 3a8b2822f1
Ashwin Maroli: Relax version constraint on `wdm` in new Gemfile (#9662)

Merge pull request 9662
2024-09-05 14:23:13 +00:00
jekyllbot
2c30e5623b Deploy docs from cde2de69a7
Ashwin Maroli: Stop testing with Cucumber on JRuby (#9661)

Merge pull request 9661
2024-09-05 12:52:07 +00:00
jekyllbot
af42e52b93 Deploy docs from 3283e679bc
Ashwin Maroli: Document keys of global variable `{{ jekyll }}` (#9653)

Merge pull request 9653
2024-08-29 15:16:43 +00:00
jekyllbot
6516b1fbb4 Deploy docs from 2445bd946e
Olle Jonsson: CI: Use JRuby 9.4.8.0 (#9654)

Merge pull request 9654
2024-08-29 15:10:40 +00:00
jekyllbot
5d93b1e486 Deploy docs from e55274d8f8
Krisztian Zsolt Sallai: Update windows.md (#9644)

Merge pull request 9644
2024-08-04 18:26:34 +00:00
jekyllbot
55c5f27ee2 Deploy docs from 885c98a32b
Virgil Ierubino: Fix error (#9641)

Merge pull request 9641
2024-07-26 07:05:15 +00:00
jekyllbot
c5c5744f9e Deploy docs from 822ac4fa47
Parker Moore: Add Jekyll 3.10.0 release post & history (#9625)

Merge pull request 9625
2024-06-24 22:28:07 +00:00
jekyllbot
7a13db3bf9 Deploy docs from 38a18af96a
Joel Coffman: Add redirect for step-by-step tutorial (#9593)

Merge pull request 9593
2024-05-23 17:53:52 +00:00
jekyllbot
8dc55d4877 Deploy docs from ed30c864f2
iulianOnofrei (U-lee-aan): Fix inexistent layout warning for the default 404 page (#9589)

Merge pull request 9589
2024-05-23 16:22:47 +00:00
jekyllbot
c427e6b94b Deploy docs from 28e10da266
Koichi ITO: Make custom cop inherit `RuboCop::Cop::Base` (#9597)

Merge pull request 9597
2024-05-22 18:02:51 +00:00
jekyllbot
57e43a15d4 Deploy docs from 1f3c0dc0d4
Matt Rogers: fix(rubocop): correct lint errors (#9600)

Merge pull request 9600
2024-05-22 18:02:26 +00:00
jekyllbot
74edd8e9f3 Deploy docs from c85bd15340
a story: Fixed: Wrong navigation style on the right side of news and docs pages (#9586)

Merge pull request 9586
2024-04-23 19:00:10 +00:00
jekyllbot
937a10682c Deploy docs from 22c756a2e0
velle: Jekyll docs template typo - All pages show "Deployment" (#9548)

Merge pull request 9548
2024-02-13 03:02:22 +00:00
jekyllbot
d5e98daf68 Deploy docs from 84a29bd142
Parker Moore: Add a few more emeritus team members (#9535)

Merge pull request 9535
2024-01-23 18:54:00 +00:00
jekyllbot
e5d9f01b3b Deploy docs from 8f2b53172f
Matt Rogers: fix: make search work again (#9530)

Merge pull request 9530
2024-01-17 06:59:08 +00:00
jekyllbot
133de81a57 Deploy docs from db3437a34f
Matt Rogers: chore: Bump the required ruby version to 2.7 (#9525)

Merge pull request 9525
2024-01-13 02:49:30 +00:00
jekyllbot
e099d4bc7a Deploy docs from 01da87c5f9
Akira Taguchi: Fix gem quote consistency on docs (#9517)

Merge pull request 9517
2024-01-12 17:05:35 +00:00
jekyllbot
0ba0f0fa6c Deploy docs from 55e993be25
Daniel Haim: Improve accessibility of the docs (#9338)

Merge pull request 9338
2024-01-12 16:57:55 +00:00
jekyllbot
1411bea472 Deploy docs from 25fd87c3e2
halorrr: add csv to runtime dependency list (#9522)

Merge pull request 9522
2024-01-10 17:00:50 +00:00
jekyllbot
0f692e54e3 Deploy docs from 2ed5f33da6
Michael Nordmeyer: Add docs version to pages_excerpts feature (#9520)

Merge pull request 9520
2024-01-05 21:58:58 +00:00
jekyllbot
cb3a5a1700 Deploy docs from 901256a42c
Parker Moore: Fix Performance/StringIdentifierArgument violation in site.rb and allow activesupport 6 for windows tests (#9512)

Merge pull request 9512
2023-12-29 00:35:37 +00:00
parkr
e8a7fab8cf Deploy docs from b2e99a0e12
Parker Moore: Merge pull request #9515 from jekyll/jekyll-3-9-4-docs
2023-12-28 23:25:34 +00:00
jekyllbot
594371338c Deploy docs from f9c2395a86
Matt Rogers: Add release post for v4.3.3 (#9511)

Merge pull request 9511
2023-12-27 20:53:16 +00:00
jekyllbot
07b5aa59e7 Deploy docs from 432d0e3e7d
Jonas Jared Jacek: Update resources.md (#9496)

Merge pull request 9496
2023-12-01 16:52:14 +00:00
jekyllbot
633cffa574 Deploy docs from 52aab1bc10
Jonas Jared Jacek: Update security.md (#9497)

Merge pull request 9497
2023-12-01 16:49:56 +00:00
jekyllbot
29dd0dbc8e Deploy docs from b427a17315
Gaelan Lloyd: Add FreeBSD installation instructions (#9481)

Merge pull request 9481
2023-11-03 22:22:37 +00:00
jekyllbot
a530f1acf5 Deploy docs from 537032c49d
Seth Falco: chore: update showcases (#9473)

Merge pull request 9473
2023-10-31 16:48:57 +00:00
jekyllbot
289123c7d2 Deploy docs from 4bfb4edc40
David Silveira: Update rubocop gem (#9476)

Merge pull request 9476
2023-10-31 16:48:11 +00:00
jekyllbot
19853885b5 Deploy docs from cd4d84a44f
Matt Rogers: Configure dependabot to handle rubygems dependencies (#9445)

Merge pull request 9445
2023-10-31 15:59:55 +00:00
jekyllbot
5eca5c045d Deploy docs from d0afea2b03
Gabriel B. Nunes: Clarify which version of Jekyll needs 'jekyll-paginate' (#9477)

Merge pull request 9477
2023-10-31 15:49:46 +00:00
jekyllbot
1bc3a4d19b Deploy docs from c52bbde5ec
William Entriken: Add GitHub Pages helpful notes (#9235)

Merge pull request 9235
2023-10-22 17:50:03 +00:00
jekyllbot
0c12edff13 Deploy docs from d9df973d2c
Juan Vásquez: Bump Rubocop to 1.56.4 (#9459)

Merge pull request 9459
2023-10-22 16:50:01 +00:00
jekyllbot
5555119419 Deploy docs from a70f5cba65
Matt Rogers: Keep activesupport at version 7.0.x (#9469)

Merge pull request 9469
2023-10-22 16:48:53 +00:00
jekyllbot
2b9f5f944c Deploy docs from 3ba746c979
José Romero: Update resources.md (#9449)

Merge pull request 9449
2023-09-24 02:48:45 +00:00
jekyllbot
e969a14566 Deploy docs from d865905d66
Vít Ondruch: Test suite uses shoulda-context only. (#9441)

Merge pull request 9441
2023-09-15 15:48:49 +00:00
jekyllbot
99c55a0c2a Deploy docs from 895a5033c0
dependabot[bot]: Bump actions/checkout from 3 to 4 (#9442)

Merge pull request 9442
2023-09-15 00:49:37 +00:00
jekyllbot
13799be98f Deploy docs from 0417baf058
なつき: Update github-actions documentation (#9426)

Merge pull request 9426
2023-09-14 09:07:30 +00:00
jekyllbot
aba029a67a Deploy docs from 1fbd42ceeb
Jonas Jared Jacek: Update convert-site-to-jekyll.md (#9348)

Merge pull request 9348
2023-08-14 18:22:12 +00:00
jekyllbot
0f939ccefc Deploy docs from a385117f2c
Jorge: Add CodeQL workflow (#9397)

Merge pull request 9397
2023-08-14 00:53:02 +00:00
jekyllbot
47964b50db Deploy docs from 4c882541d7
James Hoctor: Update Fedora prerequisites to include g++ (#9290)

Merge pull request 9290
2023-08-14 00:34:04 +00:00
jekyllbot
0521893dc1 Deploy docs from 2277999f39
Maciek Palmowski: Adds Kinsta to 3rd party deployments (#9331)

Merge pull request 9331
2023-08-14 00:33:49 +00:00
jekyllbot
92ee82c42d Deploy docs from 71fe6aaa0a
Robert Austin: Add new theme directory to themes resources (#9356)

Merge pull request 9356
2023-08-14 00:33:39 +00:00
jekyllbot
e10a23c171 Deploy docs from dafa28d40c
Joe Mahoney: Point to the Rouge GitHub repo rather than broken website (#9362)

Merge pull request 9362
2023-08-14 00:33:27 +00:00
jekyllbot
4ad0483578 Deploy docs from 8c4bed5e4f
Ram Vasuthevan: Fix typo in devcontainer.json (#9364)

Merge pull request 9364
2023-08-14 00:33:16 +00:00
jekyllbot
a50b91e6fc Deploy docs from 0ab743204a
IFcoltransG: Note the front matter requirement in pages.md (#9423)

Merge pull request 9423
2023-08-14 00:32:34 +00:00
jekyllbot
27a0371e2d Deploy docs from 76a9a194cf
Shruti Dalvi: Update 07-assets.md (#9393)

Merge pull request 9393
2023-08-13 20:18:42 +00:00
jekyllbot
f57f3f1f8c Deploy docs from e57c755c6f
Sutou Kouhei: Add support for upcoming logger 1.4.3 (#9392)

Merge pull request 9392
2023-08-12 02:49:54 +00:00
jekyllbot
5a5c1acf70 Deploy docs from d99471332d
Muhab Abdelreheem: Typo fix - update to hooks and 3rd party deployment and one other article (#9411)

Merge pull request 9411
2023-08-12 02:48:18 +00:00
jekyllbot
00730b5eca Deploy docs from dd4312270c
William Entriken: Update macos.md (#9406)

Merge pull request 9406
2023-07-10 19:00:58 +00:00
jekyllbot
ee5eb69292 Deploy docs from d04f1afc81
William Entriken: Update macos.md (#9405)

Merge pull request 9405
2023-07-10 15:14:54 +00:00
jekyllbot
3a4278431e Deploy docs from fdb4c623ba
Joe Mahoney: #9398 upgrade RuboCop to 1.54 (#9401)

Merge pull request 9401
2023-07-08 22:26:09 +00:00
jekyllbot
bc67493f2d Deploy docs from acae1e1ce8
Joe Mahoney: Bump rubocop version to 1.52.x (#9361)

Merge pull request 9361
2023-06-05 12:49:45 +00:00
jekyllbot
fcb2e0d39d Deploy docs from 11987c65e0
Tomáš Hübelbauer: Document Exclude behavior, Include overrides and the default exclusion list (#9376)

Merge pull request 9376
2023-06-05 12:46:48 +00:00
jekyllbot
f049150578 Deploy docs from c6dfae56d0
Joe Mahoney: Bump versions of ruby & nodejs in devcontainer (#9360)

Merge pull request 9360
2023-05-08 13:27:16 +00:00
ashmaroli
a2b2447a97 Deploy docs from bb954ff16e
Ashwin Maroli: Prefer using `assert_instance_of`

To appease RuboCop `Minitest/AssertInstanceOf`
2023-04-09 14:19:49 +00:00
jekyllbot
4d59268874 Deploy docs from 6bedc7e069
waqarnazir: Bump Rubocop to version 1.48.x (#9326)

Merge pull request 9326
2023-03-26 09:06:20 +00:00
jekyllbot
19100059b6 Deploy docs from d03742e994
Ashwin Maroli: Handle TypeError from `where` filter gracefully (#9292)

Merge pull request 9292
2023-03-24 09:00:52 +00:00
ashmaroli
8faf43b893 Deploy docs from 052f1bd412
Ashwin Maroli: Revert "Normalize line-endings in test plugins"

This reverts commit 73fcc42353.
2023-03-02 07:25:27 +00:00
ashmaroli
edf90e782c Deploy docs from 73fcc42353
Ashwin Maroli: Normalize line-endings in test plugins
2023-03-02 07:20:32 +00:00
jekyllbot
483c5e1b44 Deploy docs from 16a1e5cac4
なつき: Fix `jekyll serve --detach` with jekyll-sass-converter 3.x (#9304)

Merge pull request 9304
2023-02-21 22:58:25 +00:00
ashmaroli
5ac1843ee8 Deploy docs from ecf098580d
Ashwin Maroli: [Docs]: Adjust line-length in Markdown code-blocks  [skip appveyor]
2023-02-16 14:40:59 +00:00
jekyllbot
50db92485b Deploy docs from 4ecbeb4063
Ashwin Maroli: Bump RuboCop to v1.45.x (#9305)

Merge pull request 9305
2023-02-16 12:27:48 +00:00
jekyllbot
ec2c866a41 Deploy docs from 7047e7dfb4
Josh Soref: Use check-spelling/check-spelling@v0.0.21 (#9199)

Merge pull request 9199
2023-02-01 13:37:39 +00:00
jekyllbot
52500a92f0 Deploy docs from 4cc1905ae3
Sean M. Collins: Update S3 deployment to remove s3_website (#9221)

Merge pull request 9221
2023-02-01 13:30:57 +00:00
jekyllbot
894717a8e4 Deploy docs from e0cd941c09
dependabot[bot]: Bump check-spelling/check-spelling from 0.0.20 to 0.0.21 (#9205)

Merge pull request 9205
2023-01-30 17:50:29 +00:00
jekyllbot
bd2e094747 Deploy docs from ac4abbd14d
Parker Moore: Add v3.9.3 release history & post to `master` branch (#9284)

Merge pull request 9284
2023-01-30 09:42:03 +00:00
ashmaroli
424679c387 Deploy docs from 2b590254a1
Ashwin Maroli: Test with Ruby 3.2
2023-01-29 15:32:30 +00:00
jekyllbot
5314ff1d38 Deploy docs from ef62f7455c
Andy Coates: Mark `highlight` `mark_lines` feature as 4.4 in docs (#9184)

Merge pull request 9184
2023-01-27 15:24:59 +00:00
jekyllbot
080a66a7e7 Deploy docs from 2bd91fdd8c
William Underwood: fixed grammatical mistake on "showcase" page (#9264)

Merge pull request 9264
2023-01-26 10:56:11 +00:00
jekyllbot
1dd9cbf199 Deploy docs from 0da02acdf8
plgagne: grammatical reordering (#9245)

Merge pull request 9245
2023-01-26 10:54:54 +00:00
ashmaroli
b09727f304 Deploy docs from 67ab1be220
Ashwin Maroli: Fix History entry for v4.3.2
2023-01-25 13:56:16 +00:00
ashmaroli
532ebcdd15 Deploy docs from ff60d51c9b
Ashwin Maroli: Release 💎 v4.3.2
2023-01-20 18:24:29 +00:00
jekyllbot
9fad76cd51 Deploy docs from c7e3e689e7
Ashwin Maroli: Add release post for v4.3.2 (#9263)

Merge pull request 9263
2023-01-20 18:13:42 +00:00
jekyllbot
6c091d2156 Deploy docs from bf8d50ee08
Parker Moore: script/default-site: accept flags for `jekyll new` (#9259)

Merge pull request 9259
2023-01-19 07:06:11 +00:00
jekyllbot
f25479073e Deploy docs from 3a1848066b
Ashwin Maroli: Rename sass partial created for new blank site (#9257)

Merge pull request 9257
2023-01-19 07:00:55 +00:00
jekyllbot
a8a208c21e Deploy docs from bfa7c94899
masaki: Update Jekyll on macOS (macos.md) and current ruby version to 3.1.3 in ruby.yml (#9195)

Merge pull request 9195
2023-01-04 11:09:50 +00:00
jekyllbot
85882a53b4 Deploy docs from 249101aea6
Mamoru TASAKA: test: use hash explicitly for Struct initializer for ruby 3.2 (#9237)

Merge pull request 9237
2022-12-29 07:24:06 +00:00
jekyllbot
7b91663638 Deploy docs from ee3576e2cb
Ashwin Maroli: Split `test/test_tags.rb` into multiple files (#9230)

Merge pull request 9230
2022-12-26 14:17:13 +00:00
jekyllbot
c72d06116d Deploy docs from 69839ba6dc
Ashwin Maroli: Publish post on major release of sass-converter (#9225)

Merge pull request 9225
2022-12-23 06:20:51 +00:00
jekyllbot
6b4a149219 Deploy docs from 572c86ec13
なつき: Update sass related tests for jekyll-sass-converter 3.x (#9223)

Merge pull request 9223
2022-12-22 14:51:37 +00:00
ashmaroli
57fce4dc4f Deploy docs from fc75f5360d
Ashwin Maroli: Stop testing with Rubies older than 2.7 on Windows
2022-12-18 16:34:15 +00:00
ashmaroli
efd32ffd14 Deploy docs from 300668ed7f
Ashwin Maroli: Lock `psych` to v4.x

Psych 5 has stopped bundling `libyaml` and expects it to be installed on the host system prior
to being invoked.
Since we don't have a direct dependency on the Psych gem (it gets included in the gem bundle
as a dependency of the `rdoc` gem), lock psych gem to v4.x instead of installing `libyaml` in our
development / CI environment.
2022-12-18 13:46:05 +00:00
ashmaroli
2ce05276dc Deploy docs from f1a20d0e22
Ashwin Maroli: Reword `there're` to `there are`
2022-12-18 13:29:59 +00:00
jekyllbot
b4db7a77e2 Deploy docs from b2891a476e
Ashwin Maroli: Optimize `Site#each_site_file` (#9187)

Merge pull request 9187
2022-12-18 13:20:58 +00:00
jekyllbot
62ffed86e4 Deploy docs from 82bb2714df
Ashwin Maroli: Remove totals in profile table properly (#9186)

Merge pull request 9186
2022-12-18 13:17:32 +00:00
jekyllbot
48b07a30cb Deploy docs from 072808d953
Valeriy Van: Fix typo (#9203)

Merge pull request 9203
2022-12-04 10:52:07 +00:00
jekyllbot
1e7f07aa50 Deploy docs from 0cf8533f61
Ashwin Maroli: Optimize default front matter using `File.fnmatch?` (#9185)

Merge pull request 9185
2022-11-27 17:30:04 +00:00
jekyllbot
f0ee377296 Deploy docs from 3fded46fa9
Ashwin Maroli: Lock Ruby in CI to v3.1.2 and bump JRuby to v9.4.0.0 (#9196)

Merge pull request 9196
2022-11-27 16:26:35 +00:00
ashmaroli
04f32fa1b1 Deploy docs from 581717cc41
Ashwin Maroli: Fix ordered-list style in articles on mobiles
2022-11-07 13:16:07 +00:00
jekyllbot
6a6ebafbe3 Deploy docs from 28a475a660
Otto Liljalaakso: Run tests in UTC timezone (#9168)

Merge pull request 9168
2022-11-07 07:19:38 +00:00
jekyllbot
82b652ab92 Deploy docs from f40e5cff5f
Ashwin Maroli: Cleanup highlight tag (#9177)

Merge pull request 9177
2022-11-07 06:54:51 +00:00
jekyllbot
22e787a3a5 Deploy docs from 645584824f
Robert Love: Fix Nested tree navigation with recursion example (#9174)

Merge pull request 9174
2022-11-03 14:52:06 +00:00
jekyllbot
e16ce70fda Deploy docs from 7558ecb1f7
Olly Headey: Allow marking specific highlighted lines via Liquid (#9138)

Merge pull request 9138
2022-11-03 14:41:46 +00:00
ashmaroli
7627c373cf Deploy docs from 99cfe52cd8
Ashwin Maroli: Bump RuboCop to `v1.38.x`

Closes #9173
2022-11-02 09:15:56 +00:00
ashmaroli
f38931d237 Deploy docs from 94028e7f4c
Ashwin Maroli: Remove noise in `features/highlighting.feature`
2022-10-27 14:53:42 +00:00
ashmaroli
7a0cc44c30 Deploy docs from 91e00b2082
Ashwin Maroli: Release 💎 v4.3.1
2022-10-26 17:57:09 +00:00
jekyllbot
8a481cdfb6 Deploy docs from 28d4eacdcb
Ashwin Maroli: Release post for v4.3.1 (#9171)

Merge pull request 9171
2022-10-26 17:49:48 +00:00
jekyllbot
09d544edab Deploy docs from 5367a0261d
Ashwin Maroli: Revert "Incrementally rebuild when a data file is changed (#8771)" (#9170)

Merge pull request 9170
2022-10-26 16:38:47 +00:00
jekyllbot
b1f079b08b Deploy docs from 7206b7f9ef
Ashwin Maroli: Respect user-defined name attribute in documents (#9167)

Merge pull request 9167
2022-10-26 16:37:16 +00:00
ashmaroli
b875e3c1a7 Deploy docs from 390b1f006b
Ashwin Maroli: Revert back to developing 4.3.x

This reverts commit 556febb436.
This reverts commit a613eb2d82.
2022-10-21 17:54:41 +00:00
ashmaroli
18ca7abc88 Deploy docs from a613eb2d82
Ashwin Maroli: Disable critical GH Actions on `master`

To mark `master` as in v5 development mode
2022-10-20 16:54:17 +00:00
ashmaroli
839f786315 Deploy docs from 2b56ad4f6d
Ashwin Maroli: Fix spelling errors in History document
2022-10-20 16:31:20 +00:00
ashmaroli
ffcf7cd708 Deploy docs from 9c2c01bb7a
Ashwin Maroli: Release 💎 v4.3.0
2022-10-20 16:04:57 +00:00
jekyllbot
5be6e5b0ba Deploy docs from b32293cf67
Ashwin Maroli: Release post for v4.3.0 (#9157)

Merge pull request 9157
2022-10-20 15:58:26 +00:00
ashmaroli
6f3425ab41 Deploy docs from e27605e380
Ashwin Maroli: Clean up HEAD section in History document
2022-10-20 13:30:35 +00:00
ashmaroli
c0f3195ed9 Deploy docs from 520326406c
Giuseppe Bertone: Document xz dependency on macOS (#9098)

Signed-off-by: Giuseppe Bertone <giuseppe.bertone@swirldslabs.com>
2022-10-20 10:22:42 +00:00
ashmaroli
701715231c Deploy docs from f030e55f70
Kaben: Fix URL to Liquid documentation (#9158)
2022-10-20 10:16:28 +00:00
ashmaroli
c495a9375c Deploy docs from 6d3dc74c7d
Ashwin Maroli: Bump RuboCop to `v1.37.x`
2022-10-20 09:18:37 +00:00
jekyllbot
ec7a68e5e3 Deploy docs from 03f7ddc801
なつき: Support jekyll-sass-converter 3.x (#9132)

Merge pull request 9132
2022-10-16 14:37:39 +00:00
jekyllbot
8a686fae76 Deploy docs from 6903f0b0f4
Youssef Boulkaid: Fix false positive conflicts for static files in a collection (#9141)

Merge pull request 9141
2022-10-16 11:52:12 +00:00
jekyllbot
3a4166f601 Deploy docs from 5d5d975672
Kaben: Update posts.md (#9151)

Merge pull request 9151
2022-10-07 06:05:46 +00:00
jekyllbot
2071891eb6 Deploy docs from 823c8f94d2
Youssef Boulkaid: Relax RDoc version dependency (#9142)

Merge pull request 9142
2022-10-02 10:17:45 +00:00
jekyllbot
8225da2b09 Deploy docs from 160a6816af
Ashwin Maroli: Incrementally rebuild when a data file is changed (#8771)

Merge pull request 8771
2022-09-29 12:46:55 +00:00
jekyllbot
7637be0c3c Deploy docs from daca7e53a1
Youssef Boulkaid: Disable pending cops when running rubocop (#9136)

Merge pull request 9136
2022-09-29 10:38:25 +00:00
jekyllbot
0b7fda0c67 Deploy docs from 7a70a3ae5e
Youssef Boulkaid: Unlock Psych dependency (#9135)

Merge pull request 9135
2022-09-29 07:17:19 +00:00
jekyllbot
86850388d3 Deploy docs from 1a3d85a8a5
Ashwin Maroli: Relax version constraint to allow Rouge 4.x (#9134)

Merge pull request 9134
2022-09-28 10:56:01 +00:00
ashmaroli
c1c1e7d727 Deploy docs from b632afd2db
Ashwin Maroli: Add version badge to documentation header
2022-09-25 15:14:12 +00:00
ashmaroli
c18805dcaf Deploy docs from d09c5105d7
Ashwin Maroli: Document keys of the `theme` drop

Follow-up to #9129
2022-09-25 14:55:35 +00:00
jekyllbot
a4bd2131e5 Deploy docs from b8cf7cf96d
Ashwin Maroli: Introduce `theme` drop to expose theme details (#9129)

Merge pull request 9129
2022-09-24 13:55:46 +00:00
jekyllbot
6bab7e1d8e Deploy docs from d1e392f301
Josh Soref: Use check-spelling/check-spelling@v0.0.20 (#9111)

Merge pull request 9111
2022-09-23 17:28:17 +00:00
jekyllbot
42116b8190 Deploy docs from 911e249d72
Ashwin Maroli: Bump RuboCop to `1.36.x` (#9125)

Merge pull request 9125
2022-09-21 17:30:41 +00:00
jekyllbot
49a4e952c0 Deploy docs from 7a698d4d14
Nemo: Bump rubocop to 1.32 (#9093)

Merge pull request 9093
2022-08-01 14:25:52 +00:00
jekyllbot
7391d0316b Deploy docs from 18e5e5223b
Andrii Abramov: Update ruby version for macos guide (#9086)

Merge pull request 9086
2022-07-13 23:50:02 +00:00
jekyllbot
2d13d4288b Deploy docs from a0c6b4c595
Andreas Deininger: Improve links (http -> https) (#9064)

Merge pull request 9064
2022-06-21 03:36:24 +00:00
jekyllbot
daf8cad74c Deploy docs from 25369429a7
Kirstin Heidler: Windows: describe which option to choose (#9049)

Merge pull request 9049
2022-06-20 19:23:36 +00:00
ashmaroli
200eef0f63 Deploy docs from 8896e125ef
Ashwin Maroli: Bump RuboCop to `v1.30.x`
2022-05-26 09:45:56 +00:00
jekyllbot
6d970afc70 Deploy docs from 674bcfb37e
Takuya N: Remove Ionic Framework site from showcase (#9057)

Merge pull request 9057
2022-05-16 13:52:15 +00:00
ashmaroli
994c1a7464 Deploy docs from 0f5f5ba8d1
Ashwin Maroli: Bump RuboCop to v1.29.x

Closes #9053
2022-05-09 06:01:19 +00:00
ashmaroli
9435ada2bc Deploy docs from 796ae15c31
Ashwin Maroli: Fix alignment of home page section-units on mobile
2022-05-05 11:16:59 +00:00
ashmaroli
b56a4898b1 Deploy docs from d70ffd2a20
Ashwin Maroli: Fix news-archive list renders on small-devices

Resolves #8839
2022-05-05 07:20:11 +00:00
jekyllbot
807379c1bb Deploy docs from ac93d22df1
Andrew Gutekanst: Remove git.io shortlinks from repo (#9045)

Merge pull request 9045
2022-04-28 12:14:58 +00:00
jekyllbot
7673945044 Deploy docs from 6077ed6a01
Ashwin Maroli: Remove misleading total row from `--profile` table (#9039)

Merge pull request 9039
2022-04-28 06:58:25 +00:00
ashmaroli
96df2ffc43 Deploy docs from 7c28eb5f7e
Ashwin Maroli: Bump RuboCop to `v1.28.x`
2022-04-21 14:54:38 +00:00
jekyllbot
30276a52e4 Deploy docs from 64dbf46a3b
Emily Grace Seville: Add clarity to docs on permalinks placeholders and builtins (#8995)

Merge pull request 8995
2022-04-08 14:23:10 +00:00
ashmaroli
886d3f5cc2 Deploy docs from 1cde234d41
Ashwin Maroli: Bump RuboCop to `v1.27.x`
2022-04-08 13:30:45 +00:00
jekyllbot
92fc11ebcc Deploy docs from 3b3f845846
Ashwin Maroli: Ensure theme config is a `Jekyll::Configuration` object (#8988)

Merge pull request 8988
2022-04-08 09:14:11 +00:00
jekyllbot
a5d1cb9f31 Deploy docs from 23a2451459
dependabot[bot]: Bump actions/checkout from 2 to 3 (#8986)

Merge pull request 8986
2022-04-07 10:54:28 +00:00
jekyllbot
09906d293f Deploy docs from e052d2090c
Ashwin Maroli: Stop testing with Rubies older than 2.7 on non-Windows  (#8955)

Merge pull request 8955
2022-04-07 08:57:37 +00:00
jekyllbot
4118af28e5 Deploy docs from 9c7972dc38
Ashwin Maroli: Check symlink outside site_source without Pathutil (#9015)

Merge pull request 9015
2022-04-03 16:59:26 +00:00
jekyllbot
c344c5f3f8 Deploy docs from 1d5bae583b
Daryl Hepting: Update permalinks.md (#9017)

Merge pull request 9017
2022-04-02 15:26:22 +00:00
jekyllbot
c94f437728 Deploy docs from 6f31b362eb
JT: Improve document about Github Actions section (#8853)

Merge pull request 8853
2022-04-02 15:25:59 +00:00
jekyllbot
9473de45ec Deploy docs from 66e337984e
MichaelCordingley: Allow Configurable Converters on CSV (#8858)

Merge pull request 8858
2022-04-01 13:42:35 +00:00
jekyllbot
6b6232d016 Deploy docs from 2a0272cc38
lm: Only enable BOM encoding option on UTF encodings (#8363)

Merge pull request 8363
2022-04-01 13:36:02 +00:00
jekyllbot
e26dfbc114 Deploy docs from 776748e13f
JJ: Expose `basename` from `document.rb` as `name` to Liquid templates (#8761)

Merge pull request 8761
2022-04-01 13:25:47 +00:00
jekyllbot
0e46e4419a Deploy docs from 65158c2368
Moncef Belyamani: Simplify macOS installation docs (#8993)

Merge pull request 8993
2022-03-29 03:46:58 +00:00
jekyllbot
db5ff67581 Deploy docs from c4387f69fc
Parker Moore: Add Jekyll 3.9.2 release post to 'master' branch (#9013)

Merge pull request 9013
2022-03-27 20:29:05 +00:00
jekyllbot
d8740342f3 Deploy docs from 9d86974e1f
Ashwin Maroli: Expose collection static files via `site.static_files` (#8961)

Merge pull request 8961
2022-03-24 16:33:51 +00:00
jekyllbot
81fc5d3186 Deploy docs from b98db02f36
lucafrance: Remove Aerobatic (#9007)

Merge pull request 9007
2022-03-24 16:29:23 +00:00
jekyllbot
87ebb0b2da Deploy docs from 1096648473
jaybe@jekyll: Update README.markdown re IRC Pointer (#9005)

Merge pull request 9005
2022-03-23 13:40:43 +00:00
jekyllbot
d947070eba Deploy docs from 94dc98cb6b
Ashwin Maroli: Trigger livereload in sites without pages (#8337)

Merge pull request 8337
2022-03-21 15:01:38 +00:00
jekyllbot
26058766b1 Deploy docs from 6984a64932
Emily Grace Seville: Add quiet/verbose options (#8996)

Merge pull request 8996
2022-03-17 19:26:16 +00:00
jekyllbot
7dfabf5fac Deploy docs from 88cbd7a783
Nicholas Paxford: Update manual.md (#8997)

Merge pull request 8997
2022-03-14 11:03:30 +00:00
jekyllbot
fe65a0b0d1 Deploy docs from f48d500586
Emily Grace Seville: Enhace option's case for Jekyll configuration (#8992)

Merge pull request 8992
2022-03-11 10:01:13 +00:00
jekyllbot
ef72601009 Deploy docs from 06abe7fd0c
Gary: Update document by fix yaml syntax error (#8991)

Merge pull request 8991
2022-03-09 17:06:35 +00:00
ashmaroli
7024bd7ade Deploy docs from 380c3fe815
Ashwin Maroli: Bump RuboCop to `v1.26.x`
2022-03-09 17:04:25 +00:00
jekyllbot
9462ddeef6 Deploy docs from 36cbca0ece
Ashwin Maroli: Document releasing off `*-stable` branches (#8984)

Merge pull request 8984
2022-03-04 16:07:20 +00:00
ashmaroli
5dff03077b Deploy docs from 0faa2a4c12
Ashwin Maroli: Release 💎 v4.2.2
2022-03-03 11:02:44 +00:00
jekyllbot
87a19d3283 Deploy docs from 493ed1571e
Ashwin Maroli: Release post for v4.2.2 (#8982)

Merge pull request 8982
2022-03-03 10:52:12 +00:00
jekyllbot
759f21f9d9 Deploy docs from 034d3e9f4b
Ashwin Maroli: Fix response header for content served via `jekyll serve` (#8965)

Merge pull request 8965
2022-02-25 21:16:20 +00:00
jekyllbot
f7c4297d56 Deploy docs from 88044a2ece
Ashwin Maroli: Fix deprecation message for missing doc method (#8960)

Merge pull request 8960
2022-02-10 03:29:48 +00:00
jekyllbot
c7462f713a Deploy docs from c644d9a568
Tyler887: Hakiri sunsetting down (#8946)

Merge pull request 8946
2022-01-31 16:19:41 +00:00
jekyllbot
ac3c92530e Deploy docs from 285f79306b
Robert Martin: Update bug_report.yml (#8951)

Merge pull request 8951
2022-01-31 15:22:36 +00:00
jekyllbot
0ab35f8b86 Deploy docs from e133183f6f
Attaphong Rattanaveerachanon: Update document for github-actions workflow by adding cache step. (#8948)

Merge pull request 8948
2022-01-28 09:22:48 +00:00
jekyllbot
8560ac9ecb Deploy docs from 07cd645ce6
Parker Moore: Run vendor-mimes to update mime.types (#8940)

Merge pull request 8940
2022-01-21 02:51:29 +00:00
ashmaroli
8245d9e9a1 Deploy docs from 4ec6902cdb
Ashwin Maroli: Bump RuboCop to `v1.25.x`

Closes #8941
2022-01-19 10:10:02 +00:00
jekyllbot
ac4511478c Deploy docs from 8578d735bc
Korbs: Fix link for "CloudSh" (#8934)

Merge pull request 8934
2022-01-14 15:31:07 +00:00
jekyllbot
64942b183d Deploy docs from d4a4d951c5
Ashwin Maroli: Improve maintainers guide on releasing a new version (#8928)

Merge pull request 8928
2022-01-08 15:43:17 +00:00
jekyllbot
fbb0361696 Deploy docs from b0a68d56fc
Ashwin Maroli: Rewrite documentation on installing plugins (#8921)

Merge pull request 8921
2022-01-06 15:16:48 +00:00
jekyllbot
3f9155e58f Deploy docs from 77282e45fd
Laurence Andrews: Update resources.md (#8925)

Merge pull request 8925
2022-01-03 20:50:11 +00:00
jekyllbot
a86d534e6a Deploy docs from 0107747606
Toshimaru: Update REAMDE generated by `jekyll new-theme` (#8919)

Merge pull request 8919
2021-12-30 22:30:55 +00:00
jekyllbot
e3ceb6ec37 Deploy docs from a7a7b7a815
Ashwin Maroli: Lock gem `psych` to `v3.x` (#8918)

Merge pull request 8918
2021-12-30 16:02:44 +00:00
ashmaroli
979bbbefbd Deploy docs from d0eb07ba29
Ashwin Maroli: Add `gem "matrix"` to Gemfile

gem "matrix" is no longer a default gem from Ruby 3.1 onward.
Adding the gem to Gemfile is necessary until `classifier-reborn` adds it as a dependency.

Avoiding RUBY_VERSION constraints to ensure the gem is used on older Ruby versions in CI matrix
2021-12-29 13:32:49 +00:00
ashmaroli
7bce905fb8 Deploy docs from 07e510f964
Ashwin Maroli: Add Ruby 3.1 to CI Matrix
2021-12-29 12:33:36 +00:00
jekyllbot
eeee9e7590 Deploy docs from 5b0ea4b220
Rishi Raj Jain: docs: add Layer0 deployment guide (#8915)

Merge pull request 8915
2021-12-27 18:07:15 +00:00
ashmaroli
7ed037b0ff Deploy docs from 66b399c6d3
Ashwin Maroli: Lock `rdoc` to `v6.3.x` to avoid `psych-4.x`

Psych 4.x appears to mess with our Cucumber-based tests with:

```
Tried to load unspecified class: Date (Psych::DisallowedClass)
```
2021-12-27 17:57:42 +00:00
ashmaroli
419bdef3c6 Deploy docs from 659683dbb2
Ashwin Maroli: Bump RuboCop to `v1.24.x`
2021-12-23 11:57:56 +00:00
jekyllbot
611fe3b34e Deploy docs from e6928dab2e
Ashwin Maroli: Manage repository meta documents consistently (#8908)

Merge pull request 8908
2021-12-17 15:15:03 +00:00
jekyllbot
9e80840f67 Deploy docs from 5aeb2bfe4e
Parker Moore: Add Security Policy document (#8823)

Merge pull request 8823
2021-12-16 14:18:17 +00:00
jekyllbot
7bc583537c Deploy docs from 23af360ef0
Maik Riechert: Remove text on GITHUB_TOKEN which is now built-in (#8907)

Merge pull request 8907
2021-12-16 13:55:44 +00:00
jekyllbot
80e09ecff4 Deploy docs from 9c9cf3e82b
Phil Ross: Support both tzinfo v1 and v2 alongwith non-half hour offsets. (#8880)

Merge pull request 8880
2021-12-08 11:36:18 +00:00
jekyllbot
0e6c923f42 Deploy docs from 7fdae26c25
Kantanat-Stamp: Linting README,markdown (#8900)

Merge pull request 8900
2021-12-08 11:31:11 +00:00
ashmaroli
6ed5db68f0 Deploy docs from 9fa340af65
Ashwin Maroli: Remove lock on Bundler version in CI

Bundler 2.2.33 has been released
2021-12-08 10:53:16 +00:00
ashmaroli
dfb751d534 Deploy docs from 1434644dcc
Ashwin Maroli: Lock Bundler to `v2.2.31` and bump JRuby version

- Bundler 2.2.32 causes our CI to fail prematurely, affecting checks of pull requests.
- JRuby 9.2.20.1 is a recommended security fix.
2021-12-08 10:47:35 +00:00
jekyllbot
bb9f4d642f Deploy docs from a8ccdd6d2f
Michael Gerzabek: Propagate _data folder from theme (#8815)

Merge pull request 8815
2021-11-22 13:02:08 +00:00
ashmaroli
15e1d418da Deploy docs from 9a3122020e
Ashwin Maroli: Upgrade Bug-report template to beta form template
2021-11-22 09:53:32 +00:00
ashmaroli
9aff8cb0e7 Deploy docs from bb49d93713
Ashwin Maroli: Stop assigning Frank to docs-related issues
2021-11-22 05:22:53 +00:00
ashmaroli
b504f786f1 Deploy docs from f51ccbfad3
Ashwin Maroli: Bump RuboCop to v1.23.x
2021-11-17 14:23:48 +00:00
jekyllbot
7c4b7ac9c0 Deploy docs from 3a688fe55a
Phil Ross: Fix random test failures in TestExcerpt #to_liquid. (#8884)

Merge pull request 8884
2021-11-17 09:48:57 +00:00
jekyllbot
050f5de81d Deploy docs from 369c345107
Ashwin Maroli: Improve readability of CI logs (#8877)

Merge pull request 8877
2021-11-12 16:16:57 +00:00
jekyllbot
d0b20da94f Deploy docs from db3f034f9e
Ashwin Maroli: Add a workflow to build gems consistently (#8830)

Merge pull request 8830
2021-11-05 10:33:52 +00:00
ashmaroli
bc05b1792f Deploy docs from 10a73596d9
Ashwin Maroli: Add lang identifiers to shell based codeblocks
2021-10-28 07:01:04 +00:00
jekyllbot
387b2f6cb5 Deploy docs from 47b0abe1f0
Ashwin Maroli: Slightly update lang `sh` code-block styling (#8857)

Merge pull request 8857
2021-10-28 05:05:18 +00:00
jekyllbot
a1c3ea1d70 Deploy docs from 868d9af3cb
Meet Gor: Added docs for running locally (#8852)

Merge pull request 8852
2021-10-23 18:16:21 +00:00
ashmaroli
b9f960bc91 Deploy docs from e1838db156
Ashwin Maroli: Update spell-check workflow configuration
2021-10-10 07:27:13 +00:00
ashmaroli
4feb25e592 Deploy docs from 8af22d0852
Ashwin Maroli: Regenerate RuboCop TODO file
2021-10-06 12:29:47 +00:00
jekyllbot
0a3cf4ec0f Deploy docs from 45fdf35cc3
Meg Gutshall: Fix typo (#8835)

Merge pull request 8835
2021-10-01 19:09:00 +00:00
jekyllbot
214360d83f Deploy docs from cfcc0c524e
Matt Rogers: Relax Rubocop Dependency (#8831)

Merge pull request 8831
2021-09-30 15:23:38 +00:00
jekyllbot
81e6672f67 Deploy docs from 32e97a7881
Ricardo N Feliciano: Update CircleCI example (#8829)

Merge pull request 8829
2021-09-30 14:38:03 +00:00
ashmaroli
4647b2bf8a Deploy docs from 5687bf97d8
Ashwin Maroli: Release 💎 4.2.1
2021-09-27 11:24:13 +00:00
jekyllbot
f4b37f5589 Deploy docs from 5cc308825e
Ashwin Maroli: Release post for v4.2.1 (#8818)

Merge pull request 8818
2021-09-27 11:07:12 +00:00
jekyllbot
96bb74b8f9 Deploy docs from a05b0d94cd
Matt Rogers: Remove the warning about auto-regeneration on Windows (#8821)

Merge pull request 8821
2021-09-23 18:40:01 +00:00
jekyllbot
87f9a0436b Deploy docs from 70a6702a6a
Matt Rogers: Move Frank to Emeritus Core Team Members (#8813)

Merge pull request 8813
2021-09-16 16:52:19 +00:00
jekyllbot
32e33260a5 Deploy docs from b27fb044e7
Matt Rogers: Remove AWS Amplify from the showcase (#8812)

Merge pull request 8812
2021-09-16 16:49:25 +00:00
jekyllbot
46e44fc305 Deploy docs from 891a78685a
Ashwin Maroli: Always hide cache-dir contents from Git (#8798)

Merge pull request 8798
2021-09-16 16:25:15 +00:00
jekyllbot
475c445d2c Deploy docs from 00289460df
SaintMalik: Update feature_request.md (#8797)

Merge pull request 8797
2021-09-16 15:20:28 +00:00
jekyllbot
369e3ec54d Deploy docs from 9b2126a365
Matt Rogers: Prefer Libera. Remove Freenode (#8811)

Merge pull request 8811
2021-09-16 15:19:55 +00:00
jekyllbot
27f57bd118 Deploy docs from fe563b15bd
Atlas Cove: Update index.html (#8803)

Merge pull request 8803
2021-09-16 15:10:01 +00:00
jekyllbot
038e9a3563 Deploy docs from faef38b5db
Ben Keith: Revert #7253: "Don't reset site.url to localhost:4000 by default" (#8620)

Merge pull request 8620
2021-09-15 13:54:14 +00:00
jekyllbot
059f36456a Deploy docs from f831286557
Matt Rogers: Goodbye Frank. We'll miss you. 💔 (#8807)

Merge pull request 8807
2021-09-14 19:35:36 +00:00
ashmaroli
fd890db5cd Deploy docs from 1aea1580c1
Ashwin Maroli: Utilize previously allocated local variable

Follow-up to aa9a416
2021-08-30 09:04:11 +00:00
jekyllbot
3805dc1651 Deploy docs from 84c8252f11
Qasim Qureshi: Update troubleshooting.md (#8777)

Merge pull request 8777
2021-08-29 11:15:36 +00:00
jekyllbot
ae774344f6 Deploy docs from eca450454f
Ashwin Maroli: Fix regression in Convertible module from v4.2.0  (#8786)

Merge pull request 8786
2021-08-29 07:23:25 +00:00
ashmaroli
e2c1891d78 Deploy docs from 493b800edb
Nahin Khan: Remove trailing whitespace in _config.yml template (#8774)
2021-08-20 05:49:15 +00:00
ashmaroli
e2ad0ca111 Deploy docs from 2568aea6ea
Ashwin Maroli: Fix RuboCop offenses in tests
2021-08-18 09:56:35 +00:00
jekyllbot
ec8f344208 Deploy docs from ddbc8263de
Sampath Sukesh Ravolaparthi: Tags:Highlight: Decomposed HTMLLegacy formatter (#8623)

Merge pull request 8623
2021-08-09 12:32:03 +00:00
jekyllbot
b4b85a32d9 Deploy docs from aa9a4164d0
Ashwin Maroli: Respect collections_dir config within include tag (#8756)

Merge pull request 8756
2021-08-05 15:19:29 +00:00
jekyllbot
d09f3a9fa4 Deploy docs from 9c7015138b
Jeff Wilcox: Fixing URL in MacOS install for rbenv-doctor (#8693)

Merge pull request 8693
2021-07-23 14:47:35 +00:00
jekyllbot
088ae56639 Deploy docs from 94fcfdd787
Alex Malaszkiewicz: Enable Rubocop accessor grouping, fix existing offenses (#8293)

Merge pull request 8293
2021-07-23 14:46:05 +00:00
jekyllbot
af939c5572 Deploy docs from 9bb98edb29
Aram Akhavan: use location.protocol to inject the livereload script instead of forcing http (#8718)

Merge pull request 8718
2021-07-23 14:42:56 +00:00
jekyllbot
0ec8445bcb Deploy docs from 3f46f02108
Andrew Davis: Update rubocop from 1.12 to 1.18 and min ruby from 2.4 to 2.5 (#8741)

Merge pull request 8741
2021-07-22 17:59:16 +00:00
jekyllbot
4b18376218 Deploy docs from 0eb9239151
Mike Kasberg: Improve GitHub Flavored Markdown Docs (#8684)

Merge pull request 8684
2021-07-22 17:58:24 +00:00
jekyllbot
30745ed966 Deploy docs from b31f933cd1
dependabot[bot]: Bump check-spelling/check-spelling from 0.0.18 to 0.0.19 (#8740)

Merge pull request 8740
2021-07-22 17:53:42 +00:00
jekyllbot
f0480b7489 Deploy docs from 37612632c5
jaybe@jekyll: IRC networks - Libera, Freenode (#8706)

Merge pull request 8706
2021-07-22 17:52:53 +00:00
jekyllbot
f37ab50fb7 Deploy docs from 8a6dd9e494
Parikshit87: Update windows.md (#8701)

Merge pull request 8701
2021-07-22 17:50:30 +00:00
jekyllbot
cea26fac35 Deploy docs from bcaf878b65
Miguel Brandão: Add 'webrick' warning note to "Quickstart" Docs (#8727)

Merge pull request 8727
2021-07-22 17:49:39 +00:00
jekyllbot
2cd1a9ae01 Deploy docs from 0dee66260f
fauno: Optimize `Jekyll::Utils.parse_date` (#8425)

Merge pull request 8425
2021-07-22 17:48:24 +00:00
jekyllbot
7ce8f09083 Deploy docs from b5e910acfb
Mike Kasberg: Improve the "Markdown Options" Docs (#8681)

Merge pull request 8681
2021-05-18 08:01:22 +00:00
jekyllbot
524627b273 Deploy docs from 42dacc1091
Frank Taillandier: fix(security):  CVE-2021-28834 (#8680)

Merge pull request 8680
2021-05-18 06:32:09 +00:00
DirtyF
6c87fbf8b9 Deploy docs from e5dd889750
Frank Taillandier: Update expect.txt
2021-05-17 21:55:44 +00:00
DirtyF
7632a8f6c7 Deploy docs from 889fe4130b
Frank Taillandier: Update expect.txt
2021-05-16 20:13:53 +00:00
DirtyF
b0ef17948c Deploy docs from 7605b0a474
Frank Taillandier: Update History.markdown
2021-05-16 20:13:16 +00:00
jekyllbot
029dc45067 Deploy docs from 1ffda285d6
Edson Jiménez: Add step to set SDKROOT (#8478)

Merge pull request 8478
2021-05-16 20:11:18 +00:00
jekyllbot
e2e34dfbba Deploy docs from 49a00ebbec
nusu: Add formcarry to forms section (#8471)

Merge pull request 8471
2021-05-16 20:10:01 +00:00
jekyllbot
40db50b4cc Deploy docs from 93ef9389ba
Liam Bigelow: Load Jekyll plugins from BUNDLE_GEMFILE location (#8585)

Merge pull request 8585
2021-05-16 20:06:35 +00:00
jekyllbot
b53d0e58ec Deploy docs from 7e350ac031
Kelvin M. Klann: Revert "style: run rubocop -a" (#8676)

Merge pull request 8676
2021-05-16 20:01:25 +00:00
jekyllbot
388d91ac91 Deploy docs from 92633c6996
Josh Soref: Update expect to cover docs/_posts (#8677)

Merge pull request 8677
2021-05-16 19:59:26 +00:00
jekyllbot
0e3d3039bb Deploy docs from 9ed85a028a
Sesh Sadasivam: Add documentation for Sass configuration options (#8587)

Merge pull request 8587
2021-05-14 20:39:46 +00:00
jekyllbot
f6dd42e3eb Deploy docs from 3259064723
alena-ko: Update third-party.md (#8652)

Merge pull request 8652
2021-05-14 20:34:11 +00:00
jekyllbot
a153c1aa2f Deploy docs from 579d0d9ffc
Ben Keith: Specify default port and host for serve commands (#8624)

Merge pull request 8624
2021-05-14 20:31:31 +00:00
jekyllbot
6063a11ca2 Deploy docs from d5a46fcd31
Shyam Mohan K: razorops cicd added (#8656)

Merge pull request 8656
2021-05-14 20:30:51 +00:00
jekyllbot
0d9db96b34 Deploy docs from 5d35cf217b
Kelvin M. Klann: style: run rubocop -a (#8654)

Merge pull request 8654
2021-05-14 19:54:59 +00:00
DirtyF
ded9ed6a50 Deploy docs from 827bfcff58
Frank Taillandier: chore(styles): align hash
2021-05-14 19:53:21 +00:00
jekyllbot
7db8f5656e Deploy docs from d85c89e8b4
Kelvin M. Klann: docs: clarify where .jekyll-metadata comes from (#8646)

Merge pull request 8646
2021-05-14 19:38:16 +00:00
DirtyF
0052656443 Deploy docs from 813da60a53
Jonathan Darrer: Action configuration to use "main" as default repo (#8578)

Updates the action configuration to use "main" as default repository name

The default GitHub branch when creating a repository is now "main" and no longer "master", but included a comment for those with older repositories.

https://github.com/github/renaming
https://www.zdnet.com/article/github-to-replace-master-with-main-starting-next-month/

Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2021-05-14 19:28:23 +00:00
jekyllbot
d092b4b31c Deploy docs from 2e65d6d3a9
Kelvin M. Klann: docs: add overview of .jekyll-cache dir (#8648)

Merge pull request 8648
2021-05-14 19:25:27 +00:00
jekyllbot
5ae9bf695e Deploy docs from 15ad8f4bdd
Kelvin M. Klann: fix: pin rubocop to 1.12 due to error with ruby 2.4 (#8651)

Merge pull request 8651
2021-05-14 19:19:48 +00:00
DirtyF
c4e4e7918d Deploy docs from 4fbbefeb7e
Josh Soref: Spelling (#8661)

* spelling: always

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: apostrophe

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: articles

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: bajillion

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: bandwidth

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: compatibilize

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: congratulations

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: consistent

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: containing

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: correspondents

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: debuggability

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: definitions

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: engine

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: expectations

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: framework

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: gallery

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: github

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: gitlab

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: hesitant

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: hesitate

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: highlighter

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: installation

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: internal

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: kramdown

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: link

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: markdown

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: markdownify

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: metadata

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: multiple

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: object

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: overridden

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: paths

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: positions

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: powershell

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: proceeding

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: pygments settings

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: referencing

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: retrieve

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: separating

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: several

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: specific

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: suppress

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: upgrading

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: variable

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: variables

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: whitespace

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

* spelling: with

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>

Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-05-14 19:18:37 +00:00
DirtyF
d57590ffa1 Deploy docs from 3fea30c862
Vinhas Kevin: Document JEKYLL_LOG_LEVEL and JEKYLL_NO_BUNDLER_REQUIRE (#8553)

While adding `JEKYLL_LOG_LEVEL`, I also found out that `JEKYLL_NO_BUNDLER_REQUIRE` wasn't mentioned in the docs.

I am not sure it belong to this exact place in the doc, so I followed the only env variables example I could find in the doc (`JEKYLL_ENV`)
This diff closes #8480
2021-05-14 19:17:31 +00:00
DirtyF
ea0d1ade82 Deploy docs from da68570406
shorty: Update filters.md (#8655)

Provide people an on-ramp to creating custom Liquid template filters in the docs.
2021-05-14 19:12:43 +00:00
DirtyF
f4cbd0857b Deploy docs from 8940ad65b1
Nick Coish: Fix typo in 02-liquid.md (#8637)
2021-05-14 19:12:03 +00:00
DirtyF
5127e9f085 Deploy docs from 47a17e2cab
Chris Keefe: ruby-devel required for OpenSuse (#8640)

Initially raised in https://github.com/jekyll/jekyll/issues/8118, this patches the installation requirements
2021-05-14 19:10:53 +00:00
DirtyF
99a8057884 Deploy docs from c523f041fc
Jesse van der Pluijm: Replace references to 'master' branch with 'main' (#8657)

As the default branch name on GitHub has been `main` for a while now: https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/
2021-05-14 19:06:08 +00:00
DirtyF
adcaafec50 Deploy docs from af5bb813aa
jaybe@jekyll: Update community.md and fix up IRC reference link (#8672)
2021-05-14 19:01:51 +00:00
DirtyF
499e54ba9f Deploy docs from 62ba3c03b7
Daniel Kehoe: Update macos.md (#8663)

Explain the choice between installation with Homebrew and rbenv. Mention the other Ruby version managers (asdf, chruby, rvm). Provide a link to a guide that gives more detail and explains the benefits and drawbacks of installation with Homebrew and various version managers. (I'm proposing this addition because there have been frequent questions on Reddit /r/ruby and Stack Overflow by users who installed Ruby for Jekyll with Homebrew and later needed to switch Ruby versions).
2021-05-14 18:59:14 +00:00
DirtyF
ef9f81487e Deploy docs from e53fd19bc3
Ikko Ashimine: Fix typo in contributing.md (#8666)

specfic -> specific
2021-05-14 18:58:28 +00:00
DirtyF
cad68a6f72 Deploy docs from 73637a41b1
dependabot[bot]: Bump actions/cache from v2.1.3 to v2.1.5 (#8645)

Bumps [actions/cache](https://github.com/actions/cache) from v2.1.3 to v2.1.5.
- [Release notes](https://github.com/actions/cache/releases)
- [Commits](https://github.com/actions/cache/compare/v2.1.3...1a9e2138d905efd099035b49d8b7a3888c653ca8)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-05-14 18:57:36 +00:00
parkr
5db2e23607 Deploy docs from 6855200ebd
Parker Moore: Merge pull request #8635 from jekyll/add-3-9-1-stuff
2021-04-08 15:57:08 +00:00
jekyllbot
8e7755d195 Deploy docs from 63ce7d66bf
David Zhang: docs: troubleshoot macOS with ARM64 architecture (#8560)

Merge pull request 8560
2021-03-29 12:56:48 +00:00
jekyllbot
57c205fe56 Deploy docs from 91c0f2a08d
Jonathan Darrer: Use latest Jekyll-action configuration (#8579)

Merge pull request 8579
2021-03-27 16:27:37 +00:00
jekyllbot
8ae5fb8ee0 Deploy docs from b828ffd559
Moncef Belyamani: Fix for important missing step in macOS Installation Docs: Add the Homebrew gems directory to the PATH (#8496)

Merge pull request 8496
2021-03-27 16:26:00 +00:00
DirtyF
3817aee15d Deploy docs from 2aa33c8043
Eric Cousineau: liquid: Replace "mutually exclusive" with "orthogonal" (#8584)

Was a bit confused when I saw "mutually exclusive" regarding `error_mode` and (`strict_variables`, `strict_filters`), then to see both sets turned on.

Perhaps "orthogonal" (they don't affect each other) is slightly better wording than "mutually exclusive" (they can't "exist" at the same time)?
2021-03-27 16:09:14 +00:00
jekyllbot
e013e8221b Deploy docs from 5d01099e22
Parker Moore: Update include tag to be more permissive (#8618)

Merge pull request 8618
2021-03-27 15:36:42 +00:00
DirtyF
107ecfb0cb Deploy docs from 6c170f11af
Frank Taillandier: styles: Rubocop 1.12
2021-03-27 15:30:05 +00:00
DirtyF
b4ced63138 Deploy docs from 734cf2324e
Otto Urpelainen: Relax dependency version constraints (#8586)

During Fedora 34 development, Jekyll 4.2.0 has been tested against
dependency versions outside of current definitions. This commit
relaxes constraints to allow some versions that were found compatible:

* `mercenary` was 0.3.6 in Fedora, works correctly. Nothing in
  [changelist][1] indicates problems, either.
* `terminal-table` was 1.8.0 in Fedora, then updated directly to
  3.0.0. Both were tested and found to work well. The [changelist][2]
  also shows that breaking changes between terminal-table 1 and 3 are
  either deprecation of very old Ruby runtimes or tiny changes to
  terminal output.

[1]: https://github.com/jekyll/mercenary/blob/master/History.markdown
[2]: https://github.com/tj/terminal-table/blob/master/History.rdoc
2021-03-26 14:13:22 +00:00
DirtyF
96d1a0a9d7 Deploy docs from 5e7172c9ab
Robert Martin: Update macOS install docs for Big Sur (#8595)

Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2021-03-26 14:11:53 +00:00
DirtyF
a2a699a9df Deploy docs from d25db24065
Robert Martin: Update current Ruby version to 3.0.0 (#8596)
2021-03-26 14:09:52 +00:00
DirtyF
72a146730f Deploy docs from 17beafeca7
David Bruant: docs: Clarify relative_url and absolute_url filters (#8612)

Co-authored-by: Michael Currin <18750745+MichaelCurrin@users.noreply.github.com>
Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2021-03-26 14:07:49 +00:00
jekyllbot
472679398c Deploy docs from df24131349
Adam Bell: Cross Version Testing Locally and Faster CI (#8610)

Merge pull request 8610
2021-03-26 00:51:40 +00:00
DirtyF
41b3d8aaf8 Deploy docs from c9c9dc7dac
Frank Taillandier: chore(deps): rubocop 1.10

fix #8583
2021-02-19 08:27:01 +00:00
jekyllbot
146347defd Deploy docs from 32d9320d34
SNVMK: Update 3-to-4.md (#8572)

Merge pull request 8572
2021-02-05 05:24:45 +00:00
jekyllbot
b5c92d9d28 Deploy docs from fe64d9841b
Frank Taillandier: style: add rubocop 1.9 cops (#8567)

Merge pull request 8567
2021-02-01 10:55:43 +00:00
jekyllbot
82bec32d7c Deploy docs from d460fae31a
Tejas Bubane: Pin rubocop version (#8564)

Merge pull request 8564
2021-01-31 16:22:11 +00:00
DirtyF
f83d757e14 Deploy docs from e0e856f216
Frank Taillandier: chore: check-html-links
2021-01-30 22:24:50 +00:00
jekyllbot
6eeebe7364 Deploy docs from d46897fabf
Shannon Kularathna: Step By Step Instructions Review (#8399)

Merge pull request 8399
2021-01-19 08:57:03 +00:00
jekyllbot
9e2f8bcef9 Deploy docs from 6dcd470f3d
dependabot[bot]: Update actions/cache requirement to v2.1.3 (#8543)

Merge pull request 8543
2021-01-13 07:32:10 +00:00
jekyllbot
cde6143481 Deploy docs from cbf656877e
Alex Saveau: Regenerate supported mime types (#8542)

Merge pull request 8542
2021-01-13 07:31:37 +00:00
jekyllbot
032c78a854 Deploy docs from c4055cd3d6
John Losito: Allow dependabot to keep github actions up-to-date (#8540)

Merge pull request 8540
2021-01-12 23:50:52 +00:00
jekyllbot
f3a8affb65 Deploy docs from 13152e1247
Ben Whetton: Remove GitHub Pages content which is in GitHub docs (#8533)

Merge pull request 8533
2021-01-12 23:45:03 +00:00
jekyllbot
88d83bf98b Deploy docs from 8c8326e9ab
Frank Taillandier: style: enable new cops (#8538)

Merge pull request 8538
2021-01-12 23:40:27 +00:00
jekyllbot
e50f4d677b Deploy docs from 5c797ba136
Clayton Smith: Add webrick as a dependency (#8524)

Merge pull request 8524
2021-01-10 21:26:19 +00:00
DirtyF
a4c958ceb1 Deploy docs from 31e152b0d0
Frank Taillandier: docs: update guide

- use latest versions
- link to https://github.com/limjh16/jekyll-action-ts
2021-01-07 15:18:02 +00:00
jekyllbot
9a3d7e6791 Deploy docs from d78fc653a6
Phil Kirlin: Fix i.e. typos in collections.md (#8529)

Merge pull request 8529
2021-01-03 09:53:30 +00:00
jekyllbot
937fc66267 Deploy docs from e4031b21c9
Jeffrey Veen: Fixes typo in layouts_dir documentation (#8532)

Merge pull request 8532
2021-01-03 09:52:03 +00:00
jekyllbot
267e907d2f Deploy docs from 319cc95254
Ashwin Maroli: Improve documentation on developing generators (#8527)

Merge pull request 8527
2021-01-01 16:29:55 +00:00
jekyllbot
f06f4243ae Deploy docs from 75a895c95d
Ashwin Maroli: Add a disclaimer to tutorials involving Ruby code (#8525)

Merge pull request 8525
2021-01-01 16:19:53 +00:00
ashmaroli
bf71dfb618 Deploy docs from 92e50227bd
Ashwin Maroli: `2020/12/31` is no longer a future date
2020-12-31 18:11:10 +00:00
jekyllbot
bad343453e Deploy docs from d1173c9d06
Craig H Maynard: Document support for TSV files consistently (#8488)

Merge pull request 8488
2020-12-31 17:38:45 +00:00
jekyllbot
99115a2286 Deploy docs from 52fd9451b6
Curious Cat: typo - do instead of don't (#8518)

Merge pull request 8518
2020-12-31 17:37:36 +00:00
ashmaroli
c2bc3b4965 Deploy docs from ca03e7ab8f
Ashwin Maroli: Jekyll 4 can be run on Ruby 2.4
2020-12-16 14:40:16 +00:00
DirtyF
4ac7ffd58d Deploy docs from 871a05a9a4
Frank Taillandier: Release 💎 4.2.0
2020-12-14 12:35:29 +00:00
DirtyF
314750678e Deploy docs from 98d06862ee
Frank Taillandier: Release: Jekyll 4.2.0 (#8466)

* chore(release): 4.2.0 💎

Co-authored-by: Ashwin Maroli <ashmaroli@gmail.com>
2020-12-14 12:35:07 +00:00
ashmaroli
0d83a9701e Deploy docs from 1e2d72a574
Ashwin Maroli: Remove redundant quotes around YAML value
2020-12-11 14:27:56 +00:00
DirtyF
15884681ac Deploy docs from 0d7665c517
Frank Taillandier: docs: new homebrew script [skip ci]
2020-12-10 23:31:30 +00:00
ashmaroli
a9548d5424 Deploy docs from 3ca9d6e891
Ashwin Maroli: Format History entries for changes on HEAD
2020-12-10 14:59:47 +00:00
jekyllbot
962424fdcd Deploy docs from 01825f51db
Ashwin Maroli: Stash attribute hash for Liquid computed for pages (#8497)

Merge pull request 8497
2020-12-10 14:04:22 +00:00
ashmaroli
8b7dc4bc53 Deploy docs from c70437e2de
Ashwin Maroli: Correct offenses reported by RuboCop 1.6.0
2020-12-09 17:42:03 +00:00
ashmaroli
2edb187def Deploy docs from 84deb286ed
Ashwin Maroli: Improve maintainability of showcase data and page
2020-12-09 17:00:36 +00:00
jekyllbot
c9e4e7904e Deploy docs from 46cb37f479
Frank Taillandier: fix: showcase (#8504)

Merge pull request 8504
2020-12-06 22:58:45 +00:00
jekyllbot
04448ae640 Deploy docs from 91aed9ff8b
Ashwin Maroli: Migrate TravisCI jobs to GitHub Actions (#8492)

Merge pull request 8492
2020-12-04 18:43:07 +00:00
DirtyF
9b427836af Deploy docs from c4d493072d
Toby Glei: docs: update deployment docs for 21yunbox (#8494)

* docs: new deployment docs for 21yunbox

Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2020-12-04 10:51:13 +00:00
DirtyF
32e52d967e Deploy docs from f4a7eee57a
Frank Taillandier: docs: shell-based instructions

Fix #8483
2020-12-04 10:21:25 +00:00
DirtyF
00568a163b Deploy docs from 2f1ba8e7be
Frank Taillandier: docs: Shell-based instructions

Fix #8483
2020-12-04 10:11:06 +00:00
jekyllbot
6b0597205d Deploy docs from c80ccbebf7
Ashwin Maroli: Optimize Page#dir with a private method (#8489)

Merge pull request 8489
2020-12-02 17:28:11 +00:00
DirtyF
2b45f52ab4 Deploy docs from 686165af12
Jacobo Vidal: Add Arengu to form services list documentation (#8414)

* Add Arengu to form services list
2020-12-02 13:13:28 +00:00
ashmaroli
f23b85b4df Deploy docs from 371298f69b
Ashwin Maroli: Compute hash of Gemfile.lock in workflow
2020-12-02 06:41:21 +00:00
jekyllbot
d9b4d92c3c Deploy docs from 573b431abb
Ashwin Maroli: Reduce allocations from computing item property (#8485)

Merge pull request 8485
2020-12-02 05:57:43 +00:00
DirtyF
1d1cf93b56 Deploy docs from 68497a4d4b
Dan Nemenyi: Echo PATH to .zshenv for newer macOS's (#8483)

* Add PATH to Zsh for newer macOSs

Apple switched the default shell to Zsh with Catalina, so updating the PATH in .bash_profile will not have effect for relevant users, and is increasingly now the legacy approach.

This commit adds instructions to echo the PATH to .zshenv, the Zsh equivalent of .bash_profile, as well as to check which version of macOS the user is using.

* Update PATH in local macOS documentation
2020-12-01 13:57:39 +00:00
DirtyF
c411ce5c1c Deploy docs from 6132653d5a
Frank Taillandier: docs: Homebrew bash script

Fix ##8490
2020-12-01 13:56:01 +00:00
ashmaroli
f469e9674d Deploy docs from 9084f9f752
Ashwin Maroli: Configure new cops
2020-11-30 17:02:08 +00:00
jekyllbot
3ebf7d6732 Deploy docs from 568f4c5b76
Adam Alton: structure.md: add link to Assets page from `_sass` section (#8486)

Merge pull request 8486
2020-11-29 19:21:44 +00:00
ashmaroli
3eb9bd7520 Deploy docs from 97db005336
Ashwin Maroli: Remove version constraint on gem `tomlrb`

This gem is required by the test-suite
2020-11-27 08:43:48 +00:00
jekyllbot
c0c288b48b Deploy docs from 58368cdacc
Ashwin Maroli: Debug reading data files in a site (#8481)

Merge pull request 8481
2020-11-26 18:22:38 +00:00
DirtyF
0899ff7368 Deploy docs from d8d1feec71
Frank Taillandier: style: auo-gen-exclude
2020-11-23 15:59:02 +00:00
DirtyF
88c7aaec99 Deploy docs from 8559fbfbe8
Frank Taillandier: style: append o option to regexp

Performance/ConstantRegexp: Extract this regexp into a constant or append an /o option to its options.
2020-11-23 15:53:51 +00:00
DirtyF
f6c3d735f4 Deploy docs from d560d53266
Frank Taillandier: style: fix rubocop 1.40 offense
2020-11-23 15:47:48 +00:00
jekyllbot
1a8754a497 Deploy docs from a7e1ec901b
Ashwin Maroli: Add custom debug strings for Jekyll objects (#8473)

Merge pull request 8473
2020-11-18 10:44:12 +00:00
jekyllbot
ba5ff13004 Deploy docs from 37df92dd29
Ashwin Maroli: Explicitly return nil after site process phase (#8472)

Merge pull request 8472
2020-11-18 10:42:57 +00:00
ashmaroli
2d30f88feb Deploy docs from 430167b9b9
Ashwin Maroli: Do not exclude CNAME from site build
2020-11-12 07:02:58 +00:00
ashmaroli
7db72c6cb1 Deploy docs from ed7a4857a5
Ashwin Maroli: chore: rake site:generate
2020-11-12 06:49:52 +00:00
Frank Taillandier
0f79fbff17 Create CNAME 2020-11-11 21:27:36 +01:00
DirtyF
25d13f404c Deploy docs from 6f8ca8c764
Frank Taillandier: chore: cleanup 4.1.1 changelog
2020-11-11 20:25:22 +00:00
Frank Taillandier
68f117f5b3 docs: Ruby 2.7.2 2020-11-11 21:18:43 +01:00
jekyllbot
8ae4bf3f4a Update history to reflect merge of #8201 [ci skip] 2020-11-11 14:52:56 -05:00
iBug
10943d1f3a Build docs site with GitHub Actions (#8201)
Merge pull request 8201
2020-11-11 14:52:53 -05:00
jekyllbot
4d31a8c51b Update history to reflect merge of #8467 [ci skip] 2020-11-11 12:45:22 -05:00
Ashwin Maroli
e210e337bc Improve documentation on Hooks in Jekyll (#8467)
Merge pull request 8467
2020-11-11 12:45:20 -05:00
Frank Taillandier
6dd5bf21b9 chore: site generate 2020-11-11 16:28:56 +01:00
jekyllbot
ec3c0115c7 Update history to reflect merge of #7253 [ci skip] 2020-11-11 07:59:47 -05:00
Ashwin Maroli
91a3dd9e6f Don't reset site.url to localhost:4000 by default (#7253)
Merge pull request 7253
2020-11-11 07:59:44 -05:00
jekyllbot
9fbb7b57c9 Update history to reflect merge of #7414 [ci skip] 2020-11-11 07:50:00 -05:00
Ashwin Maroli
eae71e6235 Rendering arbitrary Liquid variables by default (#7414)
Merge pull request 7414
2020-11-11 07:49:58 -05:00
jekyllbot
661f0fa1b1 Update history to reflect merge of #8292 [ci skip] 2020-11-11 07:39:42 -05:00
Ashwin Maroli
fadbe9eba4 Test that Liquid expressions are not deeply evaled (#8292)
Merge pull request 8292
2020-11-11 07:39:40 -05:00
jekyllbot
83a2b30b76 Update history to reflect merge of #8100 [ci skip] 2020-11-11 07:29:07 -05:00
Ashwin Maroli
26086409bf Debug reading Page and Layout objects (#8100)
Merge pull request 8100
2020-11-11 07:29:05 -05:00
jekyllbot
d3299a8e02 Update history to reflect merge of #8406 [ci skip] 2020-11-11 05:38:05 -05:00
Ashwin Maroli
054d9356b9 Reduce allocations from rendering item as liquid (#8406)
Merge pull request 8406
2020-11-11 05:38:03 -05:00
jekyllbot
9de60bbf48 Update history to reflect merge of #8465 [ci skip] 2020-11-11 05:36:56 -05:00
Ashwin Maroli
c12a04dbc1 Allow triggering :post_convert events atomically (#8465)
Merge pull request 8465
2020-11-11 05:36:54 -05:00
jekyllbot
11ff8aa0dd Update history to reflect merge of #8463 [ci skip] 2020-11-09 07:03:17 -05:00
Ashwin Maroli
db9ca22c24 Generate items from site.include list only once (#8463)
Merge pull request 8463
2020-11-09 07:03:16 -05:00
jekyllbot
ddae19bbb4 Update history to reflect merge of #8459 [ci skip] 2020-11-08 11:15:19 -05:00
Ashwin Maroli
ce441d32ec Enhance detection of conflicting destination URLs (#8459)
Merge pull request 8459
2020-11-08 11:15:17 -05:00
jekyllbot
bcbc451a26 Update history to reflect merge of #8458 [ci skip] 2020-11-06 08:05:04 -05:00
Ashwin Maroli
920c6f4ddc Memoize destination of pages, documents and staticfiles (#8458)
Merge pull request 8458
2020-11-06 08:05:02 -05:00
jekyllbot
56d59a1782 Update history to reflect merge of #8457 [ci skip] 2020-11-05 09:38:54 -05:00
Ashwin Maroli
5054e57fa5 Enable Lint/NoReturnInBeginEndBlocks Cop (#8457)
Merge pull request 8457
2020-11-05 09:38:52 -05:00
Ashwin Maroli
0dedc09ab3 Move PathManager methods into its singleton class 2020-11-05 17:30:59 +05:30
jekyllbot
9b96cdfa7d Update history to reflect merge of #8456 [ci skip] 2020-11-05 06:45:36 -05:00
Enrico Tolotto
accce8656b docs: installation: fedora: add additional dependencies (#8456)
Merge pull request 8456
2020-11-05 06:45:34 -05:00
Ashwin Maroli
d3e3225fc1 Configure cops introduced in RuboCop v1.2 2020-11-05 16:00:33 +05:30
jekyllbot
80fce9fcc3 Update history to reflect merge of #8453 [ci skip] 2020-11-04 10:31:02 -05:00
Ashwin Maroli
bf18b27e2a Reduce array allocations from merging categories (#8453)
Merge pull request 8453
2020-11-04 10:31:00 -05:00
Ashwin Maroli
02d25d1cf2 actions/setup-ruby does not support patch versions 2020-11-03 12:17:14 +05:30
jekyllbot
3de3e7be8e Update history to reflect merge of #8444 [ci skip] 2020-11-02 16:31:02 -05:00
Ashwin Maroli
137de414c1 Use Ruby 2.7.1 in GitHub Actions (#8444)
Merge pull request 8444
2020-11-02 16:31:00 -05:00
Frank Taillandier
1099f73d2d fix(deps): Terminal Table 2.0
fix #8452
2020-11-02 22:29:52 +01:00
jekyllbot
95a7b20787 Update history to reflect merge of #8451 [ci skip] 2020-11-02 04:04:23 -05:00
Ashwin Maroli
a6bbcb7fb6 Memoize defaults computed for Convertibles (#8451)
Merge pull request 8451
2020-11-02 04:04:21 -05:00
Ashwin Maroli
e06641f423 Configure cops from RuboCop 1.1 2020-10-29 23:36:51 +05:30
Ashwin Maroli
4bda8cefb8 Refer to Bundler as a proper noun [ci skip] 2020-10-29 22:44:50 +05:30
Rachel Cheyfitz - Owner
5ec7a8e289 Update 07-assets.md (#8449)
Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2020-10-29 18:07:32 +01:00
jekyllbot
2c18ddcd80 Update history to reflect merge of #8450 [ci skip] 2020-10-29 13:03:48 -04:00
Rachel Cheyfitz - Owner
ebac932f10 docs: init project (#8450)
Merge pull request 8450
2020-10-29 13:03:46 -04:00
jekyllbot
25ccfd5b49 Update history to reflect merge of #8447 [ci skip] 2020-10-26 16:24:19 -04:00
Gabriel Staples
bd063ae0f0 Add links to all Jekyll themes on GitHub tagged with #jekyll-theme (#8447)
Merge pull request 8447
2020-10-26 16:24:17 -04:00
Ashwin Maroli
1ae2a1dd04 Bump RuboCop to v1.x 2020-10-21 17:57:08 +05:30
jekyllbot
8948277363 Update history to reflect merge of #8421 [ci skip] 2020-10-16 08:31:11 -04:00
Ashwin Maroli
7c56e397c9 Memoize array of drop getter method names (#8421)
Merge pull request 8421
2020-10-16 08:31:09 -04:00
SaintMalik
20abb8f62b Fix broken url in docs (#8435) 2020-10-12 11:22:30 +02:00
jekyllbot
e4db593814 Update history to reflect merge of #8394 [ci skip] 2020-10-11 05:15:49 -04:00
Ashwin Maroli
5dc43a88de Stash frequently used Drop setter keys for reuse (#8394)
Merge pull request 8394
2020-10-11 05:15:46 -04:00
jekyllbot
e0221ed3a8 Update history to reflect merge of #8393 [ci skip] 2020-10-11 04:41:28 -04:00
Ashwin Maroli
34a78e1ea2 Check default front matter scope against symbols (#8393)
Merge pull request 8393
2020-10-11 04:41:25 -04:00
Corey Megown
6d30bac845 correcting lightburn company spelling (#8433) 2020-10-10 21:42:53 +02:00
jekyllbot
9f8ac4eb7a Update history to reflect merge of #8430 [ci skip] 2020-10-08 15:32:51 -04:00
Frank Taillandier
bcff13a16a chore(deps): bump Rubocop to 0.93.0 (#8430)
Merge pull request 8430
2020-10-08 15:32:49 -04:00
jekyllbot
01d0b78abb Update history to reflect merge of #8427 [ci skip] 2020-10-08 10:03:18 -04:00
Ashwin Maroli
335429b10c Use Regexp#match? when MatchData is not required (#8427)
Merge pull request 8427
2020-10-08 10:03:16 -04:00
jekyllbot
e739c777fc Update history to reflect merge of #8424 [ci skip] 2020-10-07 10:39:09 -04:00
fauno
59bafa802b Cache Jekyll.sanitized_path (#8424)
Merge pull request 8424
2020-10-07 10:39:06 -04:00
Ashwin Maroli
56e15c5ace Profile allocations from lib/jekyll.rb as well 2020-10-07 18:47:29 +05:30
Ashwin Maroli
e59e998b42 Allow testing on Ruby 2.4 as well
Cucumber 5.x requires at least Ruby 2.5
2020-10-04 16:12:10 +05:30
jekyllbot
c9b84e2b35 Update history to reflect merge of #8400 [ci skip] 2020-10-01 09:53:15 -04:00
Ashwin Maroli
ecbfa58d65 Reduce allocation from normalize_whitespace filter (#8400)
Merge pull request 8400
2020-10-01 09:53:12 -04:00
jekyllbot
f0e342d390 Update history to reflect merge of #8403 [ci skip] 2020-10-01 09:51:43 -04:00
Ashwin Maroli
11020f80fa Utilize flexibility of Site#in_dest_dir (#8403)
Merge pull request 8403
2020-10-01 09:51:41 -04:00
Pratyaksh Gautam
d26970cf25 Update your-first-plugin.md (#8420) 2020-10-01 13:13:42 +02:00
jekyllbot
b17cb5fe2a Update history to reflect merge of #8404 [ci skip] 2020-09-30 02:49:14 -04:00
Ashwin Maroli
f7292ec9cc Enable Performance/ChainArrayAllocation cop (#8404)
Merge pull request 8404
2020-09-30 02:49:12 -04:00
jekyllbot
166796c448 Update history to reflect merge of #8408 [ci skip] 2020-09-30 02:11:30 -04:00
Ashwin Maroli
7cb10df0b8 Compute relative_path of pages using PathManager (#8408)
Merge pull request 8408
2020-09-30 02:11:28 -04:00
Ashwin Maroli
7d8a839a21 Restore Gemfile to prior state
rubocop-ast-0.7.1 has dropped the dependency on gem 'strscan'.
So the workaround is no longer necessary.

https://rubygems.org/gems/rubocop-ast/versions/0.7.1
2020-09-30 11:19:07 +05:30
jekyllbot
b71a26d11d Update history to reflect merge of #8418 [ci skip] 2020-09-28 10:21:59 -04:00
Ashwin Maroli
711986d19f Fix test suite compatibility with JRuby (#8418)
Merge pull request 8418
2020-09-28 10:21:57 -04:00
jekyllbot
c7c7be9b3a Update history to reflect merge of #8415 [ci skip] 2020-09-28 04:42:05 -04:00
Ashwin Maroli
98b7a4626a Handle nil argument to Jekyll.sanitized_path (#8415)
Merge pull request 8415
2020-09-28 04:42:01 -04:00
Frank Taillandier
16f8370ccd test: pubish cucumber report
--publish automatically publishes reports to reports.cucumber.io
https://github.com/cucumber/cucumber-ruby/blob/master/CHANGELOG.md#500
2020-09-26 20:15:53 +02:00
jekyllbot
fe898af92f Update history to reflect merge of #8413 [ci skip] 2020-09-26 03:27:39 -04:00
jesuslerma
adc0a2e182 Update cucumber gem version to 5.1.2 (#8413)
Merge pull request 8413
2020-09-26 03:27:36 -04:00
Frank Taillandier
2518dd16ff docs: Rubocop 0.92.0 [ci-skip] 2020-09-25 10:59:25 +02:00
Frank Taillandier
8b7847c8e6 chore(deps): bump Rubocop to 0.92.0 2020-09-25 10:58:05 +02:00
jekyllbot
993960ba8c Update history to reflect merge of #8409 [ci skip] 2020-09-25 03:50:07 -04:00
Takuya N
3f4a0da4d5 Remove NOKOGIRI_USE_SYSTEM_LIBRARIES from Travis CI docs (#8409)
Merge pull request 8409
2020-09-25 03:50:05 -04:00
jekyllbot
6326b1f9d4 Update history to reflect merge of #8410 [ci skip] 2020-09-25 03:47:51 -04:00
Takuya N
30ac3e07ba Remove CircleCI v1 docs as it was sunset in 2019 (#8410)
Merge pull request 8410
2020-09-25 03:47:49 -04:00
Ashwin Maroli
0ee9331892 Disable Continuous Integration workflow [ci skip] 2020-09-24 23:52:17 +05:30
jekyllbot
fd8a7e7e3b Update history to reflect merge of #8401 [ci skip] 2020-09-24 07:36:13 -04:00
Ashwin Maroli
51b976ed05 Check if site is in incremental mode optimally (#8401)
Merge pull request 8401
2020-09-24 07:36:10 -04:00
jekyllbot
715fe0c572 Update history to reflect merge of #8183 [ci skip] 2020-09-23 16:13:07 -04:00
Ashwin Maroli
53f175516b Implement custom delegators for drop methods (#8183)
Merge pull request 8183
2020-09-23 16:13:05 -04:00
Ashwin Maroli
c5d4bbd434 Exclude test files from a Layout RuboCop cop 2020-09-23 20:45:30 +05:30
m-naumann
eb4d91d5e5 docs: Clarify gem installation instructions (#8407) 2020-09-22 14:51:55 +02:00
Frank Taillandier
f8c72089dd docs: GitHub Pages is using 3.9.0
https://pages.github.com/versions/
2020-09-18 14:34:36 +02:00
jekyllbot
609fa612be Update history to reflect merge of #8392 [ci skip] 2020-09-18 07:23:10 -04:00
Ashwin Maroli
a401f0387e Reduce string allocations from generating doc URLs (#8392)
Merge pull request 8392
2020-09-18 07:23:08 -04:00
Ashwin Maroli
07e1eb1f27 Use commit message flag to control workflows 2020-09-17 20:30:26 +05:30
jekyllbot
49c11725b3 Update history to reflect merge of #8398 [ci skip] 2020-09-17 09:53:37 -04:00
Ashwin Maroli
c066999fa0 Add workflow to build and profile third-party repo (#8398)
Merge pull request 8398
2020-09-17 09:53:35 -04:00
Nicholas Paxford
94930c5a58 Update 05-includes.md (#8364)
Added two commas (line 19 and 60)
2020-09-16 19:46:41 +02:00
jekyllbot
7e0f907c64 Update history to reflect merge of #8391 [ci skip] 2020-09-16 06:36:28 -04:00
Ashwin Maroli
3fd7449fa1 Bump RuboCop to v0.91.x (#8391)
Merge pull request 8391
2020-09-16 06:36:26 -04:00
jekyllbot
0d337c8a93 Update history to reflect merge of #8389 [ci skip] 2020-09-14 09:37:58 -04:00
Ashwin Maroli
bd04997fee Stash documents write? attribute in a variable (#8389)
Merge pull request 8389
2020-09-14 09:37:56 -04:00
jekyllbot
c9ab616ace Update history to reflect merge of #8192 [ci skip] 2020-09-14 07:36:13 -04:00
Ashwin Maroli
f2b463bb85 Optimize parsing of parameters in include tag (#8192)
Merge pull request 8192
2020-09-14 07:36:10 -04:00
jekyllbot
3fb307dc25 Update history to reflect merge of #8387 [ci skip] 2020-09-11 09:24:27 -04:00
Ashwin Maroli
51bb40913b Reduce string allocations from the link tag (#8387)
Merge pull request 8387
2020-09-11 09:24:25 -04:00
jekyllbot
959fc18db5 Update history to reflect merge of #7236 [ci skip] 2020-09-09 12:05:02 -04:00
Ashwin Maroli
b456a69fa2 Refactor Jekyll::Utils::Platforms (#7236)
Merge pull request 7236
2020-09-09 12:04:59 -04:00
jekyllbot
ae2ec98262 Update history to reflect merge of #8383 [ci skip] 2020-09-09 05:18:22 -04:00
Ashwin Maroli
d1093e0160 Improve maintainability of config option data (#8383)
Merge pull request 8383
2020-09-09 05:18:20 -04:00
jekyllbot
1fbc4c28ea Update history to reflect merge of #8380 [ci skip] 2020-09-08 14:08:20 -04:00
Malathi
23f59f4153 Docs: Use data file(s) to render table(s) at https://jekyllrb.com/docs/configuration/options/ (#8380)
Merge pull request 8380
2020-09-08 14:08:17 -04:00
jekyllbot
e9b62b89a4 Update history to reflect merge of #8377 [ci skip] 2020-09-07 13:38:08 -04:00
Malathi
5924eb19f6 Use data file to render table at /docs/configuration/options/#global-configuration (#8377)
Merge pull request 8377
2020-09-07 13:38:06 -04:00
jekyllbot
ae7115638a Update history to reflect merge of #8375 [ci skip] 2020-09-07 09:40:14 -04:00
Ashwin Maroli
34add02e8b Fix path matching regex in post_url Liquid tag (#8375)
Merge pull request 8375
2020-09-07 09:40:12 -04:00
jekyllbot
abdbb58d8a Update history to reflect merge of #8359 [ci skip] 2020-09-06 11:57:51 -04:00
Shannon Kularathna
7188eac40f Add note about rebooting system after installation (#8359)
Merge pull request 8359
2020-09-06 11:57:48 -04:00
jekyllbot
6847a6cfcb Update history to reflect merge of #8372 [ci skip] 2020-09-05 10:52:07 -04:00
Shannon Kularathna
85508ccbf3 Docs Review: Getting Started (#8372)
Merge pull request 8372
2020-09-05 10:52:04 -04:00
jekyllbot
a0d7900bbe Update history to reflect merge of #8313 [ci skip] 2020-09-04 16:10:44 -04:00
jnozsc
e824f6b9cc Update rubocop gem to 0.90.0 (#8313)
Merge pull request 8313
2020-09-04 16:10:41 -04:00
jekyllbot
5aaa69da3e Update history to reflect merge of #8365 [ci skip] 2020-09-04 09:59:31 -04:00
Chuck Houpt
a88e5ef2b1 Add missing flag and options doc for build and serve commands (#8365)
Merge pull request 8365
2020-09-04 09:59:29 -04:00
jekyllbot
0de0f7ec35 Update history to reflect merge of #8358 [ci skip] 2020-09-04 08:33:00 -04:00
Thelonius Kort
910782e349 Replacing GIT_REPO by GIT_DIR (#8358)
Merge pull request 8358
2020-09-04 08:32:57 -04:00
jekyllbot
bed94b8ee7 Update history to reflect merge of #8369 [ci skip] 2020-09-04 06:08:16 -04:00
Ashwin Maroli
822bb57d41 Configure Performance cops (#8369)
Merge pull request 8369
2020-09-04 06:08:14 -04:00
Ashwin Maroli
ae6911d38a Update history to reflect merge of #8368 [ci skip] 2020-09-04 12:37:15 +05:30
Liam Cooke
eac6eb25b8 Add post_convert hook to modify HTML content before layout (#8368)
Co-authored-by: John Hughes <johnkhughes@users.noreply.github.com>
2020-09-04 12:31:24 +05:30
jekyllbot
badc9c2d30 Update history to reflect merge of #8354 [ci skip] 2020-08-27 12:50:20 -04:00
Shannon Kularathna
bc9895aa9b Clarify description of safe option (#8354)
Merge pull request 8354
2020-08-27 12:50:17 -04:00
Lou Rectoret
4299095d21 Run server with Autoreload (#8355)
* docs: livereload option

Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2020-08-25 15:44:58 +02:00
jekyllbot
b561413a81 Update history to reflect merge of #8353 [ci skip] 2020-08-24 10:42:13 -04:00
Shannon Kularathna
37a250bd8d Update default.md with info requested in #8314 (#8353)
Merge pull request 8353
2020-08-24 10:42:10 -04:00
jekyllbot
cac8d6ca5f Update history to reflect merge of #8352 [ci skip] 2020-08-23 10:39:08 -04:00
joelkennedy
0edc075818 Update documentation on third party site (#8352)
Merge pull request 8352
2020-08-23 10:39:06 -04:00
jekyllbot
0a2315d3af Update history to reflect merge of #8347 [ci skip] 2020-08-19 13:16:21 -04:00
Seeker
4f81011442 Supress warning issued for redirect pages (#8347)
Merge pull request 8347
2020-08-19 13:16:18 -04:00
jekyllbot
2afa51b9e1 Update history to reflect merge of #8349 [ci skip] 2020-08-17 11:58:06 -04:00
Frank Taillandier
d3126f57fd fix: security bump (#8349)
Merge pull request 8349
2020-08-17 11:58:02 -04:00
Ashwin Maroli
9dc60e4088 Update history regarding cherry-picks from docs-40 2020-08-16 22:40:26 +05:30
Alexey Pelykh
6a444634db Added docs for enhanced link tag 2020-08-16 22:29:11 +05:30
Nikita Skalkin
f26d70b53c Docs for remove support for Redcarpet
via #6990 and #8344


Co-authored-by: Emil Sågfors <emil.sagfors@iki.fi>
2020-08-16 22:17:38 +05:30
Frank Taillandier
190cffe875 rdiscount is not supported anymore 2020-08-16 22:04:43 +05:30
jekyllbot
b5201c50ff Update history to reflect merge of #8342 [ci skip] 2020-08-16 06:48:22 -04:00
Seeker
a4f5b850af Warn on command-line with permalink conflict (#8342)
Merge pull request 8342
2020-08-16 06:48:19 -04:00
Ashwin Maroli
9a7955d9b3 Update test to reflect changes in the latest Rouge 2020-08-12 16:12:59 +05:30
Ashwin Maroli
56ed7bed5d Stop testing on Windows via GitHub Actions
The builds seem to be choking for the past few days due to the presence of symlinked files.

Fortunately, AppVeyor builds continue to run as before.
2020-08-12 15:34:09 +05:30
Parker Moore
24a509f68b Merge pull request #8326 from jekyll/release-jekyll-3-9-0
Add Jekyll 3.9.0 release post
2020-08-05 14:44:54 -04:00
Parker Moore
180673b5a5 Add Jekyll 3.9.0 release post to main documentation 2020-08-05 14:43:06 -04:00
jekyllbot
95f45a0a04 Update history to reflect merge of #8325 [ci skip] 2020-08-05 14:19:28 -04:00
jekyllbot
ef2736d9a6 Update history to reflect merge of #8323 [ci skip] 2020-08-05 14:16:51 -04:00
Frank Taillandier
a39509678e fix: W3C HTML5 Validator warning
The type attribute is unnecessary for JavaScript resources.
2020-08-03 12:01:08 +02:00
jekyllbot
f9aa4b921e Update history to reflect merge of #8320 [ci skip] 2020-07-29 16:38:34 -04:00
Christopher Brown
113aa48ca6 Clarify target of subordinate clause (#8320)
Merge pull request 8320
2020-07-29 16:38:32 -04:00
jekyllbot
319c0d214e Update history to reflect merge of #8319 [ci skip] 2020-07-29 13:18:00 -04:00
bytecode1024
6256ae0719 Extra apostrophes in an URL (#8319)
Merge pull request 8319
2020-07-29 13:17:58 -04:00
jekyllbot
b728eda026 Update history to reflect merge of #8312 [ci skip] 2020-07-23 03:03:51 -04:00
iBug ♦
975c091d14 Fix IRB error "ubygems" (#8199) (#8312)
Merge pull request 8312
2020-07-23 03:03:48 -04:00
jekyllbot
df7589ae18 Update history to reflect merge of #7864 [ci skip] 2020-07-17 06:44:25 -04:00
Brittany Joiner
943a6fdb87 Update resources.md (#7864)
Merge pull request 7864
2020-07-17 06:44:23 -04:00
Steven Xu
d90d1f2494 add punctuation (#8306) 2020-07-16 18:28:22 +02:00
jekyllbot
581fcaddab Update history to reflect merge of #8305 [ci skip] 2020-07-16 12:23:07 -04:00
Francesco Bianco
e2159f72e3 Update default.html (#8305)
Merge pull request 8305
2020-07-16 12:23:05 -04:00
Ashwin Maroli
716536b551 Clarify relevance of data file basename [skip ci] 2020-07-12 21:40:05 +05:30
jekyllbot
1a03aafb81 Update history to reflect merge of #8297 [ci skip] 2020-07-10 14:38:57 -04:00
Alex Malaszkiewicz
f11fc5c1d1 Add refactoring type to PULL_REQUEST_TEMPLATE (#8297)
Merge pull request 8297
2020-07-10 14:38:55 -04:00
jekyllbot
1ab4dffe3c Update history to reflect merge of #8296 [ci skip] 2020-07-10 04:45:56 -04:00
Alex Malaszkiewicz
261fb28b11 Update RuboCop to-do file (#8296)
Merge pull request 8296
2020-07-10 04:45:54 -04:00
jekyllbot
43a8a4666d Update history to reflect merge of #8294 [ci skip] 2020-07-09 14:26:01 -04:00
Alex Malaszkiewicz
f5826eed3c Replace nested conditional with guard clauses (#8294)
Merge pull request 8294
2020-07-09 14:25:59 -04:00
jekyllbot
119c490ad2 Update history to reflect merge of #8291 [ci skip] 2020-07-08 14:46:09 -04:00
Ashwin Maroli
a5b6602ffd Add a note on the rendering process in the docs (#8291)
Merge pull request 8291
2020-07-08 14:46:06 -04:00
jekyllbot
6c640012a2 Update history to reflect merge of #8287 [ci skip] 2020-07-08 14:32:43 -04:00
Alex Malaszkiewicz
bdc67c4474 Update rubocop gem to 0.87.1 (#8287)
Merge pull request 8287
2020-07-08 14:32:40 -04:00
jekyllbot
bbde471f53 Update history to reflect merge of #8283 [ci skip] 2020-07-06 08:12:14 -04:00
Joe Marshall
8a1073733d Add Formcake to forms section (#8283)
Merge pull request 8283
2020-07-06 08:12:12 -04:00
jekyllbot
c94c9aab33 Update history to reflect merge of #8282 [ci skip] 2020-07-05 15:16:03 -04:00
Alex Malaszkiewicz
2c793fcf77 Move permalink styles data to constant (#8282)
Merge pull request 8282
2020-07-05 15:16:01 -04:00
jekyllbot
f693faf1b6 Update history to reflect merge of #8278 [ci skip] 2020-07-03 14:11:21 -04:00
Alex Malaszkiewicz
7e26a8623c Update cucumber gem to version 4.1 (#8278)
Merge pull request 8278
2020-07-03 14:11:17 -04:00
jekyllbot
690183baf5 Update history to reflect merge of #8230 [ci skip] 2020-07-01 02:35:17 -04:00
Felix Breidenstein
148608256a Fix 'page 1' special treatment in pagination docs (#8230)
Merge pull request 8230
2020-07-01 02:35:14 -04:00
jekyllbot
d596ceb5c2 Update history to reflect merge of #8274 [ci skip] 2020-07-01 02:32:47 -04:00
jaybe@jekyll
930c65fb20 Update pointer to special permalink variables for collections (#8274)
Merge pull request 8274
2020-07-01 02:32:44 -04:00
Frank Taillandier
b3b9fae4bc Release 💎 4.1.1 2020-06-24 18:57:46 +02:00
Frank Taillandier
06b969db5d chore: generate site 2020-06-24 18:57:25 +02:00
Frank Taillandier
baf0274234 chore: bump to 4.1.1 2020-06-24 18:55:53 +02:00
jekyllbot
3ec61e6a68 Update history to reflect merge of #8243 [ci skip] 2020-06-24 12:53:32 -04:00
Ashwin Maroli
a7b8d27bda Release post for v4.1.1 (#8243)
Merge pull request 8243
2020-06-24 12:53:29 -04:00
jekyllbot
3ebbb7994f Update history to reflect merge of #8265 [ci skip] 2020-06-24 08:02:28 -04:00
HonkingGoose
3f6e230d53 Change word (#8265)
Merge pull request 8265
2020-06-24 08:02:25 -04:00
jekyllbot
5446e0ed54 Update history to reflect merge of #8264 [ci skip] 2020-06-24 07:59:42 -04:00
HonkingGoose
edbafe8c98 Update link to Netlify step-by-step guide (#8264)
Merge pull request 8264
2020-06-24 07:59:40 -04:00
Ashwin Maroli
52a1db530a Bump RuboCop to v0.86.x 2020-06-22 20:02:29 +05:30
jekyllbot
c250b2abd3 Update history to reflect merge of #8231 [ci skip] 2020-06-22 09:40:06 -04:00
Ashwin Maroli
8136d490e3 Allow hyperlinks to specific filter documentation (#8231)
Merge pull request 8231
2020-06-22 09:40:04 -04:00
jekyllbot
5481ba0f22 Update history to reflect merge of #8261 [ci skip] 2020-06-20 17:59:45 -04:00
Bianca Power
b3de5ab83a correct typo (#8261)
Merge pull request 8261
2020-06-20 17:59:43 -04:00
jekyllbot
0975bd7990 Update history to reflect merge of #8236 [ci skip] 2020-06-17 09:26:56 -04:00
Ashwin Maroli
ba29de02d4 Make page excerpts consistent with doc excerpts (#8236)
Merge pull request 8236
2020-06-17 09:26:53 -04:00
jekyllbot
c78ecc8d82 Update history to reflect merge of #8250 [ci skip] 2020-06-13 14:55:55 -04:00
jaybe@jekyll
d89b0974a2 Update liquid.md (#8250)
Merge pull request 8250
2020-06-13 14:55:52 -04:00
jekyllbot
35e2f7cc3e Update history to reflect merge of #8249 [ci skip] 2020-06-13 02:59:24 -04:00
jaybe@jekyll
426e050b32 Add language and examples to describe how to use the configuration options. (#8249)
Merge pull request 8249
2020-06-13 02:59:21 -04:00
Markoz Peña
a7e74122f3 Fix typo name of repository (#8248) 2020-06-12 23:28:26 +02:00
jekyllbot
cddaa4de6f Update history to reflect merge of #8247 [ci skip] 2020-06-12 15:10:47 -04:00
Markoz Peña
e874ba3044 Change name to ▲Vercel (#8247)
Merge pull request 8247
2020-06-12 15:10:44 -04:00
jekyllbot
df75b3babf Update history to reflect merge of #8241 [ci skip] 2020-06-09 16:50:23 -04:00
Lucas Alves
6a8b9fc35d Including correct Sketch website (#8241)
Merge pull request 8241
2020-06-09 16:50:21 -04:00
jekyllbot
f4b7db18a5 Update history to reflect merge of #8234 [ci skip] 2020-06-08 08:39:52 -04:00
Ashwin Maroli
ee20e844aa Don't generate excerpts for non-html pages (#8234)
Merge pull request 8234
2020-06-08 08:39:50 -04:00
jekyllbot
0bb04d45c7 Update history to reflect merge of #8235 [ci skip] 2020-06-08 01:28:44 -04:00
Anthony
72c7529e27 Replace deprecated 'show' command with 'info' (#8235)
Merge pull request 8235
2020-06-08 01:28:42 -04:00
jekyllbot
81c13507c8 Update history to reflect merge of #8227 [ci skip] 2020-06-05 03:05:14 -04:00
Ashwin Maroli
75ae986208 Expect drive letter only on vanilla windows (#8227)
Merge pull request 8227
2020-06-05 03:05:12 -04:00
Ashwin Maroli
03256d7b80 Revert re-introduction of PageDrop
Reverts commit 1bfb12b210.
2020-06-04 20:08:35 +05:30
Ashwin Maroli
1bfb12b210 Revert deletion of PageDrop
Reverts commit 8590ab0768.
Reverts commit 69154c2ef7.
2020-06-04 19:24:51 +05:30
jekyllbot
69154c2ef7 Update history to reflect merge of #8221 [ci skip] 2020-06-04 08:54:19 -04:00
Ashwin Maroli
8590ab0768 Revert introduction of PageDrop (#8221)
Merge pull request 8221
2020-06-04 08:54:16 -04:00
jekyllbot
53c76b8a4b Update history to reflect merge of #8222 [ci skip] 2020-06-04 04:57:13 -04:00
Ashwin Maroli
8b22c9dcd5 Disable page excerpts by default (#8222)
Merge pull request 8222
2020-06-04 04:57:10 -04:00
Ashwin Maroli
4b57a4187e Revert temporary locks on ffi gem for Windows
This reverts commit 4046ca2322.
This reverts commit da61a16ee2.
2020-06-03 15:28:13 +05:30
jekyllbot
c7c645ed6e Update history to reflect merge of #8223 [ci skip] 2020-06-01 14:07:45 -04:00
Ashwin Maroli
751b8f9c3c Bump RuboCop to v0.85.x (#8223)
Merge pull request 8223
2020-06-01 14:07:43 -04:00
Ashwin Maroli
4046ca2322 Temporarily lock ffi gem to v1.12.x on Windows 2020-06-01 22:50:34 +05:30
Ashwin Maroli
da61a16ee2 Temporarily lock ffi gem to v1.12.x on Windows 2020-06-01 22:29:00 +05:30
Koos Looijesteijn
99c9b51c3a Add atom:link rel="self" to RSS feed template (#8213)
The [W3C validator](https://validator.w3.org/feed/check.cgi) says:
> This feed is valid, but interoperability with the widest range of feed readers could be improved by implementing the following recommendations.

With the added line, this should be fixed.
2020-05-28 15:52:24 +02:00
Ashwin Maroli
627e3bbe53 Release post of v4.1.0 (#8209)
Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2020-05-27 12:53:29 +02:00
Frank Taillandier
d1c72e87b1 Release 💎 4.1.0 2020-05-27 12:43:37 +02:00
Frank Taillandier
0a48b23695 chore(release): v4.1.0 💎 2020-05-27 12:43:37 +02:00
Frank Taillandier
e05f2b9d5b docs: fix classifier-reborn link
Fix #8211
2020-05-27 11:30:47 +02:00
jekyllbot
84ea040d0d Update history to reflect merge of #8158 [ci skip] 2020-05-25 13:01:06 -04:00
Ashwin Maroli
1292dcc24a Initialize include-files as Jekyll objects (#8158)
Merge pull request 8158
2020-05-25 13:01:03 -04:00
jekyllbot
2f4c73f38c Update history to reflect merge of #8188 [ci skip] 2020-05-25 12:20:13 -04:00
Ashwin Maroli
c0fde30d4b Initialize static files' data hash only if needed (#8188)
Merge pull request 8188
2020-05-25 12:20:10 -04:00
Ashwin Maroli
bf568cc657 Revert merge of #8126 [skip ci]
This reverts commit ab8c4b9b50
and commit 5e2af1ba54
2020-05-22 22:27:59 +05:30
Ashwin Maroli
5e2af1ba54 Trigger Deploy Docs on push event 2020-05-22 22:18:28 +05:30
Ashwin Maroli
ab8c4b9b50 Add a workflow to build and deploy docs site (#8126) 2020-05-22 22:13:40 +05:30
jekyllbot
e761d0692c Update history to reflect merge of #7813 [ci skip] 2020-05-22 11:01:19 -04:00
iBug ♦
13b7291649 Make number_of_words respect CJK characters (#7813)
Merge pull request 7813
2020-05-22 11:01:17 -04:00
jekyllbot
2e80c557e3 Update history to reflect merge of #8171 [ci skip] 2020-05-21 06:56:49 -04:00
Ashwin Maroli
0b2c4c9cec Add find filters to optimize where-first chains (#8171)
Merge pull request 8171
2020-05-21 06:56:47 -04:00
jekyllbot
aecd937864 Update history to reflect merge of #6760 [ci skip] 2020-05-21 06:06:16 -04:00
Ashwin Maroli
589b122416 Profile various stages of a site's build process (#6760)
Merge pull request 6760
2020-05-21 06:06:14 -04:00
Ashwin Maroli
5649cac7e7 Bump RuboCop to v0.84.x
Enable new Lint/DeprecatedOpenSSLConstant cop

Additionally:
  * Enable Layout/EmptyLinesAroundAttributeAccessor cop
  * Sort configuration by cop names alphabetically
  * Add a blank line to separate various departments
2020-05-21 15:02:37 +05:30
jekyllbot
476ec0de9e Update history to reflect merge of #7642 [ci skip] 2020-05-21 04:44:17 -04:00
Ashwin Maroli
1ec3843130 Allow excerpts to be generated for Page objects (#7642)
Merge pull request 7642
2020-05-21 04:44:14 -04:00
jekyllbot
673f3d20ba Update history to reflect merge of #8196 [ci skip] 2020-05-20 17:04:20 -04:00
Ashwin Maroli
098eab0304 Improve documentation on tags and categories (#8196)
Merge pull request 8196
2020-05-20 17:04:15 -04:00
jekyllbot
881fdc1c01 Update history to reflect merge of #7482 [ci skip] 2020-05-20 07:44:18 -04:00
Ashwin Maroli
696e8e4b99 Filter out exclusively excluded entries sooner (#7482)
Merge pull request 7482
2020-05-20 07:44:15 -04:00
jekyllbot
bc3b92c151 Update history to reflect merge of #8193 [ci skip] 2020-05-20 05:28:58 -04:00
Toby Glei
b5e9870f45 docs: add 21yunbox for deployment (#8193)
Merge pull request 8193
2020-05-20 05:28:56 -04:00
jekyllbot
d7bec8015f Update history to reflect merge of #8191 [ci skip] 2020-05-19 16:29:34 -04:00
Philip Eriksson
b18a6830c3 Update third-party.md (#8191)
Merge pull request 8191
2020-05-19 16:29:31 -04:00
jekyllbot
a4ef72631a Update history to reflect merge of #8187 [ci skip] 2020-05-18 08:15:16 -04:00
Philip Eriksson
497246dcf9 Remove sudo from Travis CI tutorial (#8187)
Merge pull request 8187
2020-05-18 08:15:13 -04:00
codenitpicker
603fae800a docs: kramdown options (#8181)
Example usage of kramdown options

Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2020-05-17 14:03:37 +02:00
jekyllbot
5679e4aa93 Update history to reflect merge of #8178 [ci skip] 2020-05-14 09:38:11 -04:00
dotnetCarpenter
58a73a53d0 Ease discovery of CLI commands (in their entirety) (#8178)
Merge pull request 8178
2020-05-14 09:38:08 -04:00
Ashwin Maroli
7baca87e59 Remove outdated constraint in Gemfile 2020-05-14 14:41:24 +05:30
jekyllbot
838575421b Update history to reflect merge of #8177 [ci skip] 2020-05-14 04:58:44 -04:00
Ashwin Maroli
709e633016 Check if entry is a directory once per enumerator (#8177)
Merge pull request 8177
2020-05-14 04:58:42 -04:00
jekyllbot
3c8b6c92e7 Update history to reflect merge of #8167 [ci skip] 2020-05-14 02:20:23 -04:00
matt swanson
f8286b62a2 Switch slugify regex to support more Unicode character groups (#8167)
Merge pull request 8167
2020-05-14 02:20:20 -04:00
Ashwin Maroli
11dd893416 Bump RuboCop to v0.83.x 2020-05-11 18:21:16 +05:30
jekyllbot
8403184b14 Update history to reflect merge of #8154 [ci skip] 2020-05-10 11:02:38 -04:00
Ashwin Maroli
eb2423c6c4 Optimize path sanitization of default front matter (#8154)
Merge pull request 8154
2020-05-10 11:02:36 -04:00
jekyllbot
dc8f57d412 Update history to reflect merge of #8165 [ci skip] 2020-05-10 10:39:26 -04:00
Ashwin Maroli
88e3078a20 Provide invokables for common drop query keys (#8165)
Merge pull request 8165
2020-05-10 10:39:24 -04:00
jekyllbot
9f31fe1c3b Update history to reflect merge of #8170 [ci skip] 2020-05-10 05:29:26 -04:00
Ashwin Maroli
ce483d29a4 Site: Filter through just the docs collection (#8170)
Merge pull request 8170
2020-05-10 05:29:24 -04:00
Ashwin Maroli
001df60ea0 Use Ruby 2.6 on GitHub Actions
until all of the dependencies are installable on Ruby 2.7 on Windows
2020-05-10 12:56:32 +05:30
Ashwin Maroli
80683dde4e Forward-port release history from stable branches 2020-05-10 12:11:49 +05:30
Frank Taillandier
e70e993721 chore: set verion to 4.0.1 2020-05-10 00:41:55 +02:00
jekyllbot
b25d4374ee Update history to reflect merge of #8168 [ci skip] 2020-05-09 18:25:35 -04:00
Frank Taillandier
5375a2747e chore(ci): cache dependencies (#8168)
Merge pull request 8168
2020-05-09 18:25:33 -04:00
Frank Taillandier
8c77d2ece6 Release: v4.0.1 post (#8166)
* docs: 4.0.1 release post
* chore: bump latest version
2020-05-10 00:15:16 +02:00
jekyllbot
0fbdefb7bb Update history to reflect merge of #8075 [ci skip] 2020-05-09 07:29:16 -04:00
Ashwin Maroli
48e6cb18d7 Improve path normalization in liquid_renderer (#8075)
Merge pull request 8075
2020-05-09 07:29:13 -04:00
Frank Taillandier
d51cd070ed chore: use native lazy loading and fixed img 2020-05-09 13:07:02 +02:00
Frank Taillandier
667df335da docs: add french government websites
props @MattiSG
2020-05-09 13:05:19 +02:00
jekyllbot
a5112f3964 Update history to reflect merge of #8162 [ci skip] 2020-05-07 01:47:01 -04:00
Max Chadwick
88c0617588 Fix typo (#8162)
Merge pull request 8162
2020-05-07 01:46:58 -04:00
jekyllbot
190219414a Update history to reflect merge of #8131 [ci skip] 2020-05-06 15:56:58 -04:00
Ashwin Maroli
ed11d2149e Allow disabling import of theme configuration (#8131)
Merge pull request 8131
2020-05-06 15:56:56 -04:00
Frank Taillandier
1f39f7a96e docs: update resources
- ZEIT is now Vercel
- Mention forks like Glim and Bridgetown
- Remove old posts
2020-05-04 19:48:35 +02:00
jekyllbot
1888fc1db6 Update history to reflect merge of #8147 [ci skip] 2020-05-04 05:07:22 -04:00
jeffreytse
4dd1868405 docs: update your-first-plugin.md (#8147)
Merge pull request 8147
2020-05-04 05:07:20 -04:00
jekyllbot
42c0f5b89b Update history to reflect merge of #8042 [ci skip] 2020-04-30 16:50:39 -04:00
Ashwin Maroli
e11cd56a27 Remove dev dependencies from new theme-gem gemspec (#8042)
Merge pull request 8042
2020-04-30 16:50:36 -04:00
jekyllbot
68fda59b07 Update history to reflect merge of #8035 [ci skip] 2020-04-30 13:52:57 -04:00
Ashwin Maroli
c0e5541468 Configure default language for syntax-highlighting (#8035)
Merge pull request 8035
2020-04-30 13:52:55 -04:00
jekyllbot
8de0762923 Update history to reflect merge of #7950 [ci skip] 2020-04-30 13:52:14 -04:00
Ashwin Maroli
f69471cb4a Allow extensionless document in a strict site (#7950)
Merge pull request 7950
2020-04-30 13:52:11 -04:00
jekyllbot
f451129e5a Update history to reflect merge of #8150 [ci skip] 2020-04-30 09:06:27 -04:00
Mike Kasberg
d0f5f0f199 Clarify bundle config in Bundler tutorial (#8150)
Merge pull request 8150
2020-04-30 09:06:24 -04:00
jekyllbot
18f04c61ad Update history to reflect merge of #8113 [ci skip] 2020-04-27 10:06:08 -04:00
Billy Kong
70870328bf Config include trailing slash (#8113)
Merge pull request 8113
2020-04-27 10:06:05 -04:00
jekyllbot
82f1b32896 Update history to reflect merge of #8140 [ci skip] 2020-04-27 08:20:55 -04:00
Daniel Leidert
acf92593f7 Use platforms instead of install_if (#8140)
Merge pull request 8140
2020-04-27 08:20:52 -04:00
jekyllbot
59f1b9a131 Update history to reflect merge of #8138 [ci skip] 2020-04-27 05:21:10 -04:00
Daniel Leidert
47e3644cd5 Escape regex characters in paths to match (#8138)
Merge pull request 8138
2020-04-27 05:21:07 -04:00
jekyllbot
c8c3891cab Update history to reflect merge of #8119 [ci skip] 2020-04-27 03:30:02 -04:00
michaelcurrin
a36bea22e3 Docs: Deploy Jekyll site with GitHub Actions (#8119)
Merge pull request 8119
2020-04-27 03:29:59 -04:00
Frank Taillandier
2bc1e04620 chore(ci): Ruby 2.4 EOL
Stop test against Ruby 2.4
2020-04-26 06:42:28 +02:00
jekyllbot
9916526835 Update history to reflect merge of #8136 [ci skip] 2020-04-25 14:48:02 -04:00
Leo
3acc74c611 docs: Fix broken URL in the "Resources" page (#8136)
Merge pull request 8136
2020-04-25 14:47:59 -04:00
jekyllbot
a489a6b3e5 Update history to reflect merge of #8135 [ci skip] 2020-04-25 03:58:36 -04:00
Aaron K Redshaw
9e9c713f65 Added note about OS specific installation instructions. (#8135)
Merge pull request 8135
2020-04-25 03:58:34 -04:00
jekyllbot
6a5f52b3ef Update history to reflect merge of #8132 [ci skip] 2020-04-24 03:57:36 -04:00
Paramdeo Singh
470b925cdd Added Clear Linux (#8132)
Merge pull request 8132
2020-04-24 03:57:34 -04:00
Ashwin Maroli
79be8abb8f Update expected markup rendered by kramdown
kramdown-2.2.0 adds WAI-ARIA role attributes to rendered TOC and footnotes
ref: c8f0985476
2020-04-23 15:14:33 +05:30
Frank Taillandier
964b80edc6 docs: override default excluded filenames
fix #8009
2020-04-18 22:27:23 +02:00
Frank Taillandier
a2103c3452 Update FUNDING.yml 2020-04-17 10:40:03 +02:00
Ashwin Maroli
00013c3303 Bump RuboCop to v0.82.x 2020-04-16 19:40:10 +05:30
jekyllbot
38157eb9b3 Update history to reflect merge of #8079 [ci skip] 2020-04-15 09:12:09 -04:00
Ashwin Maroli
c8ce49fdfd Improve syntax-highlighting in documentation site (#8079)
Merge pull request 8079
2020-04-15 09:12:06 -04:00
jekyllbot
2ed78413ef Update history to reflect merge of #8122 [ci skip] 2020-04-14 20:12:24 -04:00
jonas-krummenacher
d935b6f7f9 KeyCDN added to third party site (#8122)
Merge pull request 8122
2020-04-14 20:12:22 -04:00
jekyllbot
561531eca6 Update history to reflect merge of #8002 [ci skip] 2020-04-13 11:34:25 -04:00
wzy
e5804f33c2 Add help about Gentoo/Linux (#8002)
Merge pull request 8002
2020-04-13 11:34:22 -04:00
Ashwin Maroli
d0b79bb3bb Use Ruby's English module in gemspec
* Can use `git ls-files` directly without the `-z` option.
* Can consequently use a readable variable `$INPUT_RECORD_SEPARATOR` instead
  of cryptic string `"\x0"` to generate array of paths.


Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2020-04-13 19:56:59 +05:30
Ashwin Maroli
3b32fa27d1 Revert to using "\x0" as INPUT_RECORD_SEPARATOR
This reverts commit 4536edb1b0
because the gem built doesn't include all the expected files.
2020-04-13 19:26:59 +05:30
Frank Taillandier
4536edb1b0 style: Style/SpecialGlobalVars
see: https://rubystyle.guide/#no-cryptic-perlisms
2020-04-13 15:21:20 +02:00
Ashwin Maroli
4e25c36d86 Revert "Pass require path to sub-process when running bundle install" (#8117)
* Revert "Pass require path to sub-process when running `bundle install` (#7618)"

This reverts commit 43b9f13b1a.

* Revert "Update history to reflect merge of #7618 [ci skip]"

This reverts commit 2c605bfeb3.
2020-04-13 12:41:38 +02:00
Frank Taillandier
657d924119 docs: update Ruby versions 2020-04-13 11:06:30 +02:00
jekyllbot
47ed1762d7 Update history to reflect merge of #7990 [ci skip] 2020-04-13 03:52:56 -04:00
Ashwin Maroli
9c0c518d52 Cache URLFilter results of string inputs per site (#7990)
Merge pull request 7990
2020-04-13 03:52:54 -04:00
jekyllbot
b1462571cb Update history to reflect merge of #8094 [ci skip] 2020-04-13 03:51:36 -04:00
Ashwin Maroli
30e7d5ea53 Add slugified_categories URL placeholder (#8094)
Merge pull request 8094
2020-04-13 03:51:33 -04:00
jekyllbot
6db506651a Update history to reflect merge of #7967 [ci skip] 2020-04-13 03:49:18 -04:00
Ashwin Maroli
67380a2738 Clear cached Liquid template scope before render (#7967)
Merge pull request 7967
2020-04-13 03:49:15 -04:00
jekyllbot
1cf04b8857 Update history to reflect merge of #7908 [ci skip] 2020-04-13 03:45:36 -04:00
Ashwin Maroli
be70c3e869 Add static file's basename to its url_placeholder (#7908)
Merge pull request 7908
2020-04-13 03:45:33 -04:00
jekyllbot
2c605bfeb3 Update history to reflect merge of #7618 [ci skip] 2020-04-12 21:34:30 -04:00
Justin Jia
43b9f13b1a Pass require path to sub-process when running bundle install (#7618)
Merge pull request 7618
2020-04-12 21:34:27 -04:00
jekyllbot
f82458bb15 Update history to reflect merge of #7570 [ci skip] 2020-04-12 21:12:50 -04:00
Ashwin Maroli
e42c35c9ac Reduce Jekyll::Renderer instances during a build (#7570)
Merge pull request 7570
2020-04-12 21:12:48 -04:00
Frank Taillandier
ffdab933b8 docs: Netlify and ZEIT Now guides
- Deploy Jekyll 4.0 on Netlify
- Deploy Jekyll on ZEIT Now example
2020-04-10 16:09:13 +02:00
jekyllbot
90f6d171d4 Update history to reflect merge of #8106 [ci skip] 2020-04-09 11:54:14 -04:00
Atlas Cove
7ac4c32181 Update variables.md (#8106)
Merge pull request 8106
2020-04-09 11:54:12 -04:00
jekyllbot
5c24527457 Update history to reflect merge of #8097 [ci skip] 2020-04-05 10:52:51 -04:00
guanicoe
8c3934fd02 Update front-matter.md (#8097)
Merge pull request 8097
2020-04-05 10:52:49 -04:00
jekyllbot
fa9c6d62a2 Update history to reflect merge of #8098 [ci skip] 2020-04-05 10:50:49 -04:00
HTeuMeuLeu
792ecfa310 Add version badge for Custom Sorting of Documents (#8098)
Merge pull request 8098
2020-04-05 10:50:46 -04:00
Ashwin Maroli
3c41a1eb1d Make corrections to tabulating CSV-data tutorial
* Replace highlight tags with triple backticks
* Replace hard tab characters with 2 spaces
* Fix typos
* Change tutorial title
2020-04-05 11:57:32 +05:30
Frank Taillandier
842a809cab fix: padding on liquid code blocks
props @MichaelCurrin
2020-04-04 16:35:45 +02:00
jekyllbot
d4ee27ed70 Update history to reflect merge of #8090 [ci skip] 2020-04-04 10:33:11 -04:00
michaelcurrin
047da6396a Create CSV to table tutorial (#8090)
Merge pull request 8090
2020-04-04 10:33:09 -04:00
jekyllbot
9b29a86bbd Update history to reflect merge of #8088 [ci skip] 2020-04-03 09:47:30 -04:00
Ashwin Maroli
a2c2957f55 Bump Ruby versions on Travis builds (#8088)
Merge pull request 8088
2020-04-03 09:47:27 -04:00
jekyllbot
8b17c0e3b3 Update history to reflect merge of #8092 [ci skip] 2020-04-02 18:22:54 -04:00
Ashwin Maroli
0cd3bb8d19 Render tutorial metadata in documentation site (#8092)
Merge pull request 8092
2020-04-02 18:22:52 -04:00
jekyllbot
2ef3281bad Update history to reflect merge of #8064 [ci skip] 2020-04-01 12:19:40 -04:00
Ashwin Maroli
784a689b13 Simplify Jekyll::Renderer#validate_layout (#8064)
Merge pull request 8064
2020-04-01 12:19:37 -04:00
jekyllbot
46cffe89b8 Update history to reflect merge of #8089 [ci skip] 2020-04-01 08:41:32 -04:00
Ashwin Maroli
bc9774561b Utilize relative_url filter in documentation site (#8089)
Merge pull request 8089
2020-04-01 08:41:30 -04:00
Ashwin Maroli
1412928dde Bump RuboCop to v0.81.x 2020-04-01 14:21:24 +05:30
jekyllbot
9614cb67d4 Update history to reflect merge of #8083 [ci skip] 2020-03-30 10:44:07 -04:00
Ashwin Maroli
f0ab09968e Reduce array allocations from StaticFile#path (#8083)
Merge pull request 8083
2020-03-30 10:44:04 -04:00
jekyllbot
539e712c41 Update history to reflect merge of #7987 [ci skip] 2020-03-30 10:36:40 -04:00
Ashwin Maroli
6bc27f9fdf Quicker categories for documents without superdirs (#7987)
Merge pull request 7987
2020-03-30 10:36:37 -04:00
jekyllbot
f7bff1c5c4 Update history to reflect merge of #8081 [ci skip] 2020-03-29 16:11:19 -04:00
Ashwin Maroli
09c448449e Add default front matter for tutorials collection (#8081)
Merge pull request 8081
2020-03-29 16:11:17 -04:00
jekyllbot
8d3c2f6a96 Update history to reflect merge of #8067 [ci skip] 2020-03-29 12:40:30 -04:00
Ashwin Maroli
e972065325 Reduce Pathname objects from front matter defaults (#8067)
Merge pull request 8067
2020-03-29 12:40:28 -04:00
jekyllbot
7860d1bac0 Update history to reflect merge of #8041 [ci skip] 2020-03-26 10:11:35 -04:00
Ashwin Maroli
237d08a76c Optimize Kramdown::JekyllDocument#to_html calls (#8041)
Merge pull request 8041
2020-03-26 10:11:33 -04:00
jekyllbot
ef6b382a48 Update history to reflect merge of #7992 [ci skip] 2020-03-26 09:39:49 -04:00
Ashwin Maroli
b84ba5accc Add PageDrop to provide Liquid templates with data (#7992)
Merge pull request 7992
2020-03-26 09:39:47 -04:00
jekyllbot
a011579fe4 Update history to reflect merge of #8069 [ci skip] 2020-03-22 12:04:36 -04:00
Ashwin Maroli
a1401c6fe9 Use layout.path when rendering the Liquid layout (#8069)
Merge pull request 8069
2020-03-22 12:04:33 -04:00
jekyllbot
83decb42f6 Update history to reflect merge of #8063 [ci skip] 2020-03-20 06:40:19 -04:00
Kieran Barker
1fe5bd0cf5 Remove extra paragraph tags (#8063)
Merge pull request 8063
2020-03-20 06:40:17 -04:00
jekyllbot
0683ab143e Update history to reflect merge of #8060 [ci skip] 2020-03-19 06:10:27 -04:00
Tobias Klüpfel
dc5e1d7056 Update 09-collections.md (#8060)
Merge pull request 8060
2020-03-19 06:10:25 -04:00
jekyllbot
c193677dc5 Update history to reflect merge of #8056 [ci skip] 2020-03-16 04:24:46 -04:00
Ashwin Maroli
7948578cd3 Mirror spec.homepage as metadata["homepage_uri"] (#8056)
Merge pull request 8056
2020-03-16 04:24:45 -04:00
jekyllbot
e9174dfd3b Update history to reflect merge of #8055 [ci skip] 2020-03-16 03:06:32 -04:00
Ashwin Maroli
ee5d0cffd6 Remove version-constraint relaxation for i18n gem (#8055)
Merge pull request 8055
2020-03-16 03:06:30 -04:00
jekyllbot
190a35dc9a Update history to reflect merge of #8057 [ci skip] 2020-03-15 18:49:57 -04:00
Frank Taillandier
a4b1ca2c75 chore: simplify require for Jekyll::VERSION (#8057)
Merge pull request 8057
2020-03-15 18:49:54 -04:00
jekyllbot
88360bd17d Update history to reflect merge of #8028 [ci skip] 2020-03-12 10:58:20 -04:00
Ashwin Maroli
f826b8b5ea Fix documents custom-ordering logic (#8028)
Merge pull request 8028
2020-03-12 10:58:17 -04:00
Frank Taillandier
1115eebe15 docs: add typeform 2020-03-10 01:24:32 +01:00
Frank Taillandier
325e6bb3f8 docs: add page layout to philosophy 2020-03-10 01:21:06 +01:00
Frank Taillandier
256b0875cb site: make resources editable 2020-03-10 01:20:31 +01:00
jekyllbot
a1c18b6e87 Update history to reflect merge of #8048 [ci skip] 2020-03-07 11:40:26 -05:00
Riccardo Porreca
3e182ef25e Non-deprecated vendor/bundle path configuration (#8048)
Merge pull request 8048
2020-03-07 11:40:24 -05:00
Frank Taillandier
422470dc6e docs: ZEIT and Render 2020-03-07 10:36:49 +01:00
Frank Taillandier
c8d673c984 docs: external links
Third-party services, deployment services
2020-03-07 09:57:14 +01:00
jekyllbot
27ca06326a Update history to reflect merge of #8047 [ci skip] 2020-03-06 11:08:59 -05:00
Ashwin Maroli
0f4c8d2248 Allow multiple binary operator in where_exp filter (#8047)
Merge pull request 8047
2020-03-06 11:08:56 -05:00
jekyllbot
ab6ef0b257 Update history to reflect merge of #8044 [ci skip] 2020-03-04 10:14:55 -05:00
Ashwin Maroli
ea57ef78da Simplify Jekyll::Hooks.trigger logic (#8044)
Merge pull request 8044
2020-03-04 10:14:53 -05:00
Frank Taillandier
6ae640755f chore: remove question template 2020-03-02 16:22:42 +01:00
Frank Taillandier
028c306c11 chore: redirect questions to the forum 2020-03-02 16:21:28 +01:00
jekyllbot
e6d082488c Update history to reflect merge of #8037 [ci skip] 2020-02-28 14:29:49 -05:00
Eric Knibbe
b05e6ee8ae docs: improvements for note boxes (#8037)
Merge pull request 8037
2020-02-28 14:29:47 -05:00
jekyllbot
53bb8bd7d3 Update history to reflect merge of #8032 [ci skip] 2020-02-27 08:14:17 -05:00
Ashwin Maroli
7ba99f0010 Docs: Render full contents of just the latest post (#8032)
Merge pull request 8032
2020-02-27 08:14:15 -05:00
jekyllbot
70fc6b377d Update history to reflect merge of #8030 [ci skip] 2020-02-27 00:22:06 -05:00
Matt Penna
0378c3628c Corrected command to modify PATH (#8030)
Merge pull request 8030
2020-02-27 00:22:03 -05:00
jekyllbot
4a6f91810c Update history to reflect merge of #8029 [ci skip] 2020-02-26 19:46:28 -05:00
Matt Penna
a9fb26fc33 Corrected command to modify PATH (#8029)
Merge pull request 8029
2020-02-26 19:46:25 -05:00
jekyllbot
aef8f11f6c Update history to reflect merge of #8013 [ci skip] 2020-02-26 11:36:22 -05:00
Ashwin Maroli
3d045d277e Optimize markdown parsing with Kramdown by reusing the options and parser objects (#8013)
Merge pull request 8013
2020-02-26 11:36:19 -05:00
jekyllbot
b1573b6292 Update history to reflect merge of #8026 [ci skip] 2020-02-26 01:28:38 -05:00
Dmitry Egorov
39e2a8b5f5 [Docs] Fix asset link ref in step-by-step tutorial (#8026)
Merge pull request 8026
2020-02-26 01:28:36 -05:00
jekyllbot
4d131eb069 Update history to reflect merge of #8020 [ci skip] 2020-02-24 18:44:13 -05:00
Ashwin Maroli
68066ce268 Optimize rendering of the documentation site (#8020)
Merge pull request 8020
2020-02-24 18:44:11 -05:00
jekyllbot
002ed48fd8 Update history to reflect merge of #8021 [ci skip] 2020-02-24 05:43:28 -05:00
Gareth Mcshane
331d3f3ffe remove leading slash from Sass file location (#8021)
Merge pull request 8021
2020-02-24 05:43:25 -05:00
jekyllbot
3e440a9cc1 Update history to reflect merge of #8017 [ci skip] 2020-02-21 06:08:50 -05:00
Eric Knibbe
8c3276133d docs: improve highlighting of code blocks (#8017)
Merge pull request 8017
2020-02-21 06:08:48 -05:00
jekyllbot
1a0a4b709a Update history to reflect merge of #8015 [ci skip] 2020-02-20 12:54:52 -05:00
Ashwin Maroli
707741c0f8 Configure kramdown toc_levels as array by default (#8015)
Merge pull request 8015
2020-02-20 12:54:49 -05:00
jekyllbot
3fb94fbca0 Update history to reflect merge of #7928 [ci skip] 2020-02-20 12:47:35 -05:00
Ashwin Maroli
558e05eb73 Add an option to easily disable disk-cache (#7928)
Merge pull request 7928
2020-02-20 12:47:32 -05:00
jekyllbot
ba3e3002c4 Update history to reflect merge of #8016 [ci skip] 2020-02-20 12:46:18 -05:00
Mark Bennett
9739246a89 Add Visual Studio Code Development Container (#8016)
Merge pull request 8016
2020-02-20 12:46:16 -05:00
jekyllbot
4a1f00e940 Update history to reflect merge of #8014 [ci skip] 2020-02-19 11:28:56 -05:00
Ashwin Maroli
d65a09b1d9 Update unit tests for Kramdown-based converter (#8014)
Merge pull request 8014
2020-02-19 11:28:54 -05:00
Ashwin Maroli
0cb0b8ad8c Bump JRuby version used in Travis CI build 2020-02-19 16:30:23 +05:30
jekyllbot
fc694fb496 Update history to reflect merge of #8012 [ci skip] 2020-02-19 01:48:29 -05:00
Frank Taillandier
6adb601232 chore(deps): rubocop 0.80.0 (#8012)
Merge pull request 8012
2020-02-19 01:48:26 -05:00
jekyllbot
99f91b551c Update history to reflect merge of #8007 [ci skip] 2020-02-17 02:49:10 -05:00
vhermecz
b5d8a5f409 Fix file references in Step by Step Tutorial's Assets step (#8007)
Merge pull request 8007
2020-02-17 02:49:08 -05:00
Frank Taillandier
d4e2d19d7e docs: VS Code plugins and config autocompletion
fix #7884
2020-02-14 14:08:21 +01:00
jekyllbot
5ee36686a9 Update history to reflect merge of #7413 [ci skip] 2020-02-13 13:40:03 -05:00
dkalev
6064ce8eba Update 07-assets.md (#7413)
Merge pull request 7413
2020-02-13 13:39:59 -05:00
jekyllbot
542d9ce79a Update history to reflect merge of #8000 [ci skip] 2020-02-12 08:48:59 -05:00
Radoslav Karlík
d7c110d568 Add Kentico Kontent CMS integration to resources (#8000)
Merge pull request 8000
2020-02-12 08:48:56 -05:00
jekyllbot
529f0f7030 Update history to reflect merge of #7696 [ci skip] 2020-02-06 11:11:54 -05:00
Ashwin Maroli
8bb76c865f Optimize Jekyll::Filters#item_property (#7696)
Merge pull request 7696
2020-02-06 11:11:50 -05:00
jekyllbot
44062561f0 Update history to reflect merge of #7865 [ci skip] 2020-02-06 10:13:49 -05:00
Liam Bigelow
6097d3b068 Include _config.yml in a new theme's gemspec (#7865)
Merge pull request 7865
2020-02-06 10:13:46 -05:00
jekyllbot
ac49cea881 Update history to reflect merge of #7996 [ci skip] 2020-02-06 03:28:13 -05:00
dgolant
a58d71a311 Update 03-front-matter.md (#7996)
Merge pull request 7996
2020-02-06 03:28:10 -05:00
jekyllbot
68e4e901c2 Update history to reflect merge of #7994 [ci skip] 2020-02-05 07:10:59 -05:00
lizharris
35077ff0a7 Fix English grammar error. (#7994)
Merge pull request 7994
2020-02-05 07:10:56 -05:00
jekyllbot
2c04ddcabd Update history to reflect merge of #7821 [ci skip] 2020-02-04 00:24:42 -05:00
Ashwin Maroli
5cc78db648 Test where filter handling numeric property values (#7821)
Merge pull request 7821
2020-02-04 00:24:40 -05:00
jekyllbot
4eb7a408e4 Update history to reflect merge of #7870 [ci skip] 2020-02-03 12:08:10 -05:00
Ben Stolovitz
7cac1f9096 Document sorting two documents by their date (#7870)
Merge pull request 7870
2020-02-03 12:08:07 -05:00
jekyllbot
b98a919351 Update history to reflect merge of #7989 [ci skip] 2020-02-01 23:31:16 -05:00
R.P. Pedraza
0aa29046a7 Correct documentation of filters (#7989)
Merge pull request 7989
2020-02-01 23:31:14 -05:00
jekyllbot
05cbe06c26 Update history to reflect merge of #7948 [ci skip] 2020-01-31 13:07:12 -05:00
Ashwin Maroli
389eb88c20 Attain Ruby 3.0 compatibility (#7948)
Merge pull request 7948
2020-01-31 13:07:08 -05:00
jekyllbot
5be7faac3e Update history to reflect merge of #7988 [ci skip] 2020-01-31 12:29:17 -05:00
Ashwin Maroli
5da8271e9b Return relative_url if site.url is an empty string (#7988)
Merge pull request 7988
2020-01-31 12:29:14 -05:00
jekyllbot
f3b4cad057 Update history to reflect merge of #7985 [ci skip] 2020-01-29 17:01:58 -05:00
Aaron Adams
b8c4e2aaf7 Move --baseurl to build command options (#7985)
Merge pull request 7985
2020-01-29 17:01:56 -05:00
jekyllbot
48ee086361 Update history to reflect merge of #7979 [ci skip] 2020-01-20 03:38:19 -05:00
Lizzy Kate
fc062db1e9 Fix YAML representation of group_by result (#7979)
Merge pull request 7979
2020-01-20 03:38:17 -05:00
Frank Taillandier
ccb6ee9db5 chore(deps): mercenary 0.4.0 2020-01-19 01:01:18 +01:00
jekyllbot
b2639ceb59 Update history to reflect merge of #7978 [ci skip] 2020-01-17 11:06:02 -05:00
csquare
c34d185d8d Correct a sentence in the documentation (#7978)
Merge pull request 7978
2020-01-17 11:05:59 -05:00
Frank Taillandier
333090d36e chore(ci): update to actions/checkoutv2
Improved performance: fetches only a single commit by default.

https://github.com/actions/checkout#whats-new
2020-01-16 20:30:05 +01:00
jekyllbot
32a5bcda3d Update history to reflect merge of #7940 [ci skip] 2020-01-15 10:02:40 -05:00
Patrik Eriksson
b9af7d3564 docs: remove watch option in config (#7940)
Merge pull request 7940
2020-01-15 10:02:37 -05:00
jekyllbot
9bc17cf40c Update history to reflect merge of #7975 [ci skip] 2020-01-15 09:14:22 -05:00
ddocs
f9a8bdba50 Corre (#7975)
Merge pull request 7975
2020-01-15 09:14:20 -05:00
jekyllbot
6cf0d7df39 Update history to reflect merge of #7974 [ci skip] 2020-01-15 08:48:17 -05:00
Ashwin Maroli
e826ae6e2b Remove post-install message from gemspec (#7974)
Merge pull request 7974
2020-01-15 08:48:15 -05:00
jekyllbot
5fa7fcc060 Update history to reflect merge of #7970 [ci skip] 2020-01-15 01:06:34 -05:00
Artyom Tokachev
34d0dd6c7d Bump RuboCop to v0.79.x (#7970)
Merge pull request 7970
2020-01-15 01:06:31 -05:00
jekyllbot
654d381039 Update history to reflect merge of #7955 [ci skip] 2019-12-31 12:15:07 -05:00
JC
4c0ba3a6bd docs: fix broken link (#7955)
Merge pull request 7955
2019-12-31 12:15:04 -05:00
jekyllbot
b0cca4c1b4 Update history to reflect merge of #7954 [ci skip] 2019-12-30 03:36:18 -05:00
Phil Nash
af65fa45e3 Adds some documentation for the :clean, :on_obsolete hook (#7954)
Merge pull request 7954
2019-12-30 03:36:16 -05:00
Frank Taillandier
af0f6aad34 Update FUNDING.yml 2019-12-25 23:16:50 +01:00
jekyllbot
ba47628fca Update history to reflect merge of #7779 [ci skip] 2019-12-25 12:37:01 -05:00
Ashwin Maroli
41c0cce5ea Test with JRuby 9.2.9.0 (#7779)
Merge pull request 7779
2019-12-25 12:36:59 -05:00
Frank Taillandier
67f387dfcf ci: test with stable Ruby releases
2.7.0 is out🎄
2019-12-25 14:23:03 +01:00
jekyllbot
f5ce5eb23f Update history to reflect merge of #7941 [ci skip] 2019-12-22 04:31:05 -05:00
Johan Wigert
c814089708 Changed deprecated command in themes documentation (#7941)
Merge pull request 7941
2019-12-22 04:31:03 -05:00
jekyllbot
83238b449a Update history to reflect merge of #7937 [ci skip] 2019-12-17 19:48:52 -05:00
Luis Puente
998470d00f Update 09-collections.md (#7937)
Merge pull request 7937
2019-12-17 19:48:49 -05:00
jekyllbot
fc6c2eca8b Update history to reflect merge of #7878 [ci skip] 2019-12-10 10:11:25 -05:00
Ivan Gromov
eb81dc0e96 Update item_property to recognize integers (#7878)
Merge pull request 7878
2019-12-10 10:11:22 -05:00
Frank Taillandier
7ad84ef3c5 docs: explain PATH for new command 2019-12-10 13:55:45 +01:00
jekyllbot
96e2ea1ad0 Update history to reflect merge of #7931 [ci skip] 2019-12-10 05:20:11 -05:00
Muhammed Salih
c3dc576e3c Include path in jekyll new commands (Usage docs) (#7931)
Merge pull request 7931
2019-12-10 05:20:08 -05:00
Frank Taillandier
866ff6a07d docs: typo 2019-12-05 16:04:12 +01:00
Frank Taillandier
c8b6b806e2 Merge pull request #7927 from AninditaBasu/patch-2
Update generators.md
2019-12-05 16:03:34 +01:00
Frank Taillandier
b1e2266878 Update index.md 2019-12-05 12:19:54 +01:00
jekyllbot
a54d5526c5 Update history to reflect merge of #7926 [ci skip] 2019-12-05 04:39:31 -05:00
Anindita Basu
98522b03ca Improve index page of Jekyll documentation (#7926)
Merge pull request 7926
2019-12-05 04:39:29 -05:00
Anindita Basu
18479e7f5a Update generators.md
Based on the info given in Issue 7897
2019-12-05 13:21:15 +05:30
jekyllbot
9557e68551 Update history to reflect merge of #7920 [ci skip] 2019-12-03 08:22:40 -05:00
Alexandre ZANNI
957c9cee9b add install instructions for ArchLinux and openSUSE (#7920)
Merge pull request 7920
2019-12-03 08:22:38 -05:00
jekyllbot
9867669cb6 Update history to reflect merge of #7918 [ci skip] 2019-12-03 03:31:28 -05:00
Patrik Eriksson
89dc5c2857 docs: add options for watch and force polling (#7918)
Merge pull request 7918
2019-12-03 03:31:26 -05:00
jekyllbot
9292b719bd Update history to reflect merge of #7919 [ci skip] 2019-12-02 07:55:20 -05:00
Patrik Eriksson
442d4dfb2e docs: add short serve command for livereload (#7919)
Merge pull request 7919
2019-12-02 07:55:18 -05:00
Frank Taillandier
c8cb0ea8e0 docs: macOS 10.15 comes with Ruby 2.6.3 2019-12-01 23:04:35 +01:00
jekyllbot
12b7d83664 Update history to reflect merge of #7909 [ci skip] 2019-11-30 10:50:38 -05:00
Zlatan Vasović
cc0b6fa0da Use bash executable consistently (#7909)
Merge pull request 7909
2019-11-30 10:50:36 -05:00
jekyllbot
1d7d11be61 Update history to reflect merge of #7893 [ci skip] 2019-11-27 13:48:29 -05:00
Gabriel Rubens
0bd9f0515d Update rubocop (#7893)
Merge pull request 7893
2019-11-27 13:48:26 -05:00
jekyllbot
d6d770f6b5 Update history to reflect merge of #7910 [ci skip] 2019-11-26 13:55:55 -05:00
Jason Taylor
6aa8aafa3a Upgrade rake to use version 13. Solves #7900 (#7910)
Merge pull request 7910
2019-11-26 13:55:52 -05:00
jekyllbot
c964be7628 Update history to reflect merge of #7906 [ci skip] 2019-11-20 10:31:51 -05:00
J·Y
42bf5675e9 Disambiguate the placeholder of permalink (#7906)
Merge pull request 7906
2019-11-20 10:31:49 -05:00
Frank Taillandier
88a2835afe Merge pull request #7905 from hteumeuleu/patch-1
Update link to the "Liquid templating system"
2019-11-19 22:04:10 +01:00
HTeuMeuLeu
acc2636894 Update link to the "Liquid templating system" 2019-11-19 22:01:30 +01:00
Frank Taillandier
14299310a4 Merge pull request #7899 from iBug/patch-1
Add back a missing colon to /resources/ page
2019-11-12 08:49:56 +01:00
jekyllbot
04527c5b8e Update history to reflect merge of #7896 [ci skip] 2019-11-12 02:47:29 -05:00
Damien St Pierre
e1b3d07b7e Docs: Clarify organizing pages into subfolders (#7896)
Merge pull request 7896
2019-11-12 02:47:27 -05:00
iBug ♦
c5b3ffd3e0 Add back a missing colon 2019-11-12 12:41:37 +08:00
jekyllbot
6cee92229c Update history to reflect merge of #7885 [ci skip] 2019-11-08 11:05:11 -05:00
Ashwin Maroli
b1ee88397b Split action steps to avoid using && on Windows (#7885)
Merge pull request 7885
2019-11-08 11:05:08 -05:00
jekyllbot
848759ca02 Update history to reflect merge of #7887 [ci skip] 2019-11-02 07:35:14 -04:00
Arthur Zey
2fb2268b57 fixed grammatical error (it's --> its) (#7887)
Merge pull request 7887
2019-11-02 07:35:12 -04:00
jekyllbot
51a07aea53 Update history to reflect merge of #7883 [ci skip] 2019-10-30 12:01:29 -04:00
Grzegorz Kaczorek
42c48b4f34 Better documentation for Jekyll::Converters::Identity (#7883)
Merge pull request 7883
2019-10-30 12:01:27 -04:00
jekyllbot
6a57842395 Update history to reflect merge of #7875 [ci skip] 2019-10-30 11:06:22 -04:00
sharath Kumar
744bbb0e07 add new theme source (#7875)
Merge pull request 7875
2019-10-30 11:06:19 -04:00
jekyllbot
b0e15a5f16 Update history to reflect merge of #7879 [ci skip] 2019-10-29 06:26:46 -04:00
J·Y
aee034f332 Replace `` with html tag (#7879)
Merge pull request 7879
2019-10-29 06:26:43 -04:00
jekyllbot
2e3154e288 Update history to reflect merge of #7873 [ci skip] 2019-10-22 09:19:44 -04:00
Itay Shakury
3174d19ee5 clarify _config.yml/collections type (#7873)
Merge pull request 7873
2019-10-22 09:19:42 -04:00
Frank Taillandier
f8b2748c09 site: remove non jekyll sites 2019-10-22 02:07:09 +02:00
jekyllbot
dd7d03eccd Update history to reflect merge of #7846 [ci skip] 2019-10-16 03:21:06 -04:00
James Buckley
22a974200d Rubocop version upgrade (#7846)
Merge pull request 7846
2019-10-16 03:21:04 -04:00
jekyllbot
4d0457bab2 Update history to reflect merge of #7857 [ci skip] 2019-10-11 07:40:40 -04:00
Simone Arpe
d9de94bfb5 Update third-party.md (#7857)
Merge pull request 7857
2019-10-11 07:40:38 -04:00
jekyllbot
3437135837 Update history to reflect merge of #7856 [ci skip] 2019-10-11 04:38:28 -04:00
David Zhang
30fcdcfa04 Doc: minor fix, should be greater or equal to min version [ci skip] (#7856)
Merge pull request 7856
2019-10-11 04:38:26 -04:00
jekyllbot
d9c6e2062a Update history to reflect merge of #7825 [ci skip] 2019-10-09 05:25:05 -04:00
Ward Sandler
f8d5772f29 link for memberships (#7825)
Merge pull request 7825
2019-10-09 05:25:03 -04:00
Frank Taillandier
83285056b3 Merge pull request #7848 from coliff/patch-3
Update html5shiv.min.js
2019-10-07 11:14:08 +02:00
Frank Taillandier
ede7c0188f Merge pull request #7847 from coliff/patch-2
Remove Generator meta tag
2019-10-07 11:07:37 +02:00
Christian Oliff
a92b564aaf Update html5shiv.min.js
From: https://github.com/aFarkas/html5shiv/blob/master/dist/html5shiv.min.js
2019-10-07 11:20:12 +09:00
Christian Oliff
6fbf908bcb Remove Generator meta tag (as this is already included in the SEO plugin) 2019-10-07 11:16:36 +09:00
Takashi Udagawa
3eab32fad7 Fix RuboCop Performance offenses in test files (#7839)
* Replace select.first with find
* Replace select.count with count
2019-10-06 12:00:25 +05:30
Frank Taillandier
de6548f1ba docs: link to themes galleries 2019-10-03 14:08:53 +02:00
Frank Taillandier
036dbe6349 Docs: add jamstackthemes.dev 2019-10-03 14:05:04 +02:00
Ashwin Maroli
6afaa369e1 [GH Actions]: Fetch repo 5 commits deep 2019-09-26 23:17:14 +05:30
jekyllbot
f0542b97f0 Update history to reflect merge of #7822 [ci skip] 2019-09-26 13:33:01 -04:00
Edward Thomson
275702edd5 Ci/GitHub actions (#7822)
Merge pull request 7822
2019-09-26 13:32:59 -04:00
Ashwin Maroli
f00a642901 Improve aesthetics of JekyllConf titles [skip ci] 2019-09-25 14:40:58 +05:30
jekyllbot
388a37208e Update history to reflect merge of #7826 [ci skip] 2019-09-25 02:01:42 -04:00
Mike Neumegen
dc6df7c73a Update JekyllConf page with 2019 talks (#7826)
Merge pull request 7826
2019-09-25 02:01:40 -04:00
jekyllbot
2e11e13455 Update history to reflect merge of #7823 [ci skip] 2019-09-23 06:05:33 -04:00
İsmail Arılık
98498e2e99 Update old GitHub wiki URL with new one (#7823)
Merge pull request 7823
2019-09-23 06:05:31 -04:00
Ashwin Maroli
7e291349d3 Gitignore all folder names with -cache [skip ci] 2019-09-15 12:43:35 +05:30
jekyllbot
d8de658089 Update history to reflect merge of #7815 [ci skip] 2019-09-11 22:45:27 -04:00
Kayce Basques
dd409b7ebc Rephrase the CircleCI v2 section (#7815)
Merge pull request 7815
2019-09-11 22:45:26 -04:00
jekyllbot
9f389e0ada Update history to reflect merge of #7812 [ci skip] 2019-09-05 10:03:51 -04:00
Ashwin Maroli
b54544c68b Clarify docs for static files in collection (#7812)
Merge pull request 7812
2019-09-05 10:03:49 -04:00
jekyllbot
b8e673b149 Update history to reflect merge of #7805 [ci skip] 2019-08-29 13:54:10 -04:00
Ivan Raszl
b3b2ec21a6 Add dropped title: Staff to the code (#7805)
Merge pull request 7805
2019-08-29 13:54:07 -04:00
jekyllbot
b66dabac9d Update history to reflect merge of #7768 [ci skip] 2019-08-22 14:03:26 -04:00
Viktor Szakats
650dcc637a serve: add support for ECC certificates (#7768)
Merge pull request 7768
2019-08-22 14:03:23 -04:00
jekyllbot
c55eaf7724 Update history to reflect merge of #7793 [ci skip] 2019-08-22 09:51:35 -04:00
Nikhil Benesch
55fba8ff31 Memoize absolute_url and relative_url filters (#7793)
Merge pull request 7793
2019-08-22 09:51:33 -04:00
Harry Wood
b9963f38b3 blog typo 'and support' unfinished sentence (#7797) 2019-08-21 14:01:53 +05:30
Frank Taillandier
164b0e2794 Merge pull request #7795 from XhmikosR/patch-1
Update 2019-08-19-jekyll-4-0-0-released.markdown
2019-08-20 22:49:19 +02:00
XhmikosR
6b851f0394 Update 2019-08-19-jekyll-4-0-0-released.markdown
Fix minor typo
2019-08-20 19:08:07 +03:00
jekyllbot
45b2c9e4ed Update history to reflect merge of #7782 [ci skip] 2019-08-20 10:46:10 -04:00
Frank Taillandier
26d80cc771 Jekyll v4.0 release (#7782)
Merge pull request 7782
2019-08-20 10:46:08 -04:00
jekyllbot
5d40711eab Update history to reflect merge of #7788 [ci skip] 2019-08-19 07:27:28 -04:00
Frank Taillandier
b02ba76c8a Test number_like regex on stringified property (#7788)
Merge pull request 7788
2019-08-19 07:27:26 -04:00
jekyllbot
8b44ee73ff Update history to reflect merge of #7794 [ci skip] 2019-08-19 04:39:31 -04:00
Vinicius Flores
2a11df447d Adding SmartForms as Forms service (#7794)
Merge pull request 7794
2019-08-19 04:39:29 -04:00
jekyllbot
dce7d56982 Update history to reflect merge of #7792 [ci skip] 2019-08-19 03:07:04 -04:00
Nikhil Benesch
9ddb4350d3 Actually conditionally include liquid-c (#7792)
Merge pull request 7792
2019-08-19 03:07:02 -04:00
jekyllbot
84e3b92959 Update history to reflect merge of #7786 [ci skip] 2019-08-18 07:16:56 -04:00
Ashwin Maroli
abcb0e29a3 Documentation for binary operators in where_exp (#7786)
Merge pull request 7786
2019-08-18 07:16:54 -04:00
Ashwin Maroli
c842d55cec History: Place Bug Fixes after Minor Enhancements 2019-08-18 12:51:50 +05:30
jekyllbot
917f79a10e Update history to reflect merge of #7783 [ci skip] 2019-08-18 03:01:03 -04:00
Andrea G
59101149e1 Update Ruby version used in Travis-CI example (#7783)
Merge pull request 7783
2019-08-18 03:01:01 -04:00
Frank Taillandier
45f5facbed docs: fix broken link [ci-skip] 2019-08-17 22:54:58 +02:00
Frank Taillandier
759315bfa3 Upgrade documentation for Jekyll v4.0 2019-08-17 14:02:14 +02:00
Frank Taillandier
26914126c7 Cleanup History 2019-08-14 21:18:32 +02:00
Ashwin Maroli
326ab2dfb7 Using jekyll-sass-converter 2.0 is a major change 2019-08-15 00:12:34 +05:30
jekyllbot
fd476206d7 Update history to reflect merge of #7778 [ci skip] 2019-08-14 14:24:57 -04:00
Ashwin Maroli
4e37fb6420 Use jekyll-sass-converter-2.0 by default (#7778)
Merge pull request 7778
2019-08-14 14:24:55 -04:00
jekyllbot
65773e19a8 Update history to reflect merge of #7290 [ci skip] 2019-08-14 13:36:15 -04:00
Ashwin Maroli
de60632309 Remove configuration of theme sass files from Core (#7290)
Merge pull request 7290
2019-08-14 13:36:11 -04:00
Frank Taillandier
0490d71661 Fix 404 2019-08-04 22:25:14 +02:00
jekyllbot
272360a80b Update history to reflect merge of #7701 [ci skip] 2019-08-04 16:11:13 -04:00
Ashwin Maroli
8035a3e153 Use String#end_with? to check if entry is a backup (#7701)
Merge pull request 7701
2019-08-04 16:11:12 -04:00
jekyllbot
2736589ba1 Update history to reflect merge of #7728 [ci skip] 2019-08-04 16:09:29 -04:00
Ashwin Maroli
a0c3a6bced Memoize fallback_data for Drop (#7728)
Merge pull request 7728
2019-08-04 16:09:27 -04:00
jekyllbot
93794d9239 Update history to reflect merge of #7758 [ci skip] 2019-08-04 16:08:55 -04:00
Ashwin Maroli
65f8831168 Reduce allocations by using #each_with_object (#7758)
Merge pull request 7758
2019-08-04 16:08:54 -04:00
jekyllbot
2c7cbddeba Update history to reflect merge of #7543 [ci skip] 2019-08-04 16:06:02 -04:00
Michelle Greer
764201dc8e Added Bonsai Search (#7543)
Merge pull request 7543
2019-08-04 16:06:00 -04:00
jekyllbot
f8c66f02e1 Update history to reflect merge of #7627 [ci skip] 2019-08-04 16:03:58 -04:00
Ashwin Maroli
f446aebf07 Delegate --profile tabulation to terminal-table (#7627)
Merge pull request 7627
2019-08-04 16:03:56 -04:00
Frank Taillandier
91f82907a3 update date 2019-08-04 21:34:17 +02:00
Matt Rogers
8e52cdbb6b Release 💎 4.0.0.pre.beta1 2019-08-04 13:21:33 -05:00
jekyllbot
21202589de Update history to reflect merge of #7716 [ci skip] 2019-08-04 14:20:13 -04:00
Matt Rogers
6511342e15 Prepare Jekyll 4.0.0 beta1 (#7716)
Merge pull request 7716
2019-08-04 14:20:11 -04:00
jekyllbot
0e591f08da Update history to reflect merge of #7440 [ci skip] 2019-08-04 08:37:47 -04:00
Ashwin Maroli
0f5e15811f Remove warnings and fixes for deprecated config (#7440)
Merge pull request 7440
2019-08-04 08:37:45 -04:00
jekyllbot
9a10ff9b5a Update history to reflect merge of #7769 [ci skip] 2019-08-04 02:49:36 -04:00
Frank Taillandier
6a4f8bdbec Fix: rubocop offenses (#7769)
Merge pull request 7769
2019-08-04 02:49:34 -04:00
jekyllbot
a87ca206da Update history to reflect merge of #7752 [ci skip] 2019-08-02 23:32:09 -04:00
Michael Bishop
07270c7cfd docs: improve how to include rouge stylesheets (#7752)
Merge pull request 7752
2019-08-02 23:32:07 -04:00
jekyllbot
532c499751 Update history to reflect merge of #7732 [ci skip] 2019-08-01 16:21:04 -04:00
Ashwin Maroli
b55927e8f7 Add PathManager class to cache interim paths (#7732)
Merge pull request 7732
2019-08-01 16:21:00 -04:00
jekyllbot
4eec5a55c3 Update history to reflect merge of #7764 [ci skip] 2019-07-31 08:49:40 -04:00
Matt Kraai
f3a03a14cd Fix misspelling (#7764)
Merge pull request 7764
2019-07-31 08:49:38 -04:00
jekyllbot
0f4b7be88d Update history to reflect merge of #7761 [ci skip] 2019-07-25 12:35:32 -04:00
Ashwin Maroli
1795996458 Replace redundant Array#map with Array#each (#7761)
Merge pull request 7761
2019-07-25 12:35:30 -04:00
Frank Taillandier
882279c307 Add default Sass dir 2019-07-24 15:15:27 +02:00
jekyllbot
384a874805 Update history to reflect merge of #7756 [ci skip] 2019-07-20 11:36:34 -04:00
Andrew Marcuse
5157bdc753 Update mime.types (#7756)
Merge pull request 7756
2019-07-20 11:36:32 -04:00
strangehill
8d5b5fa4dc Update .gitignore snippet in tutorial (#7748) 2019-07-18 14:43:59 +05:30
jekyllbot
7096885e98 Update history to reflect merge of #7720 [ci skip] 2019-07-15 11:38:55 -04:00
Chris Oliver
854e83230e Add recursive navigation tutorial (#7720)
Merge pull request 7720
2019-07-15 11:38:53 -04:00
Ashwin Maroli
ffe8d168f2 Prefer Regexp#match? over String#match?
This commit fixes a minor regression introduced in the commit e10a909

Prefer using `Regexp#match` because `@file` or `file` in these lines
could be `nil` if the `tag_markup` is just whitespace. In that scenario,
Jekyll should proceed to the validation logic and bail instead of raising
a `NoMethodError` exception.
2019-07-14 12:33:46 +05:30
jekyllbot
4c9cbad677 Update history to reflect merge of #7749 [ci skip] 2019-07-12 10:44:47 -04:00
Ashwin Maroli
135ebe2660 Reduce Array objects generated from utility method (#7749)
Merge pull request 7749
2019-07-12 10:44:45 -04:00
Ashwin Maroli
77b6033f2f Update Jekyll version in docs header 2019-07-10 16:15:59 +05:30
Parker Moore
fea0b69d39 3.8.6: add release note for 3c06609406 2019-07-02 16:51:40 -04:00
Frank Taillandier
f7f5cbc6f8 Merge pull request #7736 from jekyll/386-release-notes-public
Forward-port: 3.8.6 release notes
2019-07-02 22:13:34 +02:00
Frank Taillandier
5bc21d82f6 Regenerate Contributing 2019-07-02 21:29:07 +02:00
Parker Moore
f42e0e7169 Regenerate the History file bassed on our new date 2019-07-02 21:26:00 +02:00
Frank Taillandier
7c34db3991 Fix date 2019-07-02 21:26:00 +02:00
Parker Moore
b7e3f10a08 Move 3.8.6 documentation to the correct location in the History.markdown 2019-07-02 21:26:00 +02:00
Parker Moore
fcb8a1ecd3 Update contributing documentation on the website 2019-07-02 21:26:00 +02:00
Parker Moore
e318d1c836 Create 3.8.6 release notes 2019-07-02 21:26:00 +02:00
Frank Taillandier
874bd2e5c7 Merge pull request #7737 from ashmaroli/move-auto-generated-to-source
Move updates from generated file to source file
2019-07-02 21:22:37 +02:00
Ashwin Maroli
5b195ffe74 Generate a new site to reflect unreleased changes 2019-07-03 00:14:23 +05:30
Ashwin Maroli
03b500b7b7 Move updates from generated file to source file
#7464 and #7671 erroneously made changes to the auto-generated document
`docs/_docs/contributing.md` instead of the source file
`.github/CONTRIBUTING.markdown`
2019-07-02 23:54:02 +05:30
jekyllbot
ed8681b1e7 Update history to reflect merge of #7679 [ci skip] 2019-07-01 13:56:41 -04:00
Edgar Tinajero
ebe62e8a28 Update log output for an invalid theme directory (#7679)
Merge pull request 7679
2019-07-01 13:56:38 -04:00
jekyllbot
6435bd6167 Update history to reflect merge of #7704 [ci skip] 2019-06-28 12:28:02 -04:00
David Kennell
24f1978412 Introduce frontmatter in step 2 (#7704)
Merge pull request 7704
2019-06-28 12:27:59 -04:00
jekyllbot
2265e82181 Update history to reflect merge of #7598 [ci skip] 2019-06-28 06:45:11 -04:00
Yi Feng Xie
8abd4950a2 Update resources.md (#7598)
Merge pull request 7598
2019-06-28 06:45:09 -04:00
jekyllbot
7dbe470dce Update history to reflect merge of #7699 [ci skip] 2019-06-28 06:38:04 -04:00
Ashwin Maroli
3e8e6d22d7 Remove patch to modify config for kramdown (#7699)
Merge pull request 7699
2019-06-28 06:38:02 -04:00
Ashwin Maroli
c87f5fa7fa Normalize paths in reports from memory_profiler 2019-06-28 09:01:06 +05:30
jekyllbot
c76996cd8e Update history to reflect merge of #7723 [ci skip] 2019-06-27 13:16:29 -04:00
Ashwin Maroli
4530721575 Replace String#=~ with String#match? (#7723)
Merge pull request 7723
2019-06-27 13:16:27 -04:00
Ashwin Maroli
62959527dd Bump RuboCop to v0.72.x 2019-06-26 11:33:47 +05:30
jekyllbot
52374cf8be Update history to reflect merge of #7697 [ci skip] 2019-06-25 17:02:07 -04:00
Ashwin Maroli
27aa53cf82 Memoize SiteDrop#documents to reduce allocations (#7697)
Merge pull request 7697
2019-06-25 17:02:04 -04:00
jekyllbot
7d340d933a Update history to reflect merge of #7718 [ci skip] 2019-06-24 13:46:31 -04:00
Ashwin Maroli
e10a90987a Replace String#=~ with String#match? (#7718)
Merge pull request 7718
2019-06-24 13:46:28 -04:00
jekyllbot
25b274621b Update history to reflect merge of #7711 [ci skip] 2019-06-23 18:15:27 -04:00
Ashwin Maroli
68a31c8eb2 Don't read symlinks in site.include in safe mode (#7711)
Merge pull request 7711
2019-06-23 18:15:25 -04:00
jekyllbot
9ccdae161b Update history to reflect merge of #7702 [ci skip] 2019-06-23 16:23:10 -04:00
Ashwin Maroli
06eafadcbb Use regexp to filter special entries (#7702)
Merge pull request 7702
2019-06-23 16:23:09 -04:00
Ashwin Maroli
e37ee47219 Fix offenses detected by rubocop-performance-1.4.0 2019-06-21 15:27:18 +05:30
Ashwin Maroli
52ae35a589 Disable color output from profile:memory task
So that it is easier to parse the plaintext build logs
2019-06-21 15:00:45 +05:30
Ashwin Maroli
25898f8d9d Reword code-comment to reflect the implementation 2019-06-14 15:46:09 +05:30
Frank Taillandier
cca639dcc3 Merge pull request #7705 from ashmaroli/filter-dot-entries
Reject entries that are just dots in a directory
2019-06-14 08:31:57 +02:00
Frank Taillandier
7f1b678a4e Merge pull request #7707 from ashmaroli/refactor-glob-include
Refactor `EntryFilter#glob_include?`
2019-06-14 08:29:40 +02:00
jekyllbot
f0b7c9b783 Update history to reflect merge of #7687 [ci skip] 2019-06-13 20:29:59 -04:00
Ashwin Maroli
478e3ab301 Bump RuboCop to v0.71.0 (#7687)
Merge pull request 7687
2019-06-13 20:29:57 -04:00
jekyllbot
a4f24f54ad Update history to reflect merge of #7709 [ci skip] 2019-06-13 08:01:25 -04:00
Ashwin Maroli
70bc82bacc Update TestTags in sync with Rouge v3.4 (#7709)
Merge pull request 7709
2019-06-13 08:01:22 -04:00
Frank Taillandier
1480c41213 fix: LocalJump error: unexpected return
➜ rake site:latest_version
rake aborted!
LocalJumpError: unexpected return
/jekyll/rake/site.rake:89:in `block (2 levels) in <top (required)>'
Tasks: TOP => site:latest_version
(See full trace by running task with --trace)
2019-06-13 11:52:29 +02:00
jekyllbot
2df56abf85 Update history to reflect merge of #7708 [ci skip] 2019-06-12 18:39:16 -04:00
James Rhea
f56b7d59e6 fix link to Site Source config (#7708)
Merge pull request 7708
2019-06-12 18:39:14 -04:00
Ashwin Maroli
119e0047e8 Don't sanitize pattern or entry string 2019-06-09 16:38:19 +05:30
jekyllbot
58bc689829 Update history to reflect merge of #7706 [ci skip] 2019-06-09 07:06:50 -04:00
Ashwin Maroli
38bc4d2818 Do not install docs on updating gems on Travis (#7706)
Merge pull request 7706
2019-06-09 07:06:48 -04:00
Ashwin Maroli
3002aa58f5 Refactor EntryFilter#glob_include? 2019-06-09 15:35:39 +05:30
Ashwin Maroli
49e5b33fb0 Reject entries that are just dots in a directory 2019-06-09 11:42:34 +05:30
jekyllbot
13d31c4c8b Update history to reflect merge of #7695 [ci skip] 2019-06-05 12:10:40 -04:00
Ashwin Maroli
e05745929f Remove override to Jekyll::Document#respond_to? (#7695)
Merge pull request 7695
2019-06-05 12:10:37 -04:00
jekyllbot
04ba0c3b10 Update history to reflect merge of #7690 [ci skip] 2019-06-05 08:46:00 -04:00
SADIK KUZU
c914e8628b Typo fix in Jekyll 4.0 pre-release post (#7694) 2019-06-05 11:41:46 +05:30
jekyllbot
86fd200a68 Update history to reflect merge of #7691 [ci skip] 2019-06-03 04:59:58 -04:00
SADIK KUZU
56c39e76d2 Fix typo from 'Github' to 'GitHub' (#7691)
Merge pull request 7691
2019-06-03 04:59:56 -04:00
jekyllbot
2f791484ab Update history to reflect merge of #7689 [ci skip] 2019-05-31 11:31:49 -04:00
jekyllbot
db3570e582 Update history to reflect merge of #7684 [ci skip] 2019-05-30 21:28:05 -04:00
Ashwin Maroli
554e07d4a5 Revert memoizing Site#docs_to_write and #documents (#7684)
Merge pull request 7684
2019-05-30 21:28:03 -04:00
Christian Oliff
263d41f0f7 HTTPS link to yaml.org (#7686) 2019-05-30 14:39:44 +02:00
Frank Taillandier
c2a383ba43 Merge pull request #7680 from bomberstudios/patch-1
Added documentation for Live Reload feature
2019-05-28 21:48:57 +02:00
Ale Muñoz
276e71fb80 Update options.md 2019-05-28 15:13:02 +02:00
Ale Muñoz
641eb4e9e7 Update docs/_docs/configuration/options.md
Co-Authored-By: Frank Taillandier <frank.taillandier@gmail.com>
2019-05-28 15:11:50 +02:00
Frank Taillandier
4a7c5177c7 Merge pull request #7683 from fons-/patch-1
docs: `jekyll serve` restart after changing config
2019-05-28 12:04:32 +02:00
Fons van der Plas
390973683f docs: jekyll serve restart after changing config
These steps were missing in the Step-by-Step instructions on [jekyllrb.com/docs](https://jekyllrb.com/docs/step-by-step/01-setup/).
2019-05-27 14:10:25 +02:00
Frank Taillandier
c004281d86 Update FUNDING.yml 2019-05-26 18:11:40 +02:00
Frank Taillandier
03ce3f8a45 Update FUNDING.yml 2019-05-26 13:59:42 +02:00
Frank Taillandier
ac02b11fd2 Link to sponsorship
Co-authored-by: Ashwin Maroli <ashwin@jekyllrb.com>
Co-authored-by: Matt Rogers <mattr@jekyllrb.com>
2019-05-26 13:30:44 +02:00
Ale Muñoz
c6566b2410 Added documentation for Live Reload feature
This was added in 3.7.0 (see https://jekyllrb.com/news/2018/01/02/jekyll-3-7-0-released/) but it's not mentioned anywhere in the docs
2019-05-24 14:53:49 +02:00
jekyllbot
08b04aa337 Update history to reflect merge of #7678 [ci skip] 2019-05-24 03:50:47 -04:00
Ashwin Maroli
818441c8d9 Bump RuboCop to v0.70.x (#7678)
Merge pull request 7678
2019-05-24 03:50:45 -04:00
jekyllbot
b3770fd45d Update history to reflect merge of #7671 [ci skip] 2019-05-17 17:53:27 -04:00
krissy
98ae88f3fd Update small typo in contributing.md (#7671)
Merge pull request 7671
2019-05-17 17:53:26 -04:00
jekyllbot
617dc69879 Update history to reflect merge of #7609 [ci skip] 2019-05-17 02:53:45 -04:00
Ashwin Maroli
079b7231d9 Simplify assigning classname to docs' aside-links (#7609)
Merge pull request 7609
2019-05-17 02:53:43 -04:00
jekyllbot
9957e21be7 Update history to reflect merge of #7653 [ci skip] 2019-05-16 12:38:55 -04:00
Ashwin Maroli
ed385ba264 Reduce allocations from where-filter (#7653)
Merge pull request 7653
2019-05-16 12:38:53 -04:00
jekyllbot
2d3c030fac Update history to reflect merge of #7406 [ci skip] 2019-05-16 11:44:44 -04:00
Ashwin Maroli
49ffbbd4c7 Add type attribute to Document instances (#7406)
Merge pull request 7406
2019-05-16 11:44:39 -04:00
jekyllbot
db2de73a0d Update history to reflect merge of #7625 [ci skip] 2019-05-16 10:56:01 -04:00
Ashwin Maroli
7548132944 Reduce allocations from Jekyll::Document instances (#7625)
Merge pull request 7625
2019-05-16 10:55:59 -04:00
jekyllbot
7cdbbaafa7 Update history to reflect merge of #7643 [ci skip] 2019-05-16 10:04:40 -04:00
Ashwin Maroli
cbfdeaefcd Reduce string allocations with better alternatives (#7643)
Merge pull request 7643
2019-05-16 10:04:37 -04:00
jekyllbot
1658a1596e Update history to reflect merge of #7646 [ci skip] 2019-05-15 14:47:28 -04:00
Ashwin Maroli
af055b917c Profile allocations from a build session (#7646)
Merge pull request 7646
2019-05-15 14:47:25 -04:00
jekyllbot
a430c22007 Update history to reflect merge of #7654 [ci skip] 2019-05-15 12:14:10 -04:00
Ashwin Maroli
20c9d0957a Encode and unencode urls only as required (#7654)
Merge pull request 7654
2019-05-15 12:14:08 -04:00
jekyllbot
8c5ee73661 Update history to reflect merge of #7658 [ci skip] 2019-05-15 11:49:07 -04:00
Ashwin Maroli
c47611cb6e Initialize and reset glob_cache only as necessary (#7658)
Merge pull request 7658
2019-05-15 11:49:05 -04:00
jekyllbot
d6a756ba27 Update history to reflect merge of #7659 [ci skip] 2019-05-15 11:48:18 -04:00
Ashwin Maroli
ec347597da Reduce Array allocations via Jekyll::Cleaner (#7659)
Merge pull request 7659
2019-05-15 11:48:12 -04:00
jekyllbot
f99f910e29 Update history to reflect merge of #7656 [ci skip] 2019-05-15 11:45:56 -04:00
Ashwin Maroli
c763460943 Bump RuboCop to v0.69.x (#7656)
Merge pull request 7656
2019-05-15 11:45:54 -04:00
jekyllbot
12c074303e Update history to reflect merge of #7657 [ci skip] 2019-05-15 11:43:16 -04:00
Ashwin Maroli
965aef60e6 Initialize mutations for Drops only if necessary (#7657)
Merge pull request 7657
2019-05-15 11:43:13 -04:00
Frank Taillandier
6a604daa5a update teams 2019-05-12 13:31:33 +02:00
Frank Taillandier
bc54047315 add open graph image by default 2019-05-12 12:58:27 +02:00
Frank Taillandier
551014eb05 Docs: Invite to use bundler
Fix #7651
2019-05-08 13:04:04 +02:00
Frank Taillandier
dc265abf9f typo 2019-05-07 11:12:24 +02:00
Frank Taillandier
a62ed45588 New open graph image 2019-05-07 11:01:28 +02:00
jekyllbot
4dff839dbf Update history to reflect merge of #7648 [ci skip] 2019-05-06 23:31:15 -04:00
jingze_lu
98c5f47401 Solve "GitHub Page build failure" in 10-deployment.md (#7648)
Merge pull request 7648
2019-05-06 23:31:13 -04:00
jekyllbot
aa87361848 Update history to reflect merge of #7647 [ci skip] 2019-05-06 03:03:58 -04:00
Niklas Eicker
72c712ef9e add version tags to new placeholders (#5981) for permalinks (#7647)
Merge pull request 7647
2019-05-06 03:03:56 -04:00
jekyllbot
fd74fe3e93 Update history to reflect merge of #7644 [ci skip] 2019-05-04 11:00:44 -04:00
Anuj Bhatnagar
85bddfda21 Update 07-assets.md (#7644)
Merge pull request 7644
2019-05-04 11:00:43 -04:00
jekyllbot
8673cdc4cf Update history to reflect merge of #7640 [ci skip] 2019-05-02 00:38:26 -04:00
David Zhang
1b4340034b Doc: Data file section adds TSV (#7640)
Merge pull request 7640
2019-05-02 00:38:25 -04:00
jekyllbot
1bba76b4f5 Update history to reflect merge of #7638 [ci skip] 2019-05-01 14:54:22 -04:00
Ashwin Maroli
b04e3d3de7 Store list of expected extnames in a constant (#7638)
Merge pull request 7638
2019-05-01 14:54:18 -04:00
jekyllbot
568e50b37a Update history to reflect merge of #7532 [ci skip] 2019-05-01 14:43:22 -04:00
Ashwin Maroli
3e8c37b641 Refactor Jekyll::Cache (#7532)
Merge pull request 7532
2019-05-01 14:43:20 -04:00
jekyllbot
17a5f815b5 Update history to reflect merge of #7633 [ci skip] 2019-04-30 09:03:50 -04:00
Ashwin Maroli
14e5d00555 Fix broken include_relative usage in excerpt (#7633)
Merge pull request 7633
2019-04-30 09:03:48 -04:00
jekyllbot
1b2efb67c3 Update history to reflect merge of #7637 [ci skip] 2019-04-30 08:44:10 -04:00
Ashwin Maroli
a5cac26766 Bump RuboCop to v0.68.x (#7637)
Merge pull request 7637
2019-04-30 08:44:08 -04:00
jekyllbot
ced4404a5e Update history to reflect merge of #7583 [ci skip] 2019-04-19 10:30:19 -04:00
Ashwin Maroli
c8fe609f8f Target Ruby 2.4 syntax in RuboCop scans (#7583)
Merge pull request 7583
2019-04-19 10:30:17 -04:00
Ashwin Maroli
f4ee82650e Revert "Refactor highlight tag to behave like the raw tag" (#7592)
* Revert "Refactor `highlight` tag to behave like the `raw` tag (#6821)"

This reverts commit 36404b9a43.

* use Liquid `raw` in upgrading document
* let the minor improvements stay
* Revert entry in History.markdown
2019-04-19 12:49:03 +05:30
jekyllbot
36d3aed1f2 Update history to reflect merge of #7619 [ci skip] 2019-04-16 16:16:24 -04:00
Matt Rogers
a882608902 Update the contribution docs for draft pull requests (#7619)
Merge pull request 7619
2019-04-16 16:16:22 -04:00
jekyllbot
8e7b2ff7da Update history to reflect merge of #7561 [ci skip] 2019-04-12 14:01:34 -04:00
Liam Rosenfeld
6c872cf6a1 Install Docs that Work on MacOS 10.14 (#7561)
Merge pull request 7561
2019-04-12 14:01:31 -04:00
jekyllbot
ef588d6bc8 Update history to reflect merge of #7614 [ci skip] 2019-04-12 13:48:35 -04:00
Ashwin Maroli
ec0971ab17 Generate a "TOTAL" row for build-profile table (#7614)
Merge pull request 7614
2019-04-12 13:48:33 -04:00
jekyllbot
3cce93d9b8 Update history to reflect merge of #7610 [ci skip] 2019-04-11 12:02:48 -04:00
Ashwin Maroli
1bd1ae98e9 Avoid generating empty classnames (#7610)
Merge pull request 7610
2019-04-11 12:02:41 -04:00
jekyllbot
983e5af661 Update history to reflect merge of #7612 [ci skip] 2019-04-10 14:31:23 -04:00
Ashwin Maroli
6838153b83 Bump tested version of JRuby to 9.2.7.0 (#7612)
Merge pull request 7612
2019-04-10 14:31:21 -04:00
jekyllbot
8907f39548 Update history to reflect merge of #7607 [ci skip] 2019-04-07 06:53:59 -04:00
Ashwin Maroli
d6ece561b7 Simply couple of includes in the docs site (#7607)
Merge pull request 7607
2019-04-07 06:53:57 -04:00
jekyllbot
c68ccedc21 Update history to reflect merge of #7601 [ci skip] 2019-04-04 05:26:41 -04:00
Bjorn Krols
d0beaab6fe Added Formspark to form resources (#7601)
Merge pull request 7601
2019-04-04 05:26:40 -04:00
jekyllbot
3b675f5119 Update history to reflect merge of #7600 [ci skip] 2019-04-03 17:55:12 -04:00
Hodong Kim
7440050367 Fix link space (#7600)
Merge pull request 7600
2019-04-03 17:55:10 -04:00
jekyllbot
4f8e1f3d3f Update history to reflect merge of #7599 [ci skip] 2019-04-03 07:06:33 -04:00
Haris Bjelic
0ff03dba6c Update 07-assets.md (#7599)
Merge pull request 7599
2019-04-03 07:06:32 -04:00
jekyllbot
41583c9405 Update history to reflect merge of #7593 [ci skip] 2019-03-29 09:55:21 -04:00
Elvio Vicosa
31529906da Adds Statictastic to the list of resources (#7593)
Merge pull request 7593
2019-03-29 09:55:20 -04:00
jekyllbot
b09248ce2e Update history to reflect merge of #7589 [ci skip] 2019-03-29 02:54:47 -04:00
Ashwin Maroli
2591f33aa8 Incorporate relative_url within post_url tag (#7589)
Merge pull request 7589
2019-03-29 02:54:45 -04:00
jekyllbot
c985dc5899 Update history to reflect merge of #7586 [ci skip] 2019-03-26 17:21:48 -04:00
Ashwin Maroli
e3b284b757 Add a Cucumber feature for post_url tag (#7586)
Merge pull request 7586
2019-03-26 17:21:47 -04:00
jekyllbot
9e42fad62f Update history to reflect merge of #7584 [ci skip] 2019-03-22 12:19:00 -04:00
Ashwin Maroli
2090989fb3 Favor Ruby 2.3 squiggly-heredoc operator (#7584)
Merge pull request 7584
2019-03-22 12:18:58 -04:00
jekyllbot
dea6bdbfaf Update history to reflect merge of #7580 [ci skip] 2019-03-22 10:53:37 -04:00
Ashwin Maroli
9240addcf0 Detect nil and empty values in objects with where filter (#7580)
Merge pull request 7580
2019-03-22 10:53:34 -04:00
jekyllbot
16c24d9125 Update history to reflect merge of #5981 [ci skip] 2019-03-21 20:42:38 -04:00
Christoph Päper
0da5389cbb ISO week date drops (#5981)
Merge pull request 5981
2019-03-21 20:42:36 -04:00
Ashwin Maroli
6905c80470 Re-insert deleted History entry [skip ci] 2019-03-19 13:19:39 +05:30
Frank Taillandier
09b110d453 link to GitHub pre-release 2019-03-19 08:11:05 +01:00
Frank Taillandier
1041f7672f Release 💎 4.0.0.pre.alpha1 2019-03-19 08:05:07 +01:00
jekyllbot
6dcce995a6 Update history to reflect merge of #7574 [ci skip] 2019-03-19 03:03:59 -04:00
Frank Taillandier
378147d761 Release v4.0.0.pre.alpha1 (#7574)
Merge pull request 7574
2019-03-19 03:03:57 -04:00
jekyllbot
f3cb41b65a Update history to reflect merge of #7577 [ci skip] 2019-03-18 17:39:10 -04:00
Ashwin Maroli
9e137bae29 Push Markdown link refs to excerpt only as required (#7577)
Merge pull request 7577
2019-03-18 17:39:08 -04:00
Ashwin Maroli
3e2c8fd4c8 Bump RuboCop to v0.66.x 2019-03-18 15:35:53 +05:30
Ashwin Maroli
8552471712 Update Jekyll on Windows documentation [skip ci] 2019-03-18 15:14:05 +05:30
Ashwin Maroli
e522f54e53 Simplify Cucumber helper 2019-03-17 16:38:50 +05:30
Ashwin Maroli
26b7d6a94d Allow builds on JRuby to fail uneventfully 2019-03-17 16:29:16 +05:30
jekyllbot
9d0c73fce8 Update history to reflect merge of #7130 [ci skip] 2019-03-15 15:12:11 -04:00
Ashwin Maroli
7eefadb135 Scan assert_equal methods and rectify any offenses with a custom Rubocop cop (#7130)
Merge pull request 7130
2019-03-15 15:12:09 -04:00
jekyllbot
1e970b598d Update history to reflect merge of #7292 [ci skip] 2019-03-15 13:38:14 -04:00
Ashwin Maroli
cc7978f3bc Optimize Document::DATE_FILENAME_MATCHER to match valid filenames (#7292)
Merge pull request 7292
2019-03-15 13:38:12 -04:00
jekyllbot
5bc0ddd6d2 Update history to reflect merge of #7351 [ci skip] 2019-03-15 13:36:49 -04:00
Michael Hiiva
238f1c5eaf Addresses bundle not found. (#7351)
Merge pull request 7351
2019-03-15 13:36:48 -04:00
jekyllbot
b71dffc305 Update history to reflect merge of #7357 [ci skip] 2019-03-15 13:35:04 -04:00
mo khan
2bdf1a53c4 Log a warning when the slug is empty (#7357)
Merge pull request 7357
2019-03-15 13:35:01 -04:00
jekyllbot
757f47b21c Update history to reflect merge of #7418 [ci skip] 2019-03-15 13:33:56 -04:00
Frank Taillandier
5fa01141cc docs: mention CommonMark plugins (#7418)
Merge pull request 7418
2019-03-15 13:33:54 -04:00
jekyllbot
226fa22652 Update history to reflect merge of #7434 [ci skip] 2019-03-15 13:33:14 -04:00
Ashwin Maroli
555722887d Replace name in Page#inspect with relative_path (#7434)
Merge pull request 7434
2019-03-15 13:33:13 -04:00
jekyllbot
ec730657a7 Update history to reflect merge of #7454 [ci skip] 2019-03-15 13:31:57 -04:00
Frank Taillandier
57a29800b6 Feat: drop ruby 2.3 (#7454)
Merge pull request 7454
2019-03-15 13:31:54 -04:00
jekyllbot
5b86a636b5 Update history to reflect merge of #7519 [ci skip] 2019-03-15 13:30:42 -04:00
Ashwin Maroli
18f7a28168 Cleanup Markdown converter (#7519)
Merge pull request 7519
2019-03-15 13:30:39 -04:00
jekyllbot
7f2412c145 Update history to reflect merge of #7492 [ci skip] 2019-03-15 13:27:43 -04:00
Ashwin Maroli
575f4b66de Upgrade kramdown dependency to v2.x (#7492)
Merge pull request 7492
2019-03-15 13:27:41 -04:00
jekyllbot
9ba6c7dd77 Update history to reflect merge of #7569 [ci skip] 2019-03-15 13:20:19 -04:00
Ashwin Maroli
5942ee46ae Memoize Document#excerpt_separator (#7569)
Merge pull request 7569
2019-03-15 13:20:15 -04:00
jekyllbot
4279bafff3 Update history to reflect merge of #7568 [ci skip] 2019-03-15 13:14:59 -04:00
Ashwin Maroli
907477b9ca Escape valid special chars in a site's path name (#7568)
Merge pull request 7568
2019-03-15 13:14:57 -04:00
jekyllbot
e451acca6a Update history to reflect merge of #7272 [ci skip] 2019-03-15 13:11:48 -04:00
Ashwin Maroli
da313bf883 Avoid unnecessary duplication of pages array (#7272)
Merge pull request 7272
2019-03-15 13:11:46 -04:00
jekyllbot
9b3e5f9fc0 Update history to reflect merge of #7566 [ci skip] 2019-03-15 12:54:26 -04:00
Ashwin Maroli
8ccb013f85 Use communicative method parameters (#7566)
Merge pull request 7566
2019-03-15 12:54:24 -04:00
jekyllbot
67107f0ec5 Update history to reflect merge of #7498 [ci skip] 2019-03-15 12:53:42 -04:00
Ashwin Maroli
7ddaa9ffa1 Don't check if site URL is absolute if it is nil (#7498)
Merge pull request 7498
2019-03-15 12:53:40 -04:00
jekyllbot
3c231a41d2 Update history to reflect merge of #7301 [ci skip] 2019-03-15 12:52:32 -04:00
Ashwin Maroli
3b4151b773 Cache computed item property (#7301)
Merge pull request 7301
2019-03-15 12:52:30 -04:00
jekyllbot
d4b5760002 Update history to reflect merge of #7345 [ci skip] 2019-03-15 12:49:01 -04:00
Ashwin Maroli
b4dcdd42f8 Cache globbed paths in front matter defaults (#7345)
Merge pull request 7345
2019-03-15 12:49:00 -04:00
jekyllbot
46be718ef6 Update history to reflect merge of #6821 [ci skip] 2019-03-15 12:48:25 -04:00
Ashwin Maroli
36404b9a43 Refactor highlight tag to behave like the raw tag (#6821)
Merge pull request 6821
2019-03-15 12:48:21 -04:00
jekyllbot
d807deb647 Update history to reflect merge of #7450 [ci skip] 2019-03-15 12:10:50 -04:00
Ashwin Maroli
aea502745a Utilize absolute paths of user-provided file paths (#7450)
Merge pull request 7450
2019-03-15 12:10:48 -04:00
jekyllbot
475983537d Update history to reflect merge of #7572 [ci skip] 2019-03-14 21:40:47 -04:00
Ashwin Maroli
b668eb0150 Fix unnecessary allocations via StaticFileReader (#7572)
Merge pull request 7572
2019-03-14 21:40:45 -04:00
Ashwin Maroli
bdbf35136e Correct entry in History.markdown [skip ci] 2019-03-11 15:45:56 +05:30
jekyllbot
7889d7d215 Update history to reflect merge of #7564 [ci skip] 2019-03-11 06:10:57 -04:00
Ashwin Maroli
37f5e5f459 Improve handling sites without layouts (#7564)
Merge pull request 7564
2019-03-11 06:10:55 -04:00
Ashwin Maroli
12e7a35ea7 Update history to reflect merge of #7562 [ci skip] 2019-03-10 17:24:32 +05:30
Ashwin Maroli
5fa93015a6 Revert Utils::WinTZ upgrade and lock to TZInfo-1.x (#7562)
Revert "Add missing divider in upgrading-guide"
This reverts commit d8c745ca30.

Revert "Update history to reflect merge of #7521"
This reverts commit 7ee2e26d6c.

Revert "Upgrade WinTZ utility to use TZInfo-2.0"
This reverts commit 13cbef4221.

Lock use of `tzinfo` gem to v1.x
2019-03-10 17:20:48 +05:30
Frank Taillandier
3036d36a7c Merge pull request #7560 from rosariopfernandes/patch-1
Update circleci.md
2019-03-10 05:31:35 +01:00
Rosário Pereira Fernandes
9c11c9a8a7 Update circleci.md
- correct minor typo
2019-03-10 02:18:34 +02:00
Frank Taillandier
7f4b15194f Merge pull request #7558 from denismcdonald/patch-2
Minor typographical suggestions
2019-03-09 07:49:50 +01:00
Denis McDonald
633a2922d6 Minor typographical suggestions 2019-03-09 17:03:58 +11:00
Ashwin Maroli
68e633a56e Remove deprecated sudo: false in .travis.yml
https://blog.travis-ci.com/2018-11-19-required-linux-infrastructure-migration
2019-03-06 16:30:24 +05:30
Ashwin Maroli
5e7dc7b4d3 Use jruby-openssl-0.10.1 in JRuby builds 2019-03-06 13:15:56 +05:30
Ben Otte
9f7078d582 Fix Wiki link in README.markdown (#7549)
Updated sites link
2019-02-26 22:55:27 +05:30
Ashwin Maroli
d8c745ca30 Add missing divider in upgrading-guide [skip ci] 2019-02-21 17:06:35 +05:30
jekyllbot
7ee2e26d6c Update history to reflect merge of #7521 [ci skip] 2019-02-20 15:53:15 -05:00
Ashwin Maroli
13cbef4221 Upgrade WinTZ utility to use TZInfo-2.0 (#7521)
Merge pull request 7521
2019-02-20 15:53:13 -05:00
jekyllbot
4e24a460ae Update history to reflect merge of #7160 [ci skip] 2019-02-20 10:47:22 -05:00
Ashwin Maroli
63b3739062 Add Site#in_cache_dir helper method (#7160)
Merge pull request 7160
2019-02-20 10:47:20 -05:00
jekyllbot
25ad937597 Update history to reflect merge of #7525 [ci skip] 2019-02-20 03:21:39 -05:00
Ashwin Maroli
b975608cbb Fix incorrect Windows path in themes.md [skip ci] (#7525)
Merge pull request 7525
2019-02-20 03:21:37 -05:00
jekyllbot
2f94540f89 Update history to reflect merge of #7540 [ci skip] 2019-02-20 03:19:36 -05:00
Ashwin Maroli
51d1366902 Add a script to profile docs with CI (#7540)
Merge pull request 7540
2019-02-20 03:19:34 -05:00
Ashwin Maroli
2786d67be5 Use rubocop-0.65.x on all platforms except Windows 2019-02-20 13:15:54 +05:30
Ashwin Maroli
0fef05e161 Lock RuboCop on Windows to v0.64.x temporarily 2019-02-20 13:04:38 +05:30
Frank Taillandier
c36f248556 bump Rubocop 2019-02-19 22:15:30 +01:00
jekyllbot
bbc2e1469e Update history to reflect merge of #7188 [ci skip] 2019-02-19 11:54:20 -05:00
Ashwin Maroli
091b5bd697 Always exclude certain paths from being processed (#7188)
Merge pull request 7188
2019-02-19 11:54:18 -05:00
jekyllbot
fac57981d3 Update history to reflect merge of #7538 [ci skip] 2019-02-19 03:46:12 -05:00
Paul Kim
6df8808cbc Clarify docs on collections regarding the need for front matter (#7538)
Merge pull request 7538
2019-02-19 03:46:09 -05:00
jekyllbot
8319501415 Update history to reflect merge of #7536 [ci skip] 2019-02-18 09:26:05 -05:00
Ananthakumar
98dc27b0ab Added formX to form-backend resources (#7536)
Merge pull request 7536
2019-02-18 09:26:02 -05:00
Ashwin Maroli
33a55d7f65 Add dummy content to appease classifier-reborn
Removes the following noise from test logs:

```
Input: '' is entirely stopwords or words with 2 or fewer characters.
Classifier-Reborn cannot handle this document properly.
```
2019-02-17 13:57:54 +05:30
Ashwin Maroli
9f46819606 There are 59 test posts now 2019-02-17 12:49:46 +05:30
jekyllbot
d2adfb3cbb Update history to reflect merge of #7315 [ci skip] 2019-02-16 11:31:16 -05:00
Ashwin Maroli
dedfb0748f Handle files with trailing dots in their basename (#7315)
Merge pull request 7315
2019-02-16 11:31:14 -05:00
jekyllbot
996431ba60 Update history to reflect merge of #7427 [ci skip] 2019-02-16 11:19:04 -05:00
Ashwin Maroli
07bf5be7b4 Allow custom sorting of collection documents (#7427)
Merge pull request 7427
2019-02-16 11:19:03 -05:00
jekyllbot
f6527cd7ef Update history to reflect merge of #7527 [ci skip] 2019-02-16 11:08:28 -05:00
Josue Caraballo
9ee96562dd changed future post loglevel to warn to help user narrow down issues (#7527)
Merge pull request 7527
2019-02-16 11:08:26 -05:00
Frank Taillandier
403f526275 make it compatible with category feed [skip-ci] 2019-02-15 21:04:30 +01:00
Frank Taillandier
8d7ef662bc add missing Forestry logo [skip-ci] 2019-02-15 21:04:30 +01:00
Frank Taillandier
cc409d33f7 docs: add feed for releases [skip-ci] 2019-02-15 21:04:29 +01:00
jekyllbot
925aa33ddc Update history to reflect merge of #7530 [ci skip] 2019-02-15 09:20:15 -05:00
Jörg Steinsträter
f1777adae9 Check if var exists before include tag (#7530)
Merge pull request 7530
2019-02-15 09:20:12 -05:00
jekyllbot
55f0980716 Update history to reflect merge of #7232 [ci skip] 2019-02-15 08:47:03 -05:00
Ashwin Maroli
06c49c7af6 Configure cache_dir (#7232)
Merge pull request 7232
2019-02-15 08:47:00 -05:00
Ashwin Maroli
9cb27144b0 Update Pull Request Template 2019-02-15 14:40:49 +05:30
Frank Taillandier
65817cc6cb Redirect docs/resources 2019-02-14 22:44:36 +01:00
jekyllbot
f6e7c46dd1 Update history to reflect merge of #7497 [ci skip] 2019-02-14 16:32:18 -05:00
Dusty Candland
e3a51092dd Add CloudSh to resource page. (#7497)
Merge pull request 7497
2019-02-14 16:32:16 -05:00
jekyllbot
623e306fd6 Update history to reflect merge of #7524 [ci skip] 2019-02-14 04:54:26 -05:00
Wouter Schoot
b8886e4287 Update convert-existing-site-to-jekyll.md (#7524)
Merge pull request 7524
2019-02-14 04:54:24 -05:00
Ashwin Maroli
2903276b4e Notify users on Windows to use tzinfo-1.x series (#7520) 2019-02-14 14:15:01 +05:30
Ashwin Maroli
9a4b74c44b Show the code for sample generator first [skip ci] 2019-02-12 22:12:50 +05:30
jekyllbot
20d9cbe231 Update history to reflect merge of #7518 [ci skip] 2019-02-12 03:32:34 -05:00
Ashwin Maroli
349b0361c1 Test with Ruby 2.6 on AppVeyor [skip travis] (#7518)
Merge pull request 7518
2019-02-12 03:32:32 -05:00
Frank Taillandier
bbd635539d bump Rubocop 2019-02-10 16:43:57 +01:00
jekyllbot
13b0832459 Update history to reflect merge of #7510 [ci skip] 2019-02-04 13:04:50 -05:00
Nikhil Swaminathan
8597a581d7 Hosting with AWS Amplify (#7510)
Merge pull request 7510
2019-02-04 13:04:49 -05:00
Frank Taillandier
fb22130906 docs: lastest Ruby is 2.6.1 2019-02-03 00:10:00 +01:00
jekyllbot
1ceef6dcf7 Update history to reflect merge of #7425 [ci skip] 2019-02-02 16:03:46 -05:00
Frank Taillandier
9412171578 dev: update gemspec (#7425)
Merge pull request 7425
2019-02-02 16:03:44 -05:00
jekyllbot
317ed856ff Update history to reflect merge of #6998 [ci skip] 2019-01-30 09:44:49 -05:00
Ashwin Maroli
e819bc4af0 Support for binary operators in where_exp filter (#6998)
Merge pull request 6998
2019-01-30 09:44:45 -05:00
jekyllbot
4550f02b58 Update history to reflect merge of #7503 [ci skip] 2019-01-29 13:55:38 -05:00
Jacob Byers
52faf2c34c Changed order of steps (#7503)
Merge pull request 7503
2019-01-29 13:55:36 -05:00
jekyllbot
e1ef5f9229 Update history to reflect merge of #7261 [ci skip] 2019-01-27 09:00:46 -05:00
Ashwin Maroli
1df4e94989 Search Front matter defaults with relative_path (#7261)
Merge pull request 7261
2019-01-27 09:00:44 -05:00
jekyllbot
922e4c01fe Update history to reflect merge of #7495 [ci skip] 2019-01-24 10:17:27 -05:00
Behrang
fd302cb1f7 Minor doc fixes (#7495)
Merge pull request 7495
2019-01-24 10:17:25 -05:00
Ashwin Maroli
33680b67af Use 64Bit Ruby for all builds on AppVeyor 2019-01-23 17:16:39 +05:30
jekyllbot
2de291c297 Update history to reflect merge of #7489 [ci skip] 2019-01-23 02:05:44 -05:00
Luis Enrique Perez Alvarez
38b64fc9e9 Update rubocop to ~> 0.63.1 (#7489)
Merge pull request 7489
2019-01-23 02:05:43 -05:00
jekyllbot
79b7b9ac02 Update history to reflect merge of #7476 [ci skip] 2019-01-14 11:08:20 -05:00
Ashwin Maroli
1a01f95a12 Remind user to include gem in the Gemfile on error (#7476)
Merge pull request 7476
2019-01-14 11:08:17 -05:00
Frank Taillandier
0e761fd4ef chore(config): add config for update-docs 2019-01-13 08:29:57 +01:00
jekyllbot
aef5626b4d Update history to reflect merge of #7473 [ci skip] 2019-01-12 14:53:50 -05:00
Arthur Attwell
70fe95c439 Docs: store SSL key and cert in site source (#7473)
Merge pull request 7473
2019-01-12 14:53:48 -05:00
jekyllbot
ce0471fbec Update history to reflect merge of #7472 [ci skip] 2019-01-11 08:44:54 -05:00
Timo Schuhmacher
6dbaf59ac9 Update resources.md (#7472)
Merge pull request 7472
2019-01-11 08:44:49 -05:00
jekyllbot
58076c4ff9 Update history to reflect merge of #7471 [ci skip] 2019-01-11 08:43:00 -05:00
Ashwin Maroli
b02caf0731 Relax version constraint on classifier-reborn gem (#7471)
Merge pull request 7471
2019-01-11 08:42:58 -05:00
Ashwin Maroli
ae0a064f3f Output correct class name in custom inspect string 2019-01-11 13:18:49 +05:30
Frank Taillandier
500dd64316 Merge pull request #7470 from makmm/update-license-year
Update license year
2019-01-09 20:54:01 +01:00
Frank Taillandier
d87ee5af03 Update LICENSE 2019-01-09 20:53:38 +01:00
makmm
ddbf730865 Update license year 2019-01-09 18:31:23 +00:00
jekyllbot
80104c177a Update history to reflect merge of #7464 [ci skip] 2019-01-06 09:12:56 -05:00
Andrew Lyndem
5c16257947 Grammatical correction (#7464)
Merge pull request 7464
2019-01-06 09:12:54 -05:00
jekyllbot
52aa62b0ae Update history to reflect merge of #7466 [ci skip] 2019-01-06 09:07:44 -05:00
Andrew Lyndem
e87f41834f Fixed unnecessary aticles and pronouns (#7466)
Merge pull request 7466
2019-01-06 09:07:42 -05:00
jekyllbot
1a718e9b12 Update history to reflect merge of #7459 [ci skip] 2019-01-04 06:47:15 -05:00
Ben Keith
fc51c32337 Permalink docs typo fixes (#7459)
Merge pull request 7459
2019-01-04 06:47:14 -05:00
jekyllbot
ea7d107b5c Update history to reflect merge of #7382 [ci skip] 2019-01-04 04:30:31 -05:00
Kyle Barbour
88d63c9303 Excerpt handling of custom and intermediate tags (#7382)
Merge pull request 7382
2019-01-04 04:30:29 -05:00
Frank Taillandier
f539f4d075 Merge pull request #7457 from behrangsa/patch-1
Fixed grammar
2019-01-04 00:52:17 +01:00
Behrang
ced0d8a6ba Fixed grammar
there's ➡️ there are.
2019-01-03 23:34:29 +00:00
jekyllbot
831fba68be Update history to reflect merge of #7410 [ci skip] 2019-01-02 19:48:09 -05:00
Ashwin Maroli
5d144beb00 Dont write static files from unrendered collection (#7410)
Merge pull request 7410
2019-01-02 19:48:07 -05:00
jekyllbot
be78b4246c Update history to reflect merge of #7448 [ci skip] 2019-01-02 19:21:58 -05:00
Dan Allen
9a0153f4d2 fix warning in Jekyll::Renderer#layouts (#7448)
Merge pull request 7448
2019-01-02 19:21:57 -05:00
Ashwin Maroli
9fa6863794 Favor if-unless modifier when single-line body 2019-01-02 22:56:19 +05:30
jekyllbot
84c46eb680 Update history to reflect merge of #7449 [ci skip] 2019-01-02 04:10:10 -05:00
Ashwin Maroli
eaa75dfc40 Bump RuboCop to v0.62.x (#7449)
Merge pull request 7449
2019-01-02 04:10:08 -05:00
jekyllbot
d13ad84aa7 Update history to reflect merge of #7438 [ci skip] 2019-01-02 02:31:38 -05:00
Ashwin Maroli
3eb9b441c5 Test with the new Ruby v2.6 (#7438)
Merge pull request 7438
2019-01-02 02:31:36 -05:00
jekyllbot
dee01f671a Update history to reflect merge of #7430 [ci skip] 2018-12-24 12:55:30 -05:00
Derpy
f721386419 Include docs for {{ page.collection }} (#7430)
Merge pull request 7430
2018-12-24 12:55:29 -05:00
Ashwin Maroli
8fd432c10a Lock JRuby builds on Travis CI to i18n-1.2.x (#7437) 2018-12-24 22:34:54 +05:30
Ashwin Maroli
878e0ba29c Skip theme-dir-symlink test if on Windows 2018-12-18 23:18:48 +05:30
jekyllbot
57a05bf948 Update history to reflect merge of #7429 [ci skip] 2018-12-18 12:00:29 -05:00
Ashwin Maroli
c368fec322 Create symlink only if target is accessible (#7429)
Merge pull request 7429
2018-12-18 12:00:27 -05:00
jekyllbot
8c0a250da4 Update history to reflect merge of #7428 [ci skip] 2018-12-17 11:25:00 -05:00
Gareth Cooper
f8037c6699 zlib is missing (#7428)
Merge pull request 7428
2018-12-17 11:24:58 -05:00
jekyllbot
6f984b381c Update history to reflect merge of #7157 [ci skip] 2018-12-16 11:14:33 -05:00
Ashwin Maroli
18fb5687f4 Reduce array traversal in Jekyll::Reader (#7157)
Merge pull request 7157
2018-12-16 11:14:32 -05:00
jekyllbot
0f5697c4ea Update history to reflect merge of #7422 [ci skip] 2018-12-16 01:16:25 -05:00
Ashwin Maroli
446aa88bdf Add a custom inspect string for StaticFile objects (#7422)
Merge pull request 7422
2018-12-16 01:16:24 -05:00
jekyllbot
9882ca238d Update history to reflect merge of #7404 [ci skip] 2018-12-16 01:08:55 -05:00
Ashwin Maroli
1a7b55e6dd Documents should be able to render their date (#7404)
Merge pull request 7404
2018-12-16 01:08:53 -05:00
Ashwin Maroli
e41c42720a CI: Build stable branches during backport 2018-12-14 23:58:58 +05:30
jekyllbot
9221e3429d Update history to reflect merge of #7419 [ci skip] 2018-12-14 10:08:43 -05:00
Parker Moore
8741c69d42 Theme gems: ensure directories aren't symlinks (#7419)
Merge pull request 7419
2018-12-14 10:08:41 -05:00
jekyllbot
55bd0391da Update history to reflect merge of #7420 [ci skip] 2018-12-13 16:31:23 -05:00
Daniel Höpfl
7498d4144e Update ubuntu.md (#7420)
Merge pull request 7420
2018-12-13 16:31:21 -05:00
jekyllbot
a93dd0fa64 Update history to reflect merge of #7412 [ci skip] 2018-12-10 16:35:08 -05:00
Frank Taillandier
12f66076ba chore(ci): test oldest and latest Ruby only (#7412)
Merge pull request 7412
2018-12-10 16:35:06 -05:00
Frank Taillandier
6cb97771b7 docs: mention --user-install option 2018-12-10 21:06:59 +01:00
Frank Taillandier
1d8b038edd docs: update macOS install instructions 2018-12-10 16:28:28 +01:00
Ashwin Maroli
775153df6a Upgrade to Code Climate config v2 2018-12-10 18:16:02 +05:30
jekyllbot
92be0c3fab Update history to reflect merge of #7409 [ci skip] 2018-12-09 02:55:18 -05:00
Manu Mathew
03b51791c1 Fix grammatical error in permalinks.md (#7409)
Merge pull request 7409
2018-12-09 02:55:17 -05:00
jekyllbot
fe97682e3b Update history to reflect merge of #7407 [ci skip] 2018-12-08 02:23:39 -05:00
Matt Massicotte
8ac16a281c Remove alt attribute from a tags (#7407)
Merge pull request 7407
2018-12-08 02:23:38 -05:00
jekyllbot
eac18f88f5 Update history to reflect merge of #7405 [ci skip] 2018-12-06 11:53:31 -05:00
olivia hugger
dc549a769f link site to sponsor listing in readme (#7405)
Merge pull request 7405
2018-12-06 11:53:29 -05:00
Frank Taillandier
0f9467c61b Update issue templates 2018-12-05 20:43:36 +01:00
jekyllbot
d257398333 Update history to reflect merge of #7401 [ci skip] 2018-12-05 11:21:50 -05:00
Ashwin Maroli
eda9e2e4ef Bump RuboCop to v0.61.x (#7401)
Merge pull request 7401
2018-12-05 11:21:48 -05:00
jekyllbot
5b3eb43e08 Update history to reflect merge of #7398 [ci skip] 2018-12-01 12:17:20 -05:00
olivia hugger
9ae8c09c1b add @ashmaroli to core team listing (#7398)
Merge pull request 7398
2018-12-01 12:17:19 -05:00
jekyllbot
cfa022db1d Update history to reflect merge of #7397 [ci skip] 2018-11-30 07:41:18 -05:00
Mertcan Yücel
c704d36b39 Update resources.md (#7397)
Merge pull request 7397
2018-11-30 07:41:16 -05:00
jekyllbot
2f36fd7fff Update history to reflect merge of #7396 [ci skip] 2018-11-30 04:46:15 -05:00
Mertcan Yücel
970c1dde5c Update resources.md (#7396)
Merge pull request 7396
2018-11-30 04:46:13 -05:00
jekyllbot
24fa104567 Update history to reflect merge of #7395 [ci skip] 2018-11-28 14:37:51 -05:00
olivia hugger
6285f59ce3 adjust team page listings (#7395)
Merge pull request 7395
2018-11-28 14:37:49 -05:00
olivia
646b24d9ba add vpsservers to sponsors 2018-11-28 20:35:23 +01:00
jekyllbot
a0f7d800d6 Update history to reflect merge of #7394 [ci skip] 2018-11-27 18:37:11 -05:00
Joe Shannon
e4677b8567 docs: Fix group_by_exp filter example (#7394)
Merge pull request 7394
2018-11-27 18:37:09 -05:00
jekyllbot
78ea59f5a7 Update history to reflect merge of #7393 [ci skip] 2018-11-26 02:50:53 -05:00
김정환
48b6e743f1 Apply ruby official guide documents (#7393)
Merge pull request 7393
2018-11-26 02:50:52 -05:00
jekyllbot
d808359186 Update history to reflect merge of #7372 [ci skip] 2018-11-24 08:25:16 -05:00
XhmikosR
fa914d2dd8 Switch to gem 'wdm', '~> 0.1.1', :install_if => Gem.win_platform? (#7372)
Merge pull request 7372
2018-11-24 08:25:15 -05:00
jekyllbot
c8bd59b69e Update history to reflect merge of #7392 [ci skip] 2018-11-23 14:57:17 -05:00
jpasholk
62448192df Proposed re-wording of Sass note. :) (#7392)
Merge pull request 7392
2018-11-23 14:57:15 -05:00
jekyllbot
cd200d380f Update history to reflect merge of #7388 [ci skip] 2018-11-20 10:35:34 -05:00
Frank Taillandier
842c055ecb Site: Better Performance (#7388)
Merge pull request 7388
2018-11-20 10:35:32 -05:00
Frank Taillandier
c732da44d5 docs: update CoC to 1.4.1 2018-11-19 22:52:24 +01:00
jekyllbot
470ef47abc Update history to reflect merge of #7365 [ci skip] 2018-11-19 12:03:20 -05:00
Ashwin Maroli
6431637fd7 Update excludes for CodeClimate Analyses (#7365)
Merge pull request 7365
2018-11-19 12:03:18 -05:00
Frank Taillandier
6c5bb7cce1 docs: add Contentul plugin 2018-11-18 16:54:35 +01:00
jekyllbot
b26ad019c3 Update history to reflect merge of #6788 [ci skip] 2018-11-18 06:54:33 -05:00
Ashwin Maroli
bfc733da90 Only read layouts from source_dir or theme_dir (#6788)
Merge pull request 6788
2018-11-18 06:54:32 -05:00
jekyllbot
41b8192b07 Update history to reflect merge of #7385 [ci skip] 2018-11-18 03:36:10 -05:00
Akshat Kedia
ba2019dca9 Fix content management section (#7385)
Merge pull request 7385
2018-11-18 03:36:09 -05:00
jekyllbot
e397146acb Update history to reflect merge of #7383 [ci skip] 2018-11-16 04:46:55 -05:00
Leandro Facchinetti
d0753ecd82 Fix dead link and misleading prose (#7383)
Merge pull request 7383
2018-11-16 04:46:54 -05:00
Frank Taillandier
7184404c74 docs: use current macOS Ruby versions 2018-11-16 09:39:33 +01:00
jekyllbot
26608929dc Update history to reflect merge of #7381 [ci skip] 2018-11-16 03:30:41 -05:00
Leandro Facchinetti
cb245a7e30 Remove installation instructions with Homebrew (#7381)
Merge pull request 7381
2018-11-16 03:30:39 -05:00
jekyllbot
7c1f065a41 Update history to reflect merge of #7375 [ci skip] 2018-11-13 10:04:12 -05:00
Frank Taillandier
a642f31144 chore(deps): upgrade liquid-c to v4.0 (#7375)
Merge pull request 7375
2018-11-13 10:04:10 -05:00
jekyllbot
c65b08aef3 Update history to reflect merge of #7378 [ci skip] 2018-11-13 10:02:54 -05:00
Boris SCHAPIRA
677aa49aa2 Add a link to OpenCollective backing (#7378)
Merge pull request 7378
2018-11-13 10:02:51 -05:00
jekyllbot
39a240a8af Update history to reflect merge of #7377 [ci skip] 2018-11-13 09:59:22 -05:00
Boris SCHAPIRA
fdce19e966 🐛 Fix link to Tidelift (#7377)
Merge pull request 7377
2018-11-13 09:59:20 -05:00
jekyllbot
fb0f182a5d Update history to reflect merge of #7373 [ci skip] 2018-11-13 02:36:38 -05:00
jekyllbot
2acff4a5bf docs: document page.dir and page.name (#7373)
Merge pull request 7373
2018-11-13 02:36:37 -05:00
jekyllbot
84cb2cb06d Update history to reflect merge of #7348 [ci skip] 2018-11-12 14:10:29 -05:00
Matthew Rathbone
fc60ecce2d Added 99inbound's Jekyll post to form resources (#7348)
Merge pull request 7348
2018-11-12 14:10:28 -05:00
olivia hugger
68b8565c94 add icons8 to readme 2018-11-11 18:43:04 +01:00
olivia
4da289e22d add icons8 to site sponsors 2018-11-11 18:17:19 +01:00
jekyllbot
1cc84d8d7b Update history to reflect merge of #7359 [ci skip] 2018-11-07 17:40:11 -05:00
Sri Pravan Paturi
7d76d5e48e Add documentation for custom tag blocks (#7359)
Merge pull request 7359
2018-11-07 17:40:10 -05:00
olivia hugger
9a66a1614e correct faulty merges 2018-11-07 15:46:03 +01:00
jekyllbot
afd0a6ff69 Update history to reflect merge of #7360 [ci skip] 2018-11-07 09:18:39 -05:00
Tushar Prajapati
e3f9c452b6 Update posts.md (#7360)
Merge pull request 7360
2018-11-07 09:18:37 -05:00
olivia hugger
22d9936042 Merge pull request #7354 from jekyll/add-3.8.5-post
Add 3.8.5 post
2018-11-04 21:23:03 +01:00
olivia
271e476e67 reflect 3.8.5 release 2018-11-04 21:22:28 +01:00
olivia
d0c1cde922 Add 3.8.5 post 2018-11-04 21:07:14 +01:00
olivia hugger
564f7735b3 test for stable and backport branches on travis 2018-11-04 20:41:10 +01:00
jekyllbot
d971e39b4f Update history to reflect merge of #6727 [ci skip] 2018-11-04 14:03:21 -05:00
Ashwin Maroli
d926ebf688 Incorporate relative_url filter in link tag (#6727)
Merge pull request 6727
2018-11-04 14:03:18 -05:00
jekyllbot
1825813c93 Update history to reflect merge of #7250 [ci skip] 2018-11-04 14:02:02 -05:00
Ashwin Maroli
592b530de1 Re-implement handling Liquid blocks in excerpts (#7250)
Merge pull request 7250
2018-11-04 14:02:00 -05:00
jekyllbot
b586bed0ee Update history to reflect merge of #7273 [ci skip] 2018-10-31 13:10:21 -04:00
Ashwin Maroli
f0af098abe Memoize the return value of Site#documents (#7273)
Merge pull request 7273
2018-10-31 13:10:19 -04:00
jekyllbot
501d0253fa Update history to reflect merge of #7343 [ci skip] 2018-10-28 11:39:34 -04:00
Frank Taillandier
c9dda7ad50 docs: minimize rendering count (#7343)
Merge pull request 7343
2018-10-28 11:39:32 -04:00
jekyllbot
7d9667f13f Update history to reflect merge of #7304 [ci skip] 2018-10-28 06:08:34 -04:00
Ashwin Maroli
d67cbb4e5f Load config file from within current theme-gem (#7304)
Merge pull request 7304
2018-10-28 06:08:32 -04:00
jekyllbot
56c35f1a7d Update history to reflect merge of #7316 [ci skip] 2018-10-28 06:04:29 -04:00
Ashwin Maroli
9152b1c9b8 Measure the no. of times a template gets rendered (#7316)
Merge pull request 7316
2018-10-28 06:04:27 -04:00
Frank Taillandier
fbec40589d docs: exclude .jekyll-cache
Stop regenerating: files in  .jekyll-cache
2018-10-28 06:31:11 +01:00
jekyllbot
d492766220 Update history to reflect merge of #7276 [ci skip] 2018-10-28 01:12:05 -04:00
Ashwin Maroli
ea8ac3a7fa Memoize Site#post_attr_hash (#7276)
Merge pull request 7276
2018-10-28 01:12:04 -04:00
jekyllbot
266a8bb746 Update history to reflect merge of #7342 [ci skip] 2018-10-27 18:33:44 -04:00
Aidan Fitzgerald
4bbbb8d3e2 Remove redundant instruction comment (#7342)
Merge pull request 7342
2018-10-27 18:33:43 -04:00
jekyllbot
587111ec9f Update history to reflect merge of #7338 [ci skip] 2018-10-26 09:43:42 -04:00
Ashwin Maroli
8d80ada92b Bump RuboCop to v0.60.x (#7338)
Merge pull request 7338
2018-10-26 09:43:40 -04:00
Frank Taillandier
41c25f30e1 style: commas [ci skip]
Co-Authored-By: Ashwin Maroli <ashmaroli@users.noreply.github.com>
2018-10-26 15:31:20 +02:00
Frank Taillandier
bc11acc7b1 docs: use YAML data for paginator obkect 2018-10-26 15:00:17 +02:00
Frank Taillandier
9ff6a24a06 docs: variables table as include
Co-Authored-By: Ashwin Maroli <ashmaroli@users.noreply.github.com>
2018-10-24 17:23:00 +02:00
Frank Taillandier
29ba846f9b Merge pull request #7336 from jekyll/docs/data-variables
docs: Page variables as YAML data
2018-10-24 16:09:01 +02:00
Ashwin Maroli
75f1bccaa4 Adjust whitespace 2018-10-24 19:21:30 +05:30
Frank Taillandier
a7a9c52ae6 docs: Page variables as YAML data 2018-10-24 14:31:30 +02:00
jekyllbot
4ac66931d0 Update history to reflect merge of #7335 [ci skip] 2018-10-24 07:08:03 -04:00
Ashwin Maroli
7422b741c1 Document Jekyll Filters with YAML data (#7335)
Merge pull request 7335
2018-10-24 07:08:00 -04:00
Frank Taillandier
fe74976942 Merge pull request #7334 from ashmaroli/liquid-filters-template
Liquid templating to DRY content
2018-10-24 09:33:16 +02:00
Ashwin Maroli
6413df69e5 Liquid templating to DRY content 2018-10-24 08:28:07 +05:30
Frank Taillandier
bd623967ff docs: fix link to liquid filter 2018-10-24 01:26:06 +02:00
jekyllbot
3987256119 Update history to reflect merge of #7333 [ci skip] 2018-10-23 19:20:30 -04:00
Frank Taillandier
2b146a64fc docs: list all standard liquid filters (#7333)
Merge pull request 7333
2018-10-23 19:20:28 -04:00
olivia hugger
f3c85d4095 Merge pull request #7319 from jekyll/add-tidelift
Add Tidelift to site sponsors
2018-10-19 23:49:07 +02:00
jekyllbot
ecaefdb991 Update history to reflect merge of #7326 [ci skip] 2018-10-19 16:29:16 -04:00
Ashwin Maroli
c7a99f276c Revert "Cache converter in renderer" (#7326)
Merge pull request 7326
2018-10-19 16:29:14 -04:00
jekyllbot
5925c1a531 Update history to reflect merge of #7327 [ci skip] 2018-10-19 15:42:58 -04:00
Brett C
1530e246d8 grammar change (#7327)
Merge pull request 7327
2018-10-19 15:42:56 -04:00
jekyllbot
b3a7ba5a26 Update history to reflect merge of #7302 [ci skip] 2018-10-19 11:35:44 -04:00
Mario
ad7a5c0121 Skip processing posts that can not be read (#7302)
Merge pull request 7302
2018-10-19 11:35:42 -04:00
Frank Taillandier
7a1254563a Docs: reorganize README
Put things in order: getting started, diving in, then asking for help 😄
2018-10-18 14:04:09 +02:00
jekyllbot
2d14125d53 Update history to reflect merge of #7325 [ci skip] 2018-10-18 07:50:47 -04:00
_94gsc
885f76f84e Add a link to Giraffe Academy's tutorial (#7325)
Merge pull request 7325
2018-10-18 07:50:46 -04:00
olivia
8c9dcfee66 add final newline 2018-10-17 15:01:16 +02:00
olivia
42ecb661e4 add footer section for tidelift instead 2018-10-17 14:57:18 +02:00
olivia
bf02c401a3 add tidelift to site sponsors 2018-10-17 12:08:36 +02:00
Frank Taillandier
fd6e01fd6a docs: tweak capture delay [ci-skip]
Screenshots are better now but with Lazyloading it feels really slow. 🐢
Ideally we'd cache and use the former screenshot as placeholder and replace it with the newer version.
2018-10-12 19:32:50 +02:00
Frank Taillandier
77bc82b92f docs: add a bit of delay before capture [ci-skip]
Some images in the showcase show not fully loaded pages. A bit of delay should help.

Documentation: https://docs.capture.techulus.in/docs/screenshot-options
2018-10-12 19:24:49 +02:00
Frank Taillandier
f65bcd9920 docs: update showcase [ci-skip] 2018-10-12 19:11:56 +02:00
olivia hugger
a28fc8531a update my email in the sponsoring post 2018-10-12 19:01:40 +02:00
olivia hugger
5779b29855 fix typo in blank site template 2018-10-12 13:01:38 +02:00
jekyllbot
749415c47f Update history to reflect merge of #7310 [ci skip] 2018-10-12 06:57:47 -04:00
jekyllbot
37baaec83e feat: enhance --blank scaffolding (#7310)
Merge pull request 7310
2018-10-12 06:57:45 -04:00
jekyllbot
1bb7f03e44 Update history to reflect merge of #7312 [ci skip] 2018-10-10 17:15:42 -04:00
XhmikosR
f6f6a5661d Update appveyor.yml (#7312)
Merge pull request 7312
2018-10-10 17:15:41 -04:00
jekyllbot
153f24c4e4 Update history to reflect merge of #7307 [ci skip] 2018-10-09 20:21:40 -04:00
Jordan Morgan
2966b7ff94 "This restricts you..." to "This restricts your" (#7307)
Merge pull request 7307
2018-10-09 20:21:39 -04:00
jekyllbot
5795bf08fb Update history to reflect merge of #7306 [ci skip] 2018-10-09 18:13:26 -04:00
Jordan Morgan
3b4eb69d22 Added missing semicolon (#7306)
Merge pull request 7306
2018-10-09 18:13:24 -04:00
jekyllbot
148ac25190 Update history to reflect merge of #7300 [ci skip] 2018-10-07 04:50:18 -04:00
Preston Lim
51fe430fdd Add Isomer to showcase (#7300)
Merge pull request 7300
2018-10-07 04:50:17 -04:00
jekyllbot
7eca92adf8 Update history to reflect merge of #7299 [ci skip] 2018-10-05 09:43:07 -04:00
argv-minus-one
052dbf8b98 Automatically load _config.toml (#7299)
Merge pull request 7299
2018-10-05 09:43:06 -04:00
jekyllbot
fec13b3d05 Update history to reflect merge of #7136 [ci skip] 2018-10-03 11:29:48 -04:00
Ashwin Maroli
a2d61f976f Optimize rendering Liquid templates (#7136)
Merge pull request 7136
2018-10-03 11:29:45 -04:00
jekyllbot
440374aa4d Update history to reflect merge of #7190 [ci skip] 2018-10-02 07:27:16 -04:00
Pat Hawks
139ea09967 Do not dump undumpable objects (#7190)
Merge pull request 7190
2018-10-02 07:27:15 -04:00
Frank Taillandier
28cb55c455 chore(history): rendered includes are still WIP 2018-10-02 11:36:25 +02:00
Frank Taillandier
1eeb89460e Update History.markdown 2018-10-02 11:19:26 +02:00
jekyllbot
2cd15712c7 Update history to reflect merge of #7108 [ci skip] 2018-10-02 04:55:46 -04:00
jekyllbot
15128418be Update history to reflect merge of #7183 [ci skip] 2018-10-02 04:16:51 -04:00
Pat Hawks
b8dfc9a32f Cache converter in renderer (#7183)
Merge pull request 7183
2018-10-02 04:16:49 -04:00
jekyllbot
0b90e536ab Update history to reflect merge of #7159 [ci skip] 2018-10-02 04:07:09 -04:00
Pat Hawks
18d33b1fd6 Cache converted markdown (#7159)
Merge pull request 7159
2018-10-02 04:07:08 -04:00
jekyllbot
93b5b57aea Update history to reflect merge of #7291 [ci skip] 2018-10-02 03:14:55 -04:00
Andy Alt
517eb749a0 Docs: Add link tag to item in RSS template (#7291)
Merge pull request 7291
2018-10-02 03:14:54 -04:00
jekyllbot
d667f12941 Update history to reflect merge of #7289 [ci skip] 2018-10-01 14:37:17 -04:00
Grzegorz Kaczorek
55dd39d580 Document converter methods (#7289)
Merge pull request 7289
2018-10-01 14:37:15 -04:00
jekyllbot
452c1c88d0 Update history to reflect merge of #7287 [ci skip] 2018-10-01 08:49:33 -04:00
Ashwin Maroli
faed9c4143 Drop support for jekyll-watch-1.4.0 and older (#7287)
Merge pull request 7287
2018-10-01 08:49:31 -04:00
jekyllbot
a70ed3713f Update history to reflect merge of #7285 [ci skip] 2018-09-30 11:03:03 -04:00
jekyllbot
05f109071d Remove default config for markdown (#7285)
Merge pull request 7285
2018-09-30 11:03:02 -04:00
Frank Taillandier
63deec3074 Add links to YAML cheatsheets
Fix #6054
2018-09-30 11:00:57 +02:00
jekyllbot
8dcb14c582 Update history to reflect merge of #7283 [ci skip] 2018-09-29 08:31:29 -04:00
Frank Taillandier
688d0734b8 Docs: more inclusive writing (#7283)
Merge pull request 7283
2018-09-29 08:31:28 -04:00
jekyllbot
94baf09753 Update history to reflect merge of #7282 [ci skip] 2018-09-28 18:43:27 -04:00
Andy Alt
6c6595bd1e tutorial/convert existing site.md/rss:add title tag to item (#7282)
Merge pull request 7282
2018-09-28 18:43:25 -04:00
Frank Taillandier
927a09b4c5 Add latest version for sidebar
props @pathawks
2018-09-28 09:24:22 +02:00
Frank Taillandier
997c9044d5 Thanks @parkr 🙏 2018-09-27 14:54:25 +02:00
Frank Taillandier
4a6edf4778 Typo 2018-09-27 14:47:22 +02:00
jekyllbot
3055992712 Update history to reflect merge of #7259 [ci skip] 2018-09-27 08:38:32 -04:00
Ashwin Maroli
00311d2638 Add Release Post for v3.6.3, v3.7.4 and v3.8.4 (#7259)
Merge pull request 7259
2018-09-27 08:38:30 -04:00
jekyllbot
353574307a Update history to reflect merge of #7118 [ci skip] 2018-09-27 08:29:48 -04:00
Ashwin Maroli
4707017936 Drop support for pygments as syntax-highlighter (#7118)
Merge pull request 7118
2018-09-27 08:29:46 -04:00
jekyllbot
deff194cbf Update history to reflect merge of #7278 [ci skip] 2018-09-26 15:20:53 -04:00
liv
d306ba74e1 update yajl-ruby (#7278)
Merge pull request 7278
2018-09-26 15:20:51 -04:00
jekyllbot
0d2394bdca Update history to reflect merge of #7277 [ci skip] 2018-09-26 10:18:58 -04:00
Ashwin Maroli
57da5c0e29 Check key in collections only if it isn't "posts" (#7277)
Merge pull request 7277
2018-09-26 10:18:57 -04:00
liv
44a8035d13 reorder doc change template 2018-09-24 19:37:46 +02:00
jekyllbot
ec47c9dd9d Update history to reflect merge of #7200 [ci skip] 2018-09-24 13:29:08 -04:00
Maxwell Gerber
b8cf387b71 Fix Contributors link (#7200)
Merge pull request 7200
2018-09-24 13:29:06 -04:00
jekyllbot
3fc1d5b54b Update history to reflect merge of #7182 [ci skip] 2018-09-24 13:27:46 -04:00
Ashwin Maroli
6eee8b7e06 Strip extra slashes via Jekyll.sanitized_path (#7182)
Merge pull request 7182
2018-09-24 13:27:44 -04:00
jekyllbot
ce05f9cb15 Update history to reflect merge of #7010 [ci skip] 2018-09-24 13:26:34 -04:00
Isaac Goodman
81792c29d3 Use OpenSSL instead of GnuTLS (#7010)
Merge pull request 7010
2018-09-24 13:26:32 -04:00
Frank Taillandier
a0c2e65ed7 add issue template for documentation 2018-09-24 18:46:52 +02:00
jekyllbot
4d293d3376 Update history to reflect merge of #7269 [ci skip] 2018-09-24 12:34:34 -04:00
liv
d83d3e880e Add more issue template(s) and pull request template (#7269)
Merge pull request 7269
2018-09-24 12:34:32 -04:00
jekyllbot
1e81243ef8 Update history to reflect merge of #7270 [ci skip] 2018-09-24 12:31:37 -04:00
Grzegorz Kaczorek
8a7ecfce36 Document two methods, simplify one of the methods (#7270)
Merge pull request 7270
2018-09-24 12:31:36 -04:00
jekyllbot
5267e0b215 Update history to reflect merge of #7267 [ci skip] 2018-09-24 12:29:57 -04:00
ikeji
0960ae0755 Ignore permission error of /proc/version (#7267)
Merge pull request 7267
2018-09-24 12:29:55 -04:00
jekyllbot
f043eeabc5 Update history to reflect merge of #7268 [ci skip] 2018-09-23 06:09:37 -04:00
Luis Guillermo Yáñez
e9aa4ff2c1 Update 10-deployment.md (#7268)
Merge pull request 7268
2018-09-23 06:09:36 -04:00
jekyllbot
05fdb6733f Update history to reflect merge of #7266 [ci skip] 2018-09-22 08:51:36 -04:00
Tobias
096afbeee4 environments.md: reference the build command options that allows multiple config files (#7266)
Merge pull request 7266
2018-09-22 08:51:34 -04:00
Frank Taillandier
e59ff78f9d docs: fix path to Ubuntu 2018-09-21 10:33:31 +02:00
Frank Taillandier
879a4c44f6 docs: install dependencies on Debian 2018-09-21 10:30:58 +02:00
Frank Taillandier
47ec61f9b5 docs: Linux, not Ubuntu 2018-09-21 09:14:13 +02:00
jekyllbot
141a7b784b Update history to reflect merge of #7262 [ci skip] 2018-09-20 09:49:41 -04:00
jekyllbot
88dbe5db8a chore(release): reflect latest patched releases (#7262)
Merge pull request 7262
2018-09-20 09:49:39 -04:00
jekyllbot
f692f0999c Update history to reflect merge of #7263 [ci skip] 2018-09-20 09:45:55 -04:00
Ashwin Maroli
88e0472160 Check if scope applies to type before given path (#7263)
Merge pull request 7263
2018-09-20 09:45:53 -04:00
jekyllbot
72dc3a56f3 Update history to reflect merge of #7260 [ci skip] 2018-09-19 14:02:45 -04:00
Jorie Tappa
2e1492da55 Fix a small grammar error/typo in the docs (#7260)
Merge pull request 7260
2018-09-19 14:02:44 -04:00
jekyllbot
1987c36f27 Update history to reflect merge of #7229 [ci skip] 2018-09-19 07:56:17 -04:00
jekyllbot
bd41ebb97b Update history to reflect merge of #6888 [ci skip] 2018-09-19 07:46:41 -04:00
Ashwin Maroli
352133f39b cache matched defaults sets for given parameters (#6888)
Merge pull request 6888
2018-09-19 07:46:39 -04:00
Frank Taillandier
a0dc346e6c Unlock bundler
https://github.com/bundler/bundler/issues/6629 has been fixed
2018-09-19 02:35:41 -07:00
jekyllbot
573c7edbc1 Update history to reflect merge of #7228 [ci skip] 2018-09-18 12:24:17 -04:00
Frank Taillandier
a22cd6d603 Unpublish unreleased Cache API tutorial 2018-09-15 11:44:37 +02:00
Frank Taillandier
cc363657cb Add Kotn website 2018-09-15 11:09:46 +02:00
Frank Taillandier
495456bb3c Note: building from scratch
Fix #7242
2018-09-13 10:54:32 +02:00
jekyllbot
20d0326d30 Update history to reflect merge of #7241 [ci skip] 2018-09-11 18:26:20 -04:00
Stephen Weiss
938b2f1d01 explicit location of where to create blog.html (#7241)
Merge pull request 7241
2018-09-11 18:26:19 -04:00
Frank Taillandier
f9c981e317 Redirects Fixes #7230 2018-09-11 08:42:12 +02:00
jekyllbot
5dedcd5fce Update history to reflect merge of #7238 [ci skip] 2018-09-10 12:19:32 -04:00
Chris Finazzo
74c185c461 Minor grammar fixes (#7238)
Merge pull request 7238
2018-09-10 12:19:30 -04:00
jekyllbot
4271495fca Update history to reflect merge of #7237 [ci skip] 2018-09-09 18:14:48 -04:00
jekyllbot
a28f54a59f Bump Rubocop to v0.59.0 (#7237)
Merge pull request 7237
2018-09-09 18:14:46 -04:00
jekyllbot
6d777a2a21 Update history to reflect merge of #7234 [ci skip] 2018-09-09 17:27:04 -04:00
Stephen Weiss
d6c1216244 clarified front matter requirement (#7234)
Merge pull request 7234
2018-09-09 17:27:02 -04:00
jekyllbot
874ec5c3e2 Update history to reflect merge of #7226 [ci skip] 2018-09-07 15:17:56 -04:00
Parker Moore
f1c87a9129 Security: fix include bypass of EntryFilter#filter symlink check (#7226)
Merge pull request 7226
2018-09-07 15:17:55 -04:00
liv
863a93f9ff update forestry's sponsor url 2018-09-06 13:07:01 +02:00
jekyllbot
27cade4a28 Update history to reflect merge of #7223 [ci skip] 2018-09-06 02:16:21 -04:00
Justin Vallelonga
e56bf80bfc removes quotes from markdown for assets (#7223)
Merge pull request 7223
2018-09-06 02:16:19 -04:00
Frank Taillandier
56dd010c82 Explain the help command 2018-09-05 10:37:24 +02:00
Frank Taillandier
0db83b5008 Update link 2018-09-04 16:50:03 +02:00
jekyllbot
28492e8401 Update history to reflect merge of #7217 [ci skip] 2018-09-03 16:38:14 -04:00
Bilawal Hameed
895e58b01b Add developer.spotify.com to the Jekyll Showcase (#7217)
Merge pull request 7217
2018-09-03 16:38:12 -04:00
Frank Taillandier
7d5479e52f Update showcase.yml 2018-09-03 15:38:40 +02:00
jekyllbot
0b21d67507 Update history to reflect merge of #7215 [ci skip] 2018-09-03 08:18:33 -04:00
Sundaram Kalyan Vedala
93507f02dc Fix minor grammatical error (#7215)
Merge pull request 7215
2018-09-03 08:18:32 -04:00
jekyllbot
8e5c5a4e8a Update history to reflect merge of #7213 [ci skip] 2018-09-03 04:07:12 -04:00
Ashwin Maroli
182327d49c Add cucumber feature to test include_relative tag (#7213)
Merge pull request 7213
2018-09-03 04:07:11 -04:00
jekyllbot
d626fc07c2 Update history to reflect merge of #7214 [ci skip] 2018-09-03 04:05:39 -04:00
Thanos Kolovos
f22425ad2a Add some minor improvements to image loading (#7214)
Merge pull request 7214
2018-09-03 04:05:38 -04:00
jekyllbot
5c61d69c94 Update history to reflect merge of #7211 [ci skip] 2018-09-02 14:01:12 -04:00
Vitor Oliveira
397d289cd2 Refactoring: Fix benchmark code smell (#7211)
Merge pull request 7211
2018-09-02 14:01:11 -04:00
Frank Taillandier
a693153755 Typo 2018-09-02 10:13:43 +02:00
Frank Taillandier
d684e390df jekyll-plugin topic on GitHub 2018-09-02 07:58:09 +02:00
jekyllbot
8c5ee833d4 Update history to reflect merge of #7210 [ci skip] 2018-09-02 01:50:16 -04:00
ninevra
418018a41f Correct stylesheet url in tutorial step 7 (#7210)
Merge pull request 7210
2018-09-02 01:50:14 -04:00
jekyllbot
1e9cd27dc4 Update history to reflect merge of #7205 [ci skip] 2018-09-01 04:39:58 -04:00
Mike Neumegen
805f438f24 New docs (#7205)
Merge pull request 7205
2018-09-01 04:39:57 -04:00
jekyllbot
3aa41a6055 Update history to reflect merge of #7203 [ci skip] 2018-08-29 13:20:55 -04:00
Ashwin Maroli
9f93fd092f Interpolate Jekyll::Page subclass on inspection (#7203)
Merge pull request 7203
2018-08-29 13:20:52 -04:00
jekyllbot
58f10f8e8a Update history to reflect merge of #7198 [ci skip] 2018-08-26 09:50:36 -04:00
Samuel Gruetter
bd9162a3bb installation instructions for Fedora (#7198)
Merge pull request 7198
2018-08-26 09:50:35 -04:00
jekyllbot
d3fba977f7 Update history to reflect merge of #7196 [ci skip] 2018-08-26 07:45:08 -04:00
Ma HongJun
a983bac6ca Resolve "Unable to locate package ruby2.4" error (#7196)
Merge pull request 7196
2018-08-26 07:45:06 -04:00
jekyllbot
5666e42474 Update history to reflect merge of #7199 [ci skip] 2018-08-26 07:38:02 -04:00
Anny
535637ba06 Add missing html end tag for code example in section 'For loops' (#7199)
Merge pull request 7199
2018-08-26 07:38:00 -04:00
jekyllbot
2913ab2891 Update history to reflect merge of #6854 [ci skip] 2018-08-25 06:07:29 -04:00
ExE Boss
9195b61d51 Add support for *.xhtml files (#6854)
Merge pull request 6854
2018-08-25 06:07:28 -04:00
jekyllbot
130292f15e Update history to reflect merge of #7189 [ci skip] 2018-08-21 10:39:33 -04:00
Ashwin Maroli
7f09faa954 Replace regex arg to :gsub with a string arg (#7189)
Merge pull request 7189
2018-08-21 10:39:31 -04:00
jekyllbot
3f62fd96d3 Update history to reflect merge of #7169 [ci skip] 2018-08-21 03:38:54 -04:00
Pat Hawks
24dd9f1457 Add Cache class (#7169)
Merge pull request 7169
2018-08-21 03:38:53 -04:00
jekyllbot
30568ca7b8 Update history to reflect merge of #7184 [ci skip] 2018-08-16 16:30:52 -04:00
Frank Taillandier
7791ad27a2 update .gitignore 2018-08-16 18:06:56 +02:00
liv
61bb9e9626 change team page phrasing 2018-08-15 21:32:12 +02:00
jekyllbot
19a7c1f06a Update history to reflect merge of #7181 [ci skip] 2018-08-14 08:07:21 -04:00
David J. Malan
176489b95c Corrected sample usage of postfiles (#7181)
Merge pull request 7181
2018-08-14 08:07:19 -04:00
jekyllbot
9a9c480831 Update history to reflect merge of #7179 [ci skip] 2018-08-09 06:30:21 -04:00
Victor Afanasev
5ec7324559 Add info how to deploy using pre-push git hook (#7179)
Merge pull request 7179
2018-08-09 06:30:20 -04:00
jekyllbot
4814b45847 Update history to reflect merge of #7173 [ci skip] 2018-08-06 15:02:19 -04:00
Ashwin Maroli
81392ae0ee Output Jekyll Version while debugging (#7173)
Merge pull request 7173
2018-08-06 15:02:17 -04:00
olivia
9136e9c394 add cloudcannon to site sponsors 2018-08-06 18:33:31 +02:00
liv
4d6edb3a26 update sponsor links 2018-08-04 19:38:08 +02:00
olivia
fb7a13ab1e add siteleaf to site sponsors 2018-08-03 13:31:41 +02:00
jekyllbot
87cc350313 Update history to reflect merge of #7168 [ci skip] 2018-08-02 15:05:10 -04:00
Ken Salomon
85be75160c Document TSV as a supported data file format (#7168)
Merge pull request 7168
2018-08-02 15:05:09 -04:00
Frank Taillandier
0ff2ef7d28 Merge pull request #7171 from ashmaroli/codeclimate-badges
Fix links in Code Climate badges
2018-08-02 20:58:26 +02:00
Ashwin Maroli
aaa723373b Fix links in Code Climate badges 2018-08-02 22:30:33 +05:30
liv
ce6173360d revert and manually use sponsor images 2018-08-02 09:24:04 +02:00
liv
b4b90a989c use the correct sponsor embed 2018-08-02 09:22:13 +02:00
liv
edbd9f3028 fix opencollective display in readme 2018-08-01 14:25:41 +02:00
liv
2eb0c5bc8d Merge pull request #7142 from monkeywithacupcake/patch-1
Display Open Collective backers and sponsors
2018-08-01 14:12:13 +02:00
liv
e51f9c346c Merge pull request #7143 from jekyll/sponsor
Prepare docs for sponsoring
2018-08-01 14:11:33 +02:00
liv
f0da10a77a update blog post date 2018-08-01 09:56:40 +02:00
jekyllbot
51629865de Update history to reflect merge of #7158 [ci skip] 2018-07-31 16:12:59 -04:00
Pat Hawks
6e980f3f6a Remove 'cache_dir' during jekyll clean (#7158)
Merge pull request 7158
2018-07-31 16:12:57 -04:00
jekyllbot
37c9347422 Update history to reflect merge of #7163 [ci skip] 2018-07-28 12:22:16 -04:00
Zhang Xiangze
0001895968 Add closing tags for <a> (#7163)
Merge pull request 7163
2018-07-28 12:22:15 -04:00
jekyllbot
d0f8c86d2f Update history to reflect merge of #7162 [ci skip] 2018-07-27 15:17:03 -04:00
Kevin Plattret
493757d7cf Add version badge for date filters with ordinal (#7162)
Merge pull request 7162
2018-07-27 15:17:00 -04:00
Pat Hawks
ef41eeb7d4 Name some of our Travis builds 2018-07-23 13:29:36 -05:00
jekyllbot
fe0a6caa7f Update history to reflect merge of #7146 [ci skip] 2018-07-20 19:22:46 -04:00
Ken Salomon
5701087e7b Do not process Liquid in post excerpt when disabled in front matter (#7146)
Merge pull request 7146
2018-07-20 19:22:44 -04:00
Ashwin Maroli
e9f78247de Merge branch 'master' into sponsor 2018-07-17 22:06:47 +05:30
jekyllbot
02a2f9460a Update history to reflect merge of #7144 [ci skip] 2018-07-17 10:42:12 -04:00
Ashwin Maroli
e61cc513e9 Lock Travis to Bundler-1.16.2 (#7144)
Merge pull request 7144
2018-07-17 10:42:10 -04:00
olivia
477dbb34f4 update with suggestions 2018-07-17 16:04:14 +02:00
olivia
f0e26e9c1a add intentions to post; change title 2018-07-17 15:58:16 +02:00
olivia
9f05275619 Merge branch 'master' into sponsor 2018-07-17 12:20:54 +02:00
olivia
89ac354d5a add blank newline 2018-07-17 12:20:09 +02:00
jess
5c41eb743f Update README.markdown
Hi, I'm making updates for Open Collective. Either you or a supporter signed this repo up for Open Collective. This pull request adds backers and sponsors from your Open Collective https://opencollective.com/jekyll❤️

It adds two badges at the top to show the latest number of backers and sponsors. It also adds placeholders so that the avatar/logo of new backers/sponsors can automatically be shown without having to update your README.md. [more info](https://github.com/opencollective/opencollective/wiki/Github-banner). See how it looks on this [repo](https://github.com/apex/apex#backers).

You can also add a postinstall script to let people know after npm|yarn install that you are welcoming donations (optional). [More info](https://github.com/OpenCollective/opencollective-cli)
You can also add a "Donate" button to your website and automatically show your backers and sponsors there with our widgets. Have a look here: https://opencollective.com/widgets

P.S: As with any pull request, feel free to comment or suggest changes. The only thing "required" are the placeholders on the README because we believe it's important to acknowledge the people in your community that are contributing (financially or with code!).

Thank you for your great contribution to the open source community. You are awesome! 🙌
And welcome to the open collective community! 😊

Come chat with us in the #opensource channel on https://slack.opencollective.com - great place to ask questions and share best practices with other open source sustainers!
2018-07-16 13:06:18 -07:00
jekyllbot
ad9fbeb4b1 Update history to reflect merge of #7140 [ci skip] 2018-07-16 15:04:22 -04:00
Ashwin Maroli
50e0379444 Initialize upgrading doc for v4.0 (#7140)
Merge pull request 7140
2018-07-16 15:04:19 -04:00
Frank Taillandier
c2649ce5fb Merge pull request #7141 from belhassen07/master
Add dev.to link
2018-07-16 17:14:37 +02:00
Frank Taillandier
4cfba70355 Merge branch 'master' into master 2018-07-16 17:14:22 +02:00
Belhassen Chelbi
6802ec93eb Add Dev.to website link 2018-07-16 15:13:26 +01:00
jekyllbot
707e48a412 Update history to reflect merge of #7139 [ci skip] 2018-07-16 09:58:28 -04:00
Belhassen Chelbi
ca2766c2a1 Add DEV Community's Jekyll tag to community page (#7139)
Merge pull request 7139
2018-07-16 09:58:26 -04:00
Belhassen Chelbi
af78a1a568 Add DEV Community's Jekyll tag to community page 2018-07-16 03:17:22 +01:00
jekyllbot
34a1b7aeef Update history to reflect merge of #7138 [ci skip] 2018-07-15 18:18:44 -04:00
104fps
b2c6d03b47 Update docs about post creation (#7138)
Merge pull request 7138
2018-07-15 18:18:43 -04:00
jekyllbot
e49f507e4f Update history to reflect merge of #7134 [ci skip] 2018-07-15 16:11:46 -04:00
Ashwin Maroli
506c764e1e fix incorrectly passed arguments to assert_equal (#7134)
Merge pull request 7134
2018-07-15 16:11:45 -04:00
jekyllbot
16e9820dac Update history to reflect merge of #7133 [ci skip] 2018-07-13 19:48:02 -04:00
Ken Salomon
c7ce7ae054 fix up refute_equal call (#7133)
Merge pull request 7133
2018-07-13 19:48:00 -04:00
jekyllbot
3be9e74942 Update history to reflect merge of #6824 [ci skip] 2018-07-13 12:12:51 -04:00
Pat Hawks
7a4b3fe03d Disable Liquid via front matter (#6824)
Merge pull request 6824
2018-07-13 12:12:49 -04:00
jekyllbot
b69196cad3 Update history to reflect merge of #7132 [ci skip] 2018-07-13 06:33:58 -04:00
Scott Killen
f9ada3ced6 Fix custom 404 page for GitHub pages (#7132)
Merge pull request 7132
2018-07-13 06:33:56 -04:00
jekyllbot
e10444abf7 Update history to reflect merge of #7128 [ci skip] 2018-07-12 10:21:25 -04:00
Ashwin Maroli
9adac3a11e Fix Rubocop offences in test files (#7128)
Merge pull request 7128
2018-07-12 10:21:23 -04:00
jekyllbot
0612542582 Update history to reflect merge of #7125 [ci skip] 2018-07-11 13:32:41 -04:00
jekyllbot
5d1f85928a Use a real theme in the example (#7125)
Merge pull request 7125
2018-07-11 13:32:39 -04:00
jekyllbot
dcbc443387 Update history to reflect merge of #7126 [ci skip] 2018-07-11 10:01:20 -04:00
Jakob Krigovsky
1801793035 Use .markdown for page templates (#7126)
Merge pull request 7126
2018-07-11 10:01:17 -04:00
jekyllbot
0e0960e2c3 Update history to reflect merge of #7127 [ci skip] 2018-07-11 09:14:16 -04:00
Nicolas Hoizey
402ee84abb Add the jekyll-firstimage filter plugin (#7127)
Merge pull request 7127
2018-07-11 09:14:14 -04:00
jekyllbot
5950a7c113 Update history to reflect merge of #7122 [ci skip] 2018-07-09 23:06:56 -04:00
Alex Wood
8846741ed2 Fix #7082 Add call to unused method (#7122)
Merge pull request 7122
2018-07-09 23:06:54 -04:00
jekyllbot
a1ea95d445 Update history to reflect merge of #7114 [ci skip] 2018-07-09 12:12:39 -04:00
Derek Smart
3650baa5db add jekyll-xml-source (#7114)
Merge pull request 7114
2018-07-09 12:12:37 -04:00
Pat Hawks
4c7dbb6915 Fix tests to have "expected value" as the first argument passed to assert_equal (#7104)
* assert_equal(exp, act)

* improve clarity of PageWithoutAFile test

* Hoist invariant out of loop
2018-07-09 11:10:35 -05:00
jekyllbot
c124937e69 Update history to reflect merge of #6608 [ci skip] 2018-07-09 01:25:34 -04:00
Kelly-Ann Green
f4fcfbdaa0 Update item_property to return numbers as numbers instead of strings (#6608)
Merge pull request 6608
2018-07-09 01:25:32 -04:00
jekyllbot
caa0846e7b Update history to reflect merge of #7095 [ci skip] 2018-07-08 14:12:13 -04:00
Alexey Kopytko
d57715031a Instructions to view theme’s files under Linux (#7095)
Merge pull request 7095
2018-07-08 14:12:11 -04:00
jekyllbot
565567ac08 Update history to reflect merge of #7105 [ci skip] 2018-07-08 14:04:43 -04:00
Christian Oliff
385bf36724 Updates to v1.4 (#7105)
Merge pull request 7105
2018-07-08 14:04:41 -04:00
Frank Taillandier
70f4d4908d Fix: Escape Liquid 2018-07-07 13:01:41 +02:00
jekyllbot
bfd58fa949 Update history to reflect merge of #7112 [ci skip] 2018-07-06 14:47:05 -04:00
Boris van Hoytema
43f4fc6c70 GitHub enables you to use themes from other repos (#7112)
Merge pull request 7112
2018-07-06 14:47:03 -04:00
jekyllbot
4d96e4b7bd Update history to reflect merge of #7024 [ci skip] 2018-06-29 15:36:39 -04:00
Tom Harvey
e418d9b2f4 Example of CircleCI deployment through CircleCI v2 (#7024)
Merge pull request 7024
2018-06-29 15:36:37 -04:00
olivia
2dcdc49a36 add sponsoring post 2018-06-28 19:17:50 +02:00
olivia
efb7819d2e add forestry logo 2018-06-28 17:55:29 +02:00
olivia
67331185c2 add sponsor display in website footer 2018-06-26 22:48:26 +02:00
jekyllbot
caae9d2eca Update history to reflect merge of #7078 [ci skip] 2018-06-25 21:43:35 -04:00
Ralph
cb84017bbe Update rubocop version to 0.57.x (#7078)
Merge pull request 7078
2018-06-25 21:43:33 -04:00
jekyllbot
0728ccf08b Update history to reflect merge of #7093 [ci skip] 2018-06-23 16:57:36 -04:00
jekyllbot
0b6962cfe9 Use assert_include (#7093)
Merge pull request 7093
2018-06-23 16:57:35 -04:00
jekyllbot
3204445d6f Update history to reflect merge of #7091 [ci skip] 2018-06-23 09:27:32 -04:00
Steven Westmoreland
76422b03b7 Adding jekyll-info plugin (#7091)
Merge pull request 7091
2018-06-23 09:27:30 -04:00
jekyllbot
76919eea3b Update history to reflect merge of #7089 [ci skip] 2018-06-21 05:25:52 -04:00
Anne Gentle
1d461224dd Update travis-ci.md (#7089)
Merge pull request 7089
2018-06-21 05:25:50 -04:00
jekyllbot
8b63fbed6b Update history to reflect merge of #7086 [ci skip] 2018-06-20 11:43:50 -04:00
Jan Pobořil
f0cbbbb304 Added plugin json-get. (#7086)
Merge pull request 7086
2018-06-20 11:43:48 -04:00
jekyllbot
55ea4c840b Update history to reflect merge of #7066 [ci skip] 2018-06-17 11:36:56 -04:00
jekyllbot
bbc9c99cf9 Remember to release docs gem (#7066)
Merge pull request 7066
2018-06-17 11:36:54 -04:00
Frank Taillandier
6dbf8f469c Merge pull request #7070 from chrisfinazzo/remove-gemnasium
Remove Gemnasium badge
2018-06-12 17:55:34 +02:00
chrisfinazzo
cd996387a5 Remove Gemnasium badge 2018-06-11 22:05:38 -04:00
jekyllbot
baf70295f9 Update history to reflect merge of #7049 [ci skip] 2018-06-05 13:27:04 -04:00
Patrick Favre-Bulle
10b23f7466 Add Hints for some Improved Travis Config in Doc (#7049)
Merge pull request 7049
2018-06-05 13:27:02 -04:00
jekyllbot
e47dad9d20 Update history to reflect merge of #7058 [ci skip] 2018-06-05 12:09:26 -04:00
Stephan Fischer
4baa0093ed [Doc] Fixing a small typo (#7058)
Merge pull request 7058
2018-06-05 12:09:24 -04:00
Frank Taillandier
d7cef0c6db Merge branch 'master' into release-3.8.3 2018-06-05 16:08:49 +02:00
Pat Hawks
4c2c33aefd Merge branch '3.8-stable' into master 2018-06-05 08:31:40 -05:00
Pat Hawks
48e2de862d Release 💎 3.8.3 2018-06-05 08:23:52 -05:00
Pat Hawks
5687a09255 Release 💎 3.8.3 2018-06-04 21:39:43 -05:00
jekyllbot
c6415ce081 Update history to reflect merge of #7046 [ci skip] 2018-06-02 13:56:29 -04:00
Keith Mifsud
0e360623cb Listed the keyll-target-blank plugin in plugins list. (#7046)
Merge pull request 7046
2018-06-02 13:56:27 -04:00
jekyllbot
035ea729ff Update history to reflect merge of #7050 [ci skip] 2018-06-02 06:50:34 -04:00
Frank Taillandier
6c771608e5 Update Rubocop's config (#7050)
Merge pull request 7050
2018-06-02 06:50:32 -04:00
jekyllbot
6805f1c342 Update history to reflect merge of #7044 [ci skip] 2018-05-31 12:13:47 -04:00
Parker Moore
1684905ec7 Allow i18n v0.9.5 and higher (#7044)
Merge pull request 7044
2018-05-31 12:13:45 -04:00
jekyllbot
d64493806c Update history to reflect merge of #7037 [ci skip] 2018-05-24 16:27:59 -04:00
Ali Thompson
e3b325931b Update drafts.md (#7037)
Merge pull request 7037
2018-05-24 16:27:57 -04:00
jekyllbot
a96f846bdb Update history to reflect merge of #7031 [ci skip] 2018-05-21 02:45:05 -04:00
Dan Friedman
97c28f5495 Updated to supported version (#7031)
Merge pull request 7031
2018-05-21 02:45:03 -04:00
jekyllbot
03c252ba4d Update history to reflect merge of #7027 [ci skip] 2018-05-20 11:32:29 -05:00
Philip Belesky
6792ff936c Fix --unpublished not affecting collection documents (#7027)
Merge pull request 7027
2018-05-20 11:31:28 -05:00
jekyllbot
e932a1e27f Update history to reflect merge of #7027 [ci skip] 2018-05-20 12:30:17 -04:00
Philip Belesky
9aec161550 Fix --unpublished not affecting collection documents (#7027)
Merge pull request 7027
2018-05-20 12:30:15 -04:00
jekyllbot
9968df06b3 Update history to reflect merge of #6768 [ci skip] 2018-05-19 15:49:56 -04:00
Ana María Martínez Gómez
bc84603017 Useless privates removed (#6768)
Merge pull request 6768
2018-05-19 15:49:54 -04:00
Pat Hawks
d22b8ee392 Release 💎 3.8.2 2018-05-19 10:30:00 -05:00
Pat Hawks
784f2e2c0d Merge branch '3.8-stable' 2018-05-19 10:30:00 -05:00
jekyllbot
b89efa5d5d Update history to reflect merge of #7016 [ci skip] 2018-05-18 12:38:33 -05:00
Nikita Skalkin
450da91b4b Update rubocop version (#7016)
Merge pull request 7016
2018-05-18 12:34:52 -05:00
jekyllbot
b18872b658 Update history to reflect merge of #7015 [ci skip] 2018-05-18 11:28:46 -05:00
Kyle Barbour
74581422e3 Add whitespace control to LIQUID_TAG_REGEX (#7015)
Merge pull request 7015
2018-05-18 11:27:43 -05:00
jekyllbot
aed72f6464 Update history to reflect merge of #7015 [ci skip] 2018-05-17 18:22:33 -04:00
Kyle Barbour
b915c7577b Add whitespace control to LIQUID_TAG_REGEX (#7015)
Merge pull request 7015
2018-05-17 18:22:32 -04:00
jekyllbot
3bf940b7ee Update history to reflect merge of #7016 [ci skip] 2018-05-15 15:37:08 -04:00
Nikita Skalkin
fbaf591c12 Update rubocop version (#7016)
Merge pull request 7016
2018-05-15 15:37:05 -04:00
liv
007af750f4 Merge pull request #6995 from jekyll/oe-patch-1
Replace individual core team emails with link to team page
2018-05-15 17:39:23 +02:00
jekyllbot
62d297d4a0 Update history to reflect merge of #7011 [ci skip] 2018-05-14 10:05:24 -04:00
Martin Scharm
df0a5f7b0b added the CAT plugin to the plugin list (#7011)
Merge pull request 7011
2018-05-14 10:05:22 -04:00
Ashwin Maroli
8bb98632b4 Merge branch 'master' into oe-patch-1 2018-05-11 12:41:02 +05:30
jekyllbot
5a41149b7b Update history to reflect merge of #7007 [ci skip] 2018-05-10 18:28:40 -04:00
Ashwin Maroli
4f06767ac8 Load Rouge for TestKramdown (#7007)
Merge pull request 7007
2018-05-10 18:28:39 -04:00
Frank Taillandier
c6000597d9 Rephrase sentence 2018-05-10 18:35:18 +02:00
jekyllbot
b63036989a Update history to reflect merge of #7005 [ci skip] 2018-05-10 10:40:55 -04:00
penguinpet
9343d2e6bb proposed change for passive voice. (#7005)
Merge pull request 7005
2018-05-10 10:40:54 -04:00
jekyllbot
5d1823b604 Update history to reflect merge of #6988 [ci skip] 2018-05-09 09:44:38 -04:00
jekyllbot
149d5de59a Remove support for rdiscount (#6988)
Merge pull request 6988
2018-05-09 09:44:36 -04:00
jekyllbot
c2211eec0c Update history to reflect merge of #6985 [ci skip] 2018-05-09 07:52:13 -04:00
Andreas Möller
0b196ebd00 Mention _drafts in custom collections_dir note (#6985)
Merge pull request 6985
2018-05-09 07:52:11 -04:00
jekyllbot
56593bf897 Update history to reflect merge of #7003 [ci skip] 2018-05-09 07:45:21 -04:00
Frank Taillandier
e9b507a0df Textile is only supported through a converter plugin (#7003)
Merge pull request 7003
2018-05-09 07:45:18 -04:00
jekyllbot
a59eaff789 Update history to reflect merge of #7002 [ci skip] 2018-05-09 06:20:25 -04:00
Frank Taillandier
e2d8d3b92f List all static files variables (#7002)
Merge pull request 7002
2018-05-09 06:20:23 -04:00
olivia
66f8e748fe Replace individual core team emails 2018-05-07 19:52:59 +02:00
jekyllbot
0c5b74377b Update history to reflect merge of #6994 [ci skip] 2018-05-07 13:49:56 -04:00
Arjun Thakur
cec17d03f8 Updated nginx configuration for custom-404-page documentation (#6994)
Merge pull request 6994
2018-05-07 13:49:55 -04:00
855 changed files with 101604 additions and 50799 deletions

View File

@@ -1,36 +0,0 @@
engines:
fixme:
enabled: false
rubocop:
enabled: true
channel: rubocop-0-54
exclude_paths:
- .codeclimate.yml
- .gitignore
- .rspec
- .rubocop.yml
- .travis.yml
- Gemfile.lock
- CHANGELOG.{md,markdown,txt,textile}
- CONTRIBUTING.{md,markdown,txt,textile}
- readme.{md,markdown,txt,textile}
- README.{md,markdown,txt,textile}
- Readme.{md,markdown,txt,textile}
- ReadMe.{md,markdown,txt,textile}
- COPYING
- LICENSE
- features/**/*
- script/**/*
- docs/**/*
- spec/**/*
- test/**/*
- vendor/**/*
- lib/jekyll/commands/serve/livereload_assets/livereload.js
ratings:
paths:
- lib/**/*.rb

View File

@@ -1,14 +0,0 @@
# editorconfig.org
root = true
[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false

86
.github/CODEOWNERS vendored
View File

@@ -1,86 +0,0 @@
# The Jekyll project has 6 affinity teams, shown here: https://teams.jekyllrb.com/
# They are as follows:
#
# 1. @jekyll/build
# 2. @jekyll/documentation
# 3. @jekyll/ecosystem
# 4. @jekyll/performance
# 5. @jekyll/stability
# 6. @jekyll/windows
#
# Each of these teams has a mission. Wherever possible, GitHub should
# automatically require review from these teams on the pieces of the
# repository they maintain.
# @jekyll/documentation
/docs/ @jekyll/documentation
# @jekyll/build
/exe/ @jekyll/build
/lib/jekyll.rb @jekyll/build
/lib/jekyll/cleaner.rb @jekyll/build
/lib/jekyll/collection.rb @jekyll/build
/lib/jekyll/command.rb @jekyll/build
/lib/jekyll/commands/ @jekyll/build
/lib/jekyll/converter.rb @jekyll/build
/lib/jekyll/converters/ @jekyll/build
/lib/jekyll/convertible.rb @jekyll/build
/lib/jekyll/document.rb @jekyll/build
/lib/jekyll/drops/ @jekyll/build
/lib/jekyll/entry_filter.rb @jekyll/build
/lib/jekyll/errors.rb @jekyll/build
/lib/jekyll/excerpt.rb @jekyll/build
/lib/jekyll/filters/ @jekyll/build
/lib/jekyll/filters.rb @jekyll/build
/lib/jekyll/layout.rb @jekyll/build
/lib/jekyll/liquid_extensions.rb @jekyll/build
/lib/jekyll/liquid_renderer/ @jekyll/build
/lib/jekyll/liquid_renderer.rb @jekyll/build
/lib/jekyll/log_adapter.rb @jekyll/build
/lib/jekyll/mime.types @jekyll/build
/lib/jekyll/page.rb @jekyll/build
/lib/jekyll/publisher.rb @jekyll/build
/lib/jekyll/reader.rb @jekyll/build
/lib/jekyll/readers/ @jekyll/build
/lib/jekyll/regenerator.rb @jekyll/build
/lib/jekyll/related_posts.rb @jekyll/build
/lib/jekyll/renderer.rb @jekyll/build
/lib/jekyll/site.rb @jekyll/build
/lib/jekyll/static_file.rb @jekyll/build
/lib/jekyll/stevenson.rb @jekyll/build
/lib/jekyll/tags/ @jekyll/build
/lib/jekyll/url.rb @jekyll/build
/lib/jekyll/utils/ @jekyll/build
/lib/jekyll/utils.rb @jekyll/build
# @jekyll/ecosystem
/lib/jekyll/external.rb @jekyll/ecosystem
/lib/jekyll/generator.rb @jekyll/ecosystem
/lib/jekyll/hooks.rb @jekyll/ecosystem
/lib/jekyll/plugin.rb @jekyll/ecosystem
/lib/jekyll/plugin_manager.rb @jekyll/ecosystem
/lib/jekyll/theme.rb @jekyll/ecosystem
/lib/jekyll/theme_builder.rb @jekyll/ecosystem
# @jekyll/stability
Gemfile @jekyll/stability
*.gemspec @jekyll/stability
.travis.yml @jekyll/stability
appveyor.yml @jekyll/stability
/lib/jekyll/configuration.rb @jekyll/stability
/lib/jekyll/deprecator.rb @jekyll/stability
/lib/jekyll/frontmatter_defaults.rb @jekyll/stability
/lib/site_template @jekyll/stability
/lib/theme_template @jekyll/stability
/features/ @jekyll/stability
/test/ @jekyll/stability
# Special cases
.github/ @jekyll/affinity-team-captains
CODE_OF_CONDUCT.markdown @jekyll/affinity-team-captains
History.markdown @jekyll/affinity-team-captains
LICENSE @jekyll/affinity-team-captains # This file should never change.
README.markdown @jekyll/affinity-team-captains
/lib/jekyll/version.rb @jekyll/affinity-team-captains
/rake/ @jekyll/affinity-team-captains
/script/ @jekyll/affinity-team-captains

View File

@@ -1,151 +0,0 @@
# Contributing to Jekyll
Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is an open source project, built one contribution at a time by users like you.
## Where to get help or report a problem
See [the support guidelines](https://jekyllrb.com/docs/support/)
## Ways to contribute
Whether you're a developer, a designer, or just a Jekyll devotee, there are lots of ways to contribute. Here's a few ideas:
* [Install Jekyll on your computer](https://jekyllrb.com/docs/installation/) and kick the tires. Does it work? Does it do what you'd expect? If not, [open an issue](https://github.com/jekyll/jekyll/issues/new) and let us know.
* Comment on some of the project's [open issues](https://github.com/jekyll/jekyll/issues). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?
* Read through [the documentation](https://jekyllrb.com/docs/home/), and click the "improve this page" button, any time you see something confusing, or have a suggestion for something that could be improved.
* Browse through [the Jekyll discussion forum](https://talk.jekyllrb.com/), and lend a hand answering questions. There's a good chance you've already experienced what another user is experiencing.
* Find [an open issue](https://github.com/jekyll/jekyll/issues) (especially [those labeled `help-wanted`](https://github.com/jekyll/jekyll/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted)), and submit a proposed fix. If it's your first pull request, we promise we won't bite, and are glad to answer any questions.
* Help evaluate [open pull requests](https://github.com/jekyll/jekyll/pulls), by testing the changes locally and reviewing what's proposed.
## Submitting a pull request
### Pull requests generally
* The smaller the proposed change, the better. If you'd like to propose two unrelated changes, submit two pull requests.
* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
* Pull requests are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
### Submitting a pull request via github.com
Many small changes can be made entirely through the github.com web interface.
1. Navigate to the file within [`jekyll/jekyll`](https://github.com/jekyll/jekyll) that you'd like to edit.
2. Click the pencil icon in the top right corner to edit the file
3. Make your proposed changes
4. Click "Propose file change"
5. Click "Create pull request"
6. Add a descriptive title and detailed description for your proposed change. The more information the better.
7. Click "Create pull request"
That's it! You'll be automatically subscribed to receive updates as others review your proposed change and provide feedback.
### Submitting a pull request via Git command line
1. Fork the project by clicking "Fork" in the top right corner of [`jekyll/jekyll`](https://github.com/jekyll/jekyll).
2. Clone the repository locally `git clone https://github.com/<you-username>/jekyll`.
3. Create a new, descriptively named branch to contain your change ( `git checkout -b my-awesome-feature` ).
4. Hack away, add tests. Not necessarily in that order.
5. Make sure everything still passes by running `script/cibuild` (see [the tests section](#running-tests-locally) below)
6. Push the branch up ( `git push origin my-awesome-feature` ).
7. Create a pull request by visiting `https://github.com/<your-username>/jekyll` and following the instructions at the top of the screen.
## Proposing updates to the documentation
We want the Jekyll documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking.
### How to submit changes
You can find the documentation for jekyllrb.com in the [docs](https://github.com/jekyll/jekyll/tree/master/docs) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
### Updating FontAwesome iconset for jekyllrb.com
We use a custom version of FontAwesome which contains just the icons we use.
If you ever need to update our documentation with an icon that is not already available in our custom iconset, you'll have to regenerate the iconset using Icomoon's Generator:
1. Go to <https://icomoon.io/app/>.
2. Click `Import Icons` on the top-horizontal-bar and upload the existing `<jekyll>/docs/icomoon-selection.json`.
3. Click `Add Icons from Library..` further down on the page, and add 'Font Awesome'.
4. Select the required icon(s) from the Library (make sure its the 'FontAwesome' library instead of 'IcoMoon-Free' library).
5. Click `Generate Font` on the bottom-horizontal-bar.
6. Inspect the included icons and proceed by clicking `Download`.
7. Extract the font files and adapt the CSS to the paths we use in Jekyll:
- Copy the entire `fonts` directory over and overwrite existing ones at `<jekyll>/docs/`.
- Copy the contents of `selection.json` and overwrite existing content inside `<jekyll>/docs/icomoon-selection.json`.
- Copy the entire `@font-face {}` declaration and only the **new-icon(s)' css declarations** further below, to update the
`<jekyll>/docs/_sass/_font-awesome.scss` sass partial.
- Fix paths in the `@font-face {}` declaration by adding `../` before `fonts/FontAwesome.*` like so:
`('../fonts/Fontawesome.woff?9h6hxj')`.
### Adding plugins
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](https://github.com/jekyll/jekyll/blob/master/docs/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
## Code Contributions
Interesting in submitting a pull request? Awesome. Read on. There's a few common gotchas that we'd love to help you avoid.
### Tests and documentation
Any time you propose a code change, you should also include updates to the documentation and tests within the same pull request.
#### Documentation
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `docs/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
#### Tests
* If you're creating a small fix or patch to an existing feature, a simple test is more than enough. You can usually copy/paste from an existing example in the `tests` folder, but if you need you can find out about our tests suites [Shoulda](https://github.com/thoughtbot/shoulda/tree/master) and [RSpec-Mocks](https://github.com/rspec/rspec-mocks).
* If it's a brand new feature, create a new [Cucumber](https://github.com/cucumber/cucumber/) feature, reusing existing steps where appropriate.
### Code contributions generally
* Jekyll uses the [Rubocop](https://github.com/bbatsov/rubocop) static analyzer to ensure that contributions follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby). Please check your code using `script/fmt` and resolve any errors before pushing your branch.
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
* You can use the command `script/console` to start a REPL to explore the result of
Jekyll's methods. It also provides you with helpful methods to quickly create a
site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console)
## Running tests locally
### Test Dependencies
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
```sh
script/bootstrap
```
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
```sh
script/cibuild
```
If you are only updating a file in `test/`, you can use the command:
```sh
script/test test/blah_test.rb
```
If you are only updating a `.feature` file, you can use the command:
```sh
script/cucumber features/blah.feature
```
Both `script/test` and `script/cucumber` can be run without arguments to
run its entire respective suite.
## A thank you
Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation!

View File

@@ -1,78 +0,0 @@
<!--
Hi! Thanks for considering to file a bug with Jekyll. Please take the time to
answer the basic questions. You can convert `[ ]` into `[x]` to check boxes (or submit
and check.) If there is no need for certain fields like output and redirection, please delete
those headers before submitting. We know not all tickets require those steps.
Otherwise, please try to be as detailed as possible.
If you are unsure this is a bug in Jekyll, or this is a bug caused
by a plugin that isn't directly related to Jekyll, or if this is just
a generic usage question, please consider asking your question at
https://talk.jekyllrb.com where non-bug questions go.
Thanks!
-->
- [ ] I believe this to be a bug, not a question about using Jekyll.
- [ ] I updated to the latest Jekyll (or) if on GitHub Pages to the latest `github-pages`
- [ ] I ran `jekyll doctor` to check my configuration
- [ ] I read the CONTRIBUTION file at https://jekyllrb.com/docs/contributing/
- [ ] This is a feature request.
---
- [ ] I am on (or have tested on) ***macOS*** 10+
- [ ] I am on (or have tested on) ***Debian/Ubuntu*** GNU/Linux
- [ ] I am on (or have tested on) ***Fedora*** GNU/Linux
- [ ] I am on (or have tested on) ***Arch*** GNU/Linux
- [ ] I am on (or have tested on) ***Other*** GNU/Linux
- [ ] I am on (or have tested on) ***Windows*** 10+
<!--
Other GNU/Linux includes Scientific GNU/Linux, CentOS GNU/Linux, and others.
If you are on a minor sub-distro (such as ElementaryOS which does not diverge from
Ubuntu much, please check the parent distro. Kubuntu, Edubuntu, Lubuntu should
also be flagged as Ubuntu as their packages come from upstream Ubuntu.
-->
---
- [ ] I was trying to install.
- [ ] There is a broken Plugin API.
- [ ] I had an error on GitHub Pages, and I have reproduced it locally.
- [ ] I had an error on GitHub Pages, and GitHub Support said it was a Jekyll Bug.
- [ ] I had an error on GitHub Pages and I did not test it locally.
- [ ] I was trying to build.
- [ ] It was another bug.
## My Reproduction Steps
<!--
If this error occurred 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.)
If you have trouble finding your logs, please email support@github.com and
they will happily help you. If you cannot find logs, please try your best to
replicate it locally because we cannot fix a problem if we do not know
exactly what caused it, or within a relatively close distance.
-->
<!--
Insert the steps you took to for this problem to exist. Such as the
directories you created and, the full command you ran, and include any
plugins you have installed, this is very important.
If your steps are complicated, you can also submit a GitHub
repository (please no zips, they will be removed and rejected by maintainers,)
and just supply a command for us to reproduce it ourselves.
-->
## The Output I Wanted
<!--
Insert the output from the command. Alter it as little as you can.
The minimum should be personal information. Though we normally don't log
anything like that so there should be no need to alter it.
-->

View File

@@ -1,20 +0,0 @@
# Jekyll Support
## Getting Help
**Jekyll's issue tracker is not a support forum.**
If you're looking for support for Jekyll, there are a lot of options:
* Read [Jekyll Documentation](https://jekyllrb.com/docs/home/)
* If you have a question about using Jekyll, start a discussion on [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll)
* Chat with Jekyllers &mdash; Join [our Gitter channel](https://gitter.im/jekyll/jekyll) or [our IRC channel on Freenode](irc:irc.freenode.net/jekyll)
There are a bunch of helpful community members on these services that should be willing to point you in the right direction.
## Report a bug
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository &mdash; First [look for the plugin on rubygems](https://rubygems.org/) then click on the `Homepage` link to access the plugin repository.
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
Happy Jekyllin'!

View File

@@ -1,44 +0,0 @@
### 🆕🐥☝ First Timers Only.
This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝
[About First Timers Only](http://www.firsttimersonly.com/).
### 🤔 What you will need to know.
Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.
### 📋 Step by Step
- [ ] 👌 **Join the team**: Add yourself to a Jekyll affinity team.
Go to [teams.jekyllrb.com](https://teams.jekyllrb.com/) and join a team that best fits your interests. Once you click the link to join a team, you will soon receive an email inviting you to join the Jekyll organization.
- [ ] 🙋 **Claim this issue**: Comment below.
Leave a comment that you have claimed this issue.
- [ ] 📝 **Update** the file [$FILENAME]($BRANCH_URL) in the `$REPO` repository (press the little pen Icon) and edit the line as shown below.
```diff
$DIFF
```
- [ ] 💾 **Commit** your changes
- [ ] 🔀 **Start a Pull Request**. There are two ways how you can start a pull request:
1. If you are familiar with the terminal or would like to learn it, [here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github) on how to send a pull request using the terminal.
2. You can [edit files directly in your browser](https://help.github.com/articles/editing-files-in-your-repository/)
- [ ] 🏁 **Done** Ask in comments for a review :)
### 🤔❓ Questions
Leave a comment below!
This issue was created by [First-Timers-Bot](https://github.com/hoodiehq/first-timers-bot).

View File

@@ -1,6 +0,0 @@
repository: jekyll
labels:
- good first issue
- help-wanted
- first-time-only
template: .github/first-timers-issue-template.md

23
.gitignore vendored
View File

@@ -1,23 +0,0 @@
*.gem
*.swp
*~
.DS_Store
.analysis
.bundle/
.byebug_history
.jekyll-metadata
.ruby-gemset
.ruby-version
.sass-cache
/test/source/file_name.txt
/vendor
Gemfile.lock
_site/
bin/
bbin/
coverage
gh-pages/
pkg/
site/_site/
test/dest
tmp/*

View File

@@ -1,3 +0,0 @@
backtrace.mask=true
backtrace.color=true
backtrace.style=mri

View File

@@ -1,191 +0,0 @@
---
require:
- ./rubocop/jekyll
Jekyll/NoPutsAllowed:
Exclude:
- rake/*.rake
AllCops:
TargetRubyVersion: 2.3
Include:
- lib/**/*.rb
Exclude:
- bin/**/*
- exe/**/*
- benchmark/**/*
- script/**/*
- vendor/**/*
- tmp/**/*
Layout/AlignArray:
Enabled: false
Layout/AlignHash:
EnforcedHashRocketStyle: table
Layout/AlignParameters:
Enabled: false
Layout/EmptyLinesAroundAccessModifier:
Enabled: false
Layout/EmptyLinesAroundModuleBody:
Enabled: false
Layout/EndOfLine:
EnforcedStyle: native
Layout/ExtraSpacing:
AllowForAlignment: true
Layout/FirstParameterIndentation:
EnforcedStyle: consistent
Layout/IndentationWidth:
Severity: error
Layout/IndentArray:
EnforcedStyle: consistent
Layout/IndentHash:
EnforcedStyle: consistent
Layout/IndentHeredoc:
Enabled: false
Layout/MultilineMethodCallIndentation:
EnforcedStyle: indented
Layout/MultilineOperationIndentation:
EnforcedStyle: indented
Lint/NestedPercentLiteral:
Exclude:
- test/test_site.rb
Layout/EmptyComment:
Enabled: false
Layout/EndAlignment:
Severity: error
Lint/UnneededRequireStatement:
Enabled: false
Lint/UnreachableCode:
Severity: error
Lint/UselessAccessModifier:
Enabled: false
Lint/Void:
Enabled: false
Metrics/AbcSize:
Max: 21
Metrics/BlockLength:
Exclude:
- test/**/*.rb
- lib/jekyll/configuration.rb
- rake/*.rake
- jekyll.gemspec
Metrics/ClassLength:
Exclude:
- !ruby/regexp /features\/.*.rb$/
- !ruby/regexp /test\/.*.rb$/
Max: 300
Metrics/CyclomaticComplexity:
Max: 9
Metrics/LineLength:
Exclude:
- !ruby/regexp /features\/.*.rb/
- Rakefile
- rake/*.rake
- Gemfile
- jekyll.gemspec
Max: 90
Severity: warning
Metrics/MethodLength:
CountComments: false
Max: 20
Severity: error
Metrics/ModuleLength:
Max: 240
Metrics/ParameterLists:
Max: 4
Metrics/PerceivedComplexity:
Max: 8
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$/
- lib/jekyll/regenerator.rb
Security/YAMLLoad:
Exclude:
- !ruby/regexp /features\/.*.rb/
- !ruby/regexp /test\/.*.rb$/
Style/Alias:
Enabled: false
Style/AndOr:
Severity: error
Style/BracesAroundHashParameters:
Enabled: false
Style/ClassAndModuleChildren:
Enabled: false
Style/FrozenStringLiteralComment:
EnforcedStyle: always
Style/Documentation:
Enabled: false
Exclude:
- !ruby/regexp /features\/.*.rb$/
Style/DoubleNegation:
Enabled: false
Style/FormatStringToken:
Exclude:
- lib/jekyll/utils/ansi.rb
Style/GuardClause:
Enabled: false
Style/HashSyntax:
EnforcedStyle: hash_rockets
Severity: error
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": "{}"
"%Q": "{}"
"%r": "!!"
"%s": "()"
"%w": "()"
"%W": "()"
"%x": "()"
Style/RedundantFreeze:
Enabled: false
Style/RedundantReturn:
Enabled: false
Style/RedundantSelf:
Enabled: false
Style/RegexpLiteral:
EnforcedStyle: percent_r
Style/RescueModifier:
Enabled: false
Style/SafeNavigation:
Enabled: false
Style/SignalException:
EnforcedStyle: only_raise
Style/SingleLineMethods:
Enabled: false
Style/StringLiterals:
EnforcedStyle: double_quotes
Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes
Style/SymbolArray:
Enabled: false
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: consistent_comma
Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: consistent_comma

View File

@@ -1,55 +0,0 @@
bundler_args: --without benchmark:site:development
script: script/cibuild
cache: bundler
language: ruby
sudo: false
rvm:
- &ruby1 2.5.1
- &ruby2 2.4.4
- &ruby3 2.3.7
- &jruby jruby-9.1.16.0
matrix:
include:
- rvm: *ruby1
env: TEST_SUITE=fmt
- rvm: *ruby1
env: TEST_SUITE=default-site
exclude:
- rvm: *jruby
env: TEST_SUITE=cucumber
env:
matrix:
- TEST_SUITE=test
- TEST_SUITE=cucumber
branches:
only:
- master
- themes
- /*-stable/
notifications:
slack:
secure: "\
dNdKk6nahNURIUbO3ULhA09/vTEQjK0fNbgjVjeYPEvROHgQBP1cIP3AJy8aWs8rl5Yyow4Y\
GEilNRzKPz18AsFptVXofpwyqcBxaCfmHP809NX5PHBaadydveLm+TNVao2XeLXSWu+HUNAY\
O1AanCUbJSEyJTju347xCBGzESU=\
"
addons:
code_climate:
repo_token:
secure: "\
mAuvDu+nrzB8dOaLqsublDGt423mGRyZYM3vsrXh4Tf1sT+L1PxsRzU4gLmcV27HtX2Oq9\
DA4vsRURfABU0fIhwYkQuZqEcA3d8TL36BZcGEshG6MQ2AmnYsmFiTcxqV5bmlElHEqQuT\
5SUFXLafgZPBnL0qDwujQcHukID41sE=\
"
# regular test configuration
after_success:
- bundle exec codeclimate-test-reporter
before_install:
- gem update --system
- gem install bundler

128
404.html Normal file
View File

@@ -0,0 +1,128 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
<link type="application/atom+xml" rel="alternate" href="/feed/release.xml" title="Jekyll releases posts" />
<link rel="alternate" type="application/atom+xml" title="Recent commits to Jekylls master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
<link rel="preload" href="/fonts/lato-v14-latin-300.woff2" as="font" type="font/woff2" crossorigin />
<link rel="preload" href="/fonts/lato-v14-latin-700.woff2" as="font" type="font/woff2" crossorigin />
<link rel="preload" href="/css/screen.css" as="style">
<link rel="stylesheet" href="/css/screen.css">
<link rel="icon" type="image/x-icon" href="/favicon.ico">
<!-- Begin Jekyll SEO tag v2.8.0 -->
<title>Jekyll • Simple, blog-aware, static sites | Transform your plain text into static websites and blogs</title>
<meta name="generator" content="Jekyll v4.4.1" />
<meta property="og:title" content="Jekyll • Simple, blog-aware, static sites" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Transform your plain text into static websites and blogs" />
<meta property="og:description" content="Transform your plain text into static websites and blogs" />
<link rel="canonical" href="https://jekyllrb.com/404.html" />
<meta property="og:url" content="https://jekyllrb.com/404.html" />
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
<meta property="og:image" content="https://jekyllrb.com/img/jekyll-og.png" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="twitter:image" content="https://jekyllrb.com/img/jekyll-og.png" />
<meta property="twitter:title" content="Jekyll • Simple, blog-aware, static sites" />
<meta name="twitter:site" content="@jekyllrb" />
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"Transform your plain text into static websites and blogs","headline":"Jekyll • Simple, blog-aware, static sites","image":"https://jekyllrb.com/img/jekyll-og.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"url":"https://jekyllrb.com/404.html"}</script>
<!-- End Jekyll SEO tag -->
<!--[if lt IE 9]>
<script src="/js/html5shiv.min.js"></script>
<script src="/js/respond.min.js"></script>
<![endif]-->
</head>
<body class="wrap">
<header>
<div class="grid">
<div class="unit whole align-center">
<h1>
<a href="/">
<span class="sr-only">Jekyll</span>
<img src="/img/logo-2x.png" width="249" height="115" alt="Jekyll Logo">
</a>
</h1>
</div>
</div>
</header>
<section class="intro">
<div class="grid">
<div class="unit whole align-center">
<p class="first">Huh. It seems that page is<br/>Hyde-ing...</p>
</div>
</div>
</section>
<section class="error">
<div class="grid">
<div class="unit whole align-center">
<p>The resource you requested was not found. Here are some links to help you find your way:</p>
<nav class="main-nav">
<ul>
<li><a href="/">Home</a></li>
<li><a href="/docs/home/">Documentation</a></li>
<li><a href="/news/">News</a></li>
<li><a href="/help/">Help</a></li>
</ul>
</nav>
</div>
</div>
</section>
<script>
/* Creates an anchor element with the given ID and link for the permalink*/
const anchorForId = (id) => {
const anchor = document.createElement("a");
anchor.className = "header-link";
anchor.href = `#${id}`;
anchor.innerHTML = `<span class="sr-only">Permalink</span><i class="fa fa-link" aria-hidden="true"></i>`;
anchor.title = "Permalink";
return anchor;
};
/* Finds all headers of the specified level within the given element, and adds a permalink to each header*/
const linkifyAnchors = (level, containingElement) => {
const headers = Array.from(containingElement.getElementsByTagName(`h${level}`));
headers.forEach((header) => {
if (header.id) {
header.appendChild(anchorForId(header.id));
}
});
};
/* Executes the function when the document is ready */
document.onreadystatechange = () => {
if (document.readyState === "complete") {
const contentBlock = document.getElementsByClassName("docs")[0]
?? document.getElementsByClassName("news")[0];
if (!contentBlock) { return; }
for (let level = 1; level <= 6; level++) {
linkifyAnchors(level, contentBlock);
}
}
};
</script>
<!-- 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.parentNode.insertBefore(l,L)}(window,document,'script','ga');
ga('create', 'UA-50755011-1', 'jekyllrb.com');
ga('send', 'pageview');
</script>
</body>
</html>

View File

View File

@@ -1,49 +0,0 @@
# Code of Conduct
As contributors and maintainers of this project, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free
experience for everyone, regardless of level of experience, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information, such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
By adopting this Code of Conduct, project maintainers commit themselves to
fairly and consistently applying these principles to every aspect of managing
this project. Project maintainers who do not follow or enforce the Code of
Conduct may be permanently removed from the project team.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by opening an issue or contacting a project maintainer. All complaints
will be reviewed and investigated and will result in a response that is deemed
necessary and appropriate to the circumstances. Maintainers are obligated to
maintain confidentiality with regard to the reporter of an incident.
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.3.0, available at
[http://contributor-covenant.org/version/1/3/0/][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/3/0/

99
Gemfile
View File

@@ -1,99 +0,0 @@
# frozen_string_literal: true
source "https://rubygems.org"
gemspec :name => "jekyll"
gem "rake", "~> 12.0"
group :development do
gem "launchy", "~> 2.3"
gem "pry"
unless RUBY_ENGINE == "jruby"
gem "pry-byebug"
end
end
#
group :test do
gem "codeclimate-test-reporter", "~> 1.0.5"
gem "cucumber", "~> 3.0"
gem "httpclient"
gem "jekyll_test_plugin"
gem "jekyll_test_plugin_malicious"
gem "nokogiri", "~> 1.7"
gem "rspec"
gem "rspec-mocks"
gem "rubocop", "~> 0.55.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__)
gem "jruby-openssl" if RUBY_ENGINE == "jruby"
end
#
group :test_legacy do
if RUBY_PLATFORM =~ %r!cygwin!
gem "test-unit"
end
gem "minitest"
gem "minitest-profile"
gem "minitest-reporters"
gem "shoulda"
gem "simplecov"
end
#
group :benchmark do
if ENV["BENCHMARK"]
gem "benchmark-ips"
gem "rbtrace"
gem "ruby-prof"
gem "stackprof"
end
end
#
group :jekyll_optional_dependencies do
gem "coderay", "~> 1.1.0"
gem "jekyll-coffeescript"
gem "jekyll-docs", :path => "../docs" if Dir.exist?("../docs") && ENV["JEKYLL_VERSION"]
gem "jekyll-feed", "~> 0.9"
gem "jekyll-gist"
gem "jekyll-paginate"
gem "jekyll-redirect-from"
gem "kramdown", "~> 1.14"
gem "mime-types", "~> 3.0"
gem "rdoc", "~> 6.0"
gem "tomlrb", "~> 1.2"
platform :ruby, :mswin, :mingw, :x64_mingw do
gem "classifier-reborn", "~> 2.2.0"
gem "liquid-c", "~> 3.0"
gem "pygments.rb", "~> 1.0"
gem "rdiscount", "~> 2.0"
gem "yajl-ruby", "~> 1.3"
end
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem "tzinfo-data", :platforms => [:mingw, :mswin, :x64_mingw, :jruby]
end
#
group :site do
if ENV["PROOF"]
gem "html-proofer", "~> 3.4"
end
gem "jekyll-avatar"
gem "jekyll-mentions"
gem "jekyll-seo-tag"
gem "jekyll-sitemap"
gem "jemoji"
end

File diff suppressed because it is too large Load Diff

21
LICENSE
View File

@@ -1,21 +0,0 @@
The MIT License (MIT)
Copyright (c) 2008-2018 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
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -1,61 +0,0 @@
# [Jekyll](https://jekyllrb.com/)
[![Gem Version](https://img.shields.io/gem/v/jekyll.svg)][ruby-gems]
[![Linux Build Status](https://img.shields.io/travis/jekyll/jekyll/master.svg?label=Linux%20build)][travis]
[![Windows Build status](https://img.shields.io/appveyor/ci/jekyll/jekyll/master.svg?label=Windows%20build)][appveyor]
[![Maintainability](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/maintainability)](codeclimate)
[![Test Coverage](https://api.codeclimate.com/v1/badges/8ba0cb5b17bb9848e128/test_coverage)](coverage)
[![Dependency Status](https://img.shields.io/gemnasium/jekyll/jekyll.svg)][gemnasium]
[![Security](https://hakiri.io/github/jekyll/jekyll/master.svg)][hakiri]
[ruby-gems]: https://rubygems.org/gems/jekyll
[gemnasium]: https://gemnasium.com/jekyll/jekyll
[codeclimate]: https://codeclimate.com/github/jekyll/jekyll
[coverage]: https://codeclimate.com/github/jekyll/jekyll/coverage
[hakiri]: https://hakiri.io/github/jekyll/jekyll/master
[travis]: https://travis-ci.org/jekyll/jekyll
[appveyor]: https://ci.appveyor.com/project/jekyll/jekyll/branch/master
Jekyll is a simple, blog-aware, static site generator perfect for personal, project, or organization sites. Think of it like a file-based CMS, without all the complexity. Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind [GitHub Pages](https://pages.github.com), which you can use to host sites right from your GitHub repositories.
## Philosophy
Jekyll does what you tell it to do — no more, no less. It doesn't try to outsmart users by making bold assumptions, nor does it burden them with needless complexity and configuration. Put simply, Jekyll gets out of your way and allows you to concentrate on what truly matters: your content.
See: https://jekyllrb.com/philosophy
## Having trouble?
See: https://jekyllrb.com/docs/troubleshooting/
## Getting Started
* [Install](https://jekyllrb.com/docs/installation/) the gem
* Read up about its [Usage](https://jekyllrb.com/docs/usage/) and [Configuration](https://jekyllrb.com/docs/configuration/)
* Take a gander at some existing [Sites](https://wiki.github.com/jekyll/jekyll/sites)
* [Fork](https://github.com/jekyll/jekyll/fork) and [Contribute](https://jekyllrb.com/docs/contributing/) your own modifications
* Have questions? Check out our official forum community [Jekyll Talk](https://talk.jekyllrb.com/) or [`#jekyll` on irc.freenode.net](https://botbot.me/freenode/jekyll/)
## Code of Conduct
In order to have a more open and welcoming community, Jekyll adheres to a
[code of conduct](CODE_OF_CONDUCT.markdown) adapted from the Ruby on Rails code of
conduct.
Please adhere to this code of conduct in any interactions you have in the
Jekyll community. It is strictly enforced on all official Jekyll
repositories, websites, and resources. If you encounter someone violating
these terms, please let one of our core team members [Olivia](mailto:olivia@jekyllrb.com?subject=Jekyll%20CoC%20Violation), [Pat](mailto:pat@jekyllrb.com?subject=Jekyll%20CoC%20Violation), [Matt](mailto:matt@jekyllrb.com?subject=Jekyll%20CoC%20Violation) or [Parker](mailto:parker@jekyllrb.com?subject=Jekyll%20CoC%20Violation) know and we will address it as soon as possible.
## Diving In
* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system
* Learn how the [YAML Front Matter](https://jekyllrb.com/docs/frontmatter/) works
* Put information on your site with [Variables](https://jekyllrb.com/docs/variables/)
* Customize the [Permalinks](https://jekyllrb.com/docs/permalinks/) your posts are generated with
* Use the built-in [Liquid Extensions](https://jekyllrb.com/docs/templates/) to make your life easier
* Use custom [Plugins](https://jekyllrb.com/docs/plugins/) to generate content specific to your site
## License
See the [LICENSE](https://github.com/jekyll/jekyll/blob/master/LICENSE) file.

163
Rakefile
View File

@@ -1,163 +0,0 @@
# frozen_string_literal: true
require "rubygems"
require "rake"
require "rdoc"
require "date"
require "yaml"
$LOAD_PATH.unshift File.expand_path("lib", __dir__)
require "jekyll/version"
Dir.glob("rake/**.rake").each { |f| import f }
#############################################################################
#
# Helper functions
#
#############################################################################
def name
"jekyll"
end
def version
Jekyll::VERSION
end
def docs_name
"#{name}-docs"
end
def docs_folder
"docs"
end
def gemspec_file
"#{name}.gemspec"
end
def gem_file
"#{name}-#{Gem::Version.new(version)}.gem"
end
def normalize_bullets(markdown)
markdown.gsub(%r!\n\s{2}\*{1}!, "\n-")
end
def linkify_prs(markdown)
markdown.gsub(%r!(?<\!&)#(\d+)!) do |word|
"[#{word}]({{ site.repository }}/issues/#{word.delete("#")})"
end
end
def linkify(markdown)
linkify_prs(markdown)
end
def liquid_escape(markdown)
markdown.gsub(%r!(`{[{%].+[}%]}`)!, "{% raw %}\\1{% endraw %}")
end
def custom_release_header_anchors(markdown)
header_regexp = %r!^(\d{1,2})\.(\d{1,2})\.(\d{1,2}) \/ \d{4}-\d{2}-\d{2}!
section_regexp = %r!^### \w+ \w+$!
markdown.split(%r!^##\s!).map do |release_notes|
_, major, minor, patch = *release_notes.match(header_regexp)
release_notes
.gsub(header_regexp, "\\0\n{: #v\\1-\\2-\\3}")
.gsub(section_regexp) { |section| "#{section}\n{: ##{slugify(section)}-v#{major}-#{minor}-#{patch}}" }
end.join("\n## ")
end
def slugify(header)
header.delete("#").strip.downcase.gsub(%r!\s+!, "-")
end
def remove_head_from_history(markdown)
index = markdown =~ %r!^##\s+\d+\.\d+\.\d+!
markdown[index..-1]
end
def converted_history(markdown)
remove_head_from_history(
custom_release_header_anchors(
liquid_escape(
linkify(
normalize_bullets(markdown)
)
)
)
)
end
def siteify_file(file, overrides_front_matter = {})
abort "You seem to have misplaced your #{file} file. I can haz?" unless File.exist?(file)
title = begin
File.read(file).match(%r!\A# (.*)$!)[1]
rescue NoMethodError
File.basename(file, ".*").downcase.capitalize
end
slug = File.basename(file, ".markdown").downcase
front_matter = {
"title" => title,
"permalink" => "/docs/#{slug}/",
"note" => "This file is autogenerated. Edit /#{file} instead.",
}.merge(overrides_front_matter)
contents = "#{front_matter.to_yaml}---\n\n#{content_for(file)}"
File.write("#{docs_folder}/_docs/#{slug}.md", contents)
end
def content_for(file)
contents = File.read(file)
case file
when "History.markdown"
converted_history(contents)
else
contents.gsub(%r!\A# .*\n\n?!, "")
end
end
#############################################################################
#
# Standard tasks
#
#############################################################################
multitask :default => [:test, :features]
task :spec => :test
require "rake/testtask"
Rake::TestTask.new(:test) do |test|
test.libs << "lib" << "test"
test.pattern = "test/**/test_*.rb"
test.verbose = true
end
require "rdoc/task"
Rake::RDocTask.new do |rdoc|
rdoc.rdoc_dir = "rdoc"
rdoc.title = "#{name} #{version}"
rdoc.rdoc_files.include("README*")
rdoc.rdoc_files.include("lib/**/*.rb")
end
begin
require "cucumber/rake/task"
Cucumber::Rake::Task.new(:features) do |t|
t.profile = "travis"
end
Cucumber::Rake::Task.new(:"features:html", "Run Cucumber features and produce HTML output") do |t|
t.profile = "html_report"
end
rescue LoadError
desc "Cucumber rake task not available"
task :features do
abort "Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin"
end
end
desc "Open an irb session preloaded with this library"
task :console do
sh "irb -rubygems -r ./lib/#{name}.rb"
end

View File

@@ -1,40 +0,0 @@
version: "{build}"
clone_depth: 10
branches:
only:
- master
- themes
build: off
install:
- SET PATH=C:\Ruby%RUBY_FOLDER_VER%\bin;%PATH%
- bundle install --retry 5 --jobs=%NUMBER_OF_PROCESSORS% --clean --path vendor\bundle
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: "23"
TEST_SUITE: "test"
test_script:
- ruby --version
- gem --version
- bundler --version
- bash ./script/cibuild
cache:
# If one of the files after the right arrow changes, cache will be skipped
- 'vendor\bundle -> appveyor.yml,Gemfile,jekyll.gemspec'

View File

@@ -1,21 +0,0 @@
#!/usr/bin/env ruby
require "liquid"
require "benchmark/ips"
puts "Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
puts "Liquid #{Liquid::VERSION}"
template1 = '{% capture foobar %}foo{{ bar }}{% endcapture %}{{ foo }}{{ foobar }}'
template2 = '{% assign foobar = "foo" | append: bar %}{{ foobar }}'
def render(template)
Liquid::Template.parse(template).render("bar" => "42")
end
puts render(template1)
puts render(template2)
Benchmark.ips do |x|
x.report('capture') { render(template1) }
x.report('assign') { render(template2) }
end

View File

@@ -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

View File

@@ -1,16 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
Benchmark.ips do |x|
path_without_ending_slash = '/some/very/very/long/path/to/a/file/i/like'
x.report('no slash regexp') { path_without_ending_slash =~ /\/$/ }
x.report('no slash end_with?') { path_without_ending_slash.end_with?("/") }
x.report('no slash [-1, 1]') { path_without_ending_slash[-1, 1] == "/" }
end
Benchmark.ips do |x|
path_with_ending_slash = '/some/very/very/long/path/to/a/file/i/like/'
x.report('slash regexp') { path_with_ending_slash =~ /\/$/ }
x.report('slash end_with?') { path_with_ending_slash.end_with?("/") }
x.report('slash [-1, 1]') { path_with_ending_slash[-1, 1] == "/" }
end

View File

@@ -1,54 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
# For this pull request, which changes Page#dir
# https://github.com/jekyll/jekyll/pull/4403
FORWARD_SLASH = '/'.freeze
def pre_pr(url)
url[-1, 1] == FORWARD_SLASH ? url : File.dirname(url)
end
def pr(url)
if url.end_with?(FORWARD_SLASH)
url
else
url_dir = File.dirname(url)
url_dir.end_with?(FORWARD_SLASH) ? url_dir : "#{url_dir}/"
end
end
def envygeeks(url)
return url if url.end_with?(FORWARD_SLASH) || url == FORWARD_SLASH
url = File.dirname(url)
url == FORWARD_SLASH ? url : "#{url}/"
end
# Just a slash
Benchmark.ips do |x|
path = '/'
x.report("pre_pr:#{path}") { pre_pr(path) }
x.report("pr:#{path}") { pr(path) }
x.report("envygeeks:#{path}") { pr(path) }
x.compare!
end
# No trailing slash
Benchmark.ips do |x|
path = '/some/very/very/long/path/to/a/file/i/like'
x.report("pre_pr:#{path}") { pre_pr(path) }
x.report("pr:#{path}") { pr(path) }
x.report("envygeeks:#{path}") { pr(path) }
x.compare!
end
# No trailing slash
Benchmark.ips do |x|
path = '/some/very/very/long/path/to/a/file/i/like/'
x.report("pre_pr:#{path}") { pre_pr(path) }
x.report("pr:#{path}") { pr(path) }
x.report("envygeeks:#{path}") { pr(path) }
x.compare!
end

View File

@@ -1,17 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
enum = (0..50).to_a
nested = enum.map { |i| [i] }
def do_thing(blah)
blah * 1
end
Benchmark.ips do |x|
x.report('.map.flatten with nested arrays') { nested.map { |i| do_thing(i) }.flatten(1) }
x.report('.flat_map with nested arrays') { nested.flat_map { |i| do_thing(i) } }
x.report('.map.flatten with no nested arrays') { enum.map { |i| do_thing(i) }.flatten(1) }
x.report('.flat_map with no nested arrays') { enum.flat_map { |i| do_thing(i) } }
end

View File

@@ -1,10 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
h = {:bar => 'uco'}
Benchmark.ips do |x|
x.report('fetch with no block') { h.fetch(:bar, (0..9).to_a) }
x.report('fetch with a block') { h.fetch(:bar) { (0..9).to_a } }
x.report('brackets with an ||') { h[:bar] || (0..9).to_a }
end

View File

@@ -1,46 +0,0 @@
#!/usr/bin/env ruby
require_relative '../lib/jekyll'
require 'benchmark/ips'
base_directory = Dir.pwd
Benchmark.ips do |x|
#
# Does not include the base_directory
#
x.report('with no questionable path') do
Jekyll.sanitized_path(base_directory, '')
end
x.report('with a single-part questionable path') do
Jekyll.sanitized_path(base_directory, 'thingy')
end
x.report('with a multi-part questionable path') do
Jekyll.sanitized_path(base_directory, 'thingy/in/my/soup')
end
x.report('with a single-part traversal path') do
Jekyll.sanitized_path(base_directory, '../thingy')
end
x.report('with a multi-part traversal path') do
Jekyll.sanitized_path(base_directory, '../thingy/in/my/../../soup')
end
#
# Including the base_directory
#
x.report('with the exact same paths') do
Jekyll.sanitized_path(base_directory, base_directory)
end
x.report('with a single-part absolute path including the base_directory') do
Jekyll.sanitized_path(base_directory, File.join(base_directory, 'thingy'))
end
x.report('with a multi-part absolute path including the base_directory') do
Jekyll.sanitized_path(base_directory, File.join(base_directory, 'thingy/in/my/soup'))
end
x.report('with a single-part traversal path including the base_directory') do
Jekyll.sanitized_path(base_directory, File.join(base_directory, 'thingy/..'))
end
x.report('with a multi-part traversal path including the base_directory') do
Jekyll.sanitized_path(base_directory, File.join('thingy/in/my/../../soup'))
end
end

View File

@@ -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

View File

@@ -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

View File

@@ -1,15 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
def fast
yield
end
def slow(&block)
block.call
end
Benchmark.ips do |x|
x.report('yield') { fast { (0..9).to_a } }
x.report('block.call') { slow { (0..9).to_a } }
end

View File

@@ -1,51 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
# For this pull request, which changes Page#dir
# https://github.com/jekyll/jekyll/pull/4403
CONTENT_CONTAINING = <<-HTML.freeze
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<title>Jemoji</title>
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="stylesheet" href="/css/screen.css">
</head>
<body class="wrap">
<p><img class="emoji" title=":+1:" alt=":+1:" src="https://assets.github.com/images/icons/emoji/unicode/1f44d.png" height="20" width="20" align="absmiddle"></p>
</body>
</html>
HTML
CONTENT_NOT_CONTAINING = <<-HTML.freeze
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="UTF-8">
<title>Jemoji</title>
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="stylesheet" href="/css/screen.css">
</head>
<body class="wrap">
<p><img class="emoji" title=":+1:" alt=":+1:" src="https://assets.github.com/images/icons/emoji/unicode/1f44d.png" height="20" width="20" align="absmiddle"></p>
</body>
</html>
HTML
Benchmark.ips do |x|
x.report("no body include?") { CONTENT_NOT_CONTAINING.include?('<body') }
x.report("no body regexp") { CONTENT_NOT_CONTAINING =~ /<\s*body/ }
x.compare!
end
# No trailing slash
Benchmark.ips do |x|
x.report("with body include?") { CONTENT_CONTAINING.include?('<body') }
x.report("with body regexp") { CONTENT_CONTAINING =~ /<\s*body/ }
x.compare!
end

View File

@@ -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

View File

@@ -1,115 +0,0 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
#
# The Ruby documentation for #sort_by describes what's called a Schwartzian transform:
#
# > A more efficient technique is to cache the sort keys (modification times in this case)
# > before the sort. Perl users often call this approach a Schwartzian transform, after
# > Randal Schwartz. We construct a temporary array, where each element is an array
# > containing our sort key along with the filename. We sort this array, and then extract
# > the filename from the result.
# > This is exactly what sort_by does internally.
#
# The well-documented efficiency of sort_by is a good reason to use it. However, when a property
# does not exist on an item being sorted, it can cause issues (no nil's allowed!)
# In Jekyll::Filters#sort_input, we extract the property in each iteration of #sort,
# which is quite inefficient! How inefficient? This benchmark will tell you just how, and how much
# it can be improved by using the Schwartzian transform. Thanks, Randall!
require 'benchmark/ips'
require 'minitest'
require File.expand_path("../lib/jekyll", __dir__)
def site
@site ||= Jekyll::Site.new(
Jekyll.configuration("source" => File.expand_path("../docs", __dir__))
).tap(&:reset).tap(&:read)
end
def site_docs
site.collections["docs"].docs.dup
end
def sort_by_property_directly(docs, meta_key)
docs.sort! do |apple, orange|
apple_property = apple[meta_key]
orange_property = orange[meta_key]
if !apple_property.nil? && !orange_property.nil?
apple_property <=> orange_property
elsif !apple_property.nil? && orange_property.nil?
-1
elsif apple_property.nil? && !orange_property.nil?
1
else
apple <=> orange
end
end
end
def schwartzian_transform(docs, meta_key)
docs.collect! { |d|
[d[meta_key], d]
}.sort! { |apple, orange|
if !apple[0].nil? && !orange[0].nil?
apple.first <=> orange.first
elsif !apple[0].nil? && orange[0].nil?
-1
elsif apple[0].nil? && !orange[0].nil?
1
else
apple[-1] <=> orange[-1]
end
}.collect! { |d| d[-1] }
end
# Before we test efficiency, do they produce the same output?
class Correctness
include Minitest::Assertions
require "pp"
define_method :mu_pp, &:pretty_inspect
attr_accessor :assertions
def initialize(docs, property)
@assertions = 0
@docs = docs
@property = property
end
def assert!
assert sort_by_property_directly(@docs, @property).is_a?(Array), "sort_by_property_directly must return an array"
assert schwartzian_transform(@docs, @property).is_a?(Array), "schwartzian_transform must return an array"
assert_equal sort_by_property_directly(@docs, @property),
schwartzian_transform(@docs, @property)
puts "Yeah, ok, correctness all checks out for property #{@property.inspect}"
end
end
Correctness.new(site_docs, "redirect_from".freeze).assert!
Correctness.new(site_docs, "title".freeze).assert!
# First, test with a property only a handful of documents have.
Benchmark.ips do |x|
x.config(time: 10, warmup: 5)
x.report('sort_by_property_directly with sparse property') do
sort_by_property_directly(site_docs, "redirect_from".freeze)
end
x.report('schwartzian_transform with sparse property') do
schwartzian_transform(site_docs, "redirect_from".freeze)
end
x.compare!
end
# Next, test with a property they all have.
Benchmark.ips do |x|
x.config(time: 10, warmup: 5)
x.report('sort_by_property_directly with non-sparse property') do
sort_by_property_directly(site_docs, "title".freeze)
end
x.report('schwartzian_transform with non-sparse property') do
schwartzian_transform(site_docs, "title".freeze)
end
x.compare!
end

View File

@@ -1,12 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
Benchmark.ips do |x|
x.report('parallel assignment') do
a, b = 1, 2
end
x.report('multi-line assignment') do
a = 1
b = 2
end
end

View File

@@ -1,9 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
url = "https://jekyllrb.com"
Benchmark.ips do |x|
x.report('+=') { url += '/' }
x.report('<<') { url << '/' }
end

View File

@@ -1,14 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
def str
'http://baruco.org/2014/some-talk-with-some-amount-of-value'
end
Benchmark.ips do |x|
x.report('#tr') { str.tr('some', 'a') }
x.report('#gsub') { str.gsub('some', 'a') }
x.report('#gsub!') { str.gsub!('some', 'a') }
x.report('#sub') { str.sub('some', 'a') }
x.report('#sub!') { str.sub!('some', 'a') }
end

View File

@@ -1,7 +0,0 @@
#!/usr/bin/env ruby
require 'benchmark/ips'
Benchmark.ips do |x|
x.report('block') { (1..100).map { |i| i.to_s } }
x.report('&:to_s') { (1..100).map(&:to_s) }
end

11
conduct/index.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en-US">
<meta charset="utf-8">
<title>Redirecting&hellip;</title>
<link rel="canonical" href="https://jekyllrb.com/docs/conduct/">
<script>location="https://jekyllrb.com/docs/conduct/"</script>
<meta http-equiv="refresh" content="0; url=https://jekyllrb.com/docs/conduct/">
<meta name="robots" content="noindex">
<h1>Redirecting&hellip;</h1>
<a href="https://jekyllrb.com/docs/conduct/">Click here if you are not redirected.</a>
</html>

1
css/screen.css Normal file

File diff suppressed because one or more lines are too long

1
css/screen.css.map Normal file

File diff suppressed because one or more lines are too long

5
docs/.gitignore vendored
View File

@@ -1,5 +0,0 @@
_site/
*.swp
pkg/
test/
.idea/

View File

@@ -1,37 +0,0 @@
---
layout: error
permalink: /404.html
sitemap: false
---
<section class="intro">
<div class="grid">
<div class="unit whole align-center">
<p class="first">Huh. It seems that page is<br/>Hyde-ing...</p>
</div>
</div>
</section>
<section class="error">
<div class="grid">
<div class="unit whole align-center">
<p>The resource you requested was not found. Here are some links to help you find your way:</p>
<nav class="main-nav">
<ul>
<li>
<a href="/">Home</a>
</li>
<li>
<a href="/docs/home/">Documentation</a>
</li>
<li>
<a href="/news/">News</a>
</li>
<li>
<a href="/help/">Help</a>
</li>
</ul>
</nav>
</div>
</div>
</section>

View File

@@ -1,48 +0,0 @@
---
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"
google_analytics_id: UA-50755011-1
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
collections:
docs:
permalink: "/:collection/:path/"
output: true
posts:
permalink: "/news/:year/:month/:day/:title/"
output: true
tutorials:
output: true
defaults:
- scope:
path: _docs
type: docs
values:
layout: docs
- scope:
path: _posts
type: posts
values:
layout: news_item
image: "/img/twitter-card.png"
plugins:
- jekyll-avatar
- jekyll-feed
- jekyll-mentions
- jekyll-redirect-from
- jekyll-seo-tag
- jekyll-sitemap
- jemoji
sass:
style: compressed
exclude:
- ".gitignore"
- CNAME
- icomoon-selection.json
- readme.md

View File

@@ -1,53 +0,0 @@
- title: Getting Started
docs:
- home
- quickstart
- installation
- windows
- usage
- structure
- configuration
- title: Your Content
docs:
- frontmatter
- posts
- drafts
- pages
- static-files
- variables
- collections
- datafiles
- assets
- migrations
- title: Customization
docs:
- templates
- includes
- permalinks
- pagination
- plugins
- themes
- extras
- title: Deployment
docs:
- github-pages
- deployment-methods
- continuous-integration
- title: Miscellaneous
docs:
- troubleshooting
- sites
- resources
- upgrading/0-to-2
- upgrading/2-to-3
- title: Meta
docs:
- contributing
- maintaining
- conduct
- history

View File

@@ -1,167 +0,0 @@
- speaker: Ben Balter
twitter_handle: BenBalter
youtube_id: Z-37y1qaoxc
topic: GitHub Pages behind the scenes
year: 2015
- speaker: Brandon Mathis
twitter_handle: imathis
youtube_id: KS6e4XxY2H4
topic: What the heck is Octopress and why should I care?
year: 2015
- speaker: Brian Rinaldi
twitter_handle: remotesynth
youtube_id: vT7DhK5zbv0
topic: Comparing Jekyll with the Competition
year: 2015
- speaker: Kyle Rush
twitter_handle: kylerush
youtube_id: ia8vsuiXiL0
topic: Meet the Obama Campaign's $250 Million Fundraising Platform
year: 2015
- speaker: Michael Jovel
twitter_handle: mjovel
youtube_id: 8zSHG6XU_xY
topic: Building Living Style Guides with Jekyll
year: 2015
- speaker: Mike Neumegen
twitter_handle: mikeneumegen
youtube_id: NuChR_YdjrI
topic: A CMS for Jekyll
year: 2015
- speaker: Parker Moore
twitter_handle: parkr
youtube_id: y2SbOIQ5nSA
topic: Jekyll 3 and Beyond
year: 2015
- speaker: Tom Preston-Werner
twitter_handle: mojombo
youtube_id: BMve1OCKj6M
topic: Some crazy ideas I have for the future of static sites
year: 2015
- speaker: Allison Zadrozny
twitter_handle: allizad
youtube_id: Rsc0Mmp1qc8
topic: Elasticsearch for Jekyll
year: 2016
- speaker: Amy Johnston
twitter_handle: amybeukenex
youtube_id: HR12JiUI2Zc
topic: Jekyll for Technical Documentation
year: 2016
- speaker: Bud Parr
twitter_handle: budparr
youtube_id: A1nTuNjoNbg
topic: Real World Content Strategy with Jekyll
year: 2016
- speaker: George Phillips
twitter_handle: gphillips_nz
youtube_id: skb_XWABEDc
topic: Building client-editable Jekyll sites
year: 2016
- speaker: Ire Aderinokun
twitter_handle: ireaderinokun
youtube_id: PRKV5IGKF2c
topic: Using Jekyll for Rapid CSS Testing
year: 2016
- speaker: Jon Chan
twitter_handle: JonHMChan
youtube_id: vDeKPs6xpOM
topic: Stack Overflow on Jekyll
year: 2016
- speaker: Julio Faerman
twitter_handle: jmfaerman
youtube_id: SOMonG8Iqak
topic: Jekyll on AWS
year: 2016
- speaker: Katy DeCorah
twitter_handle: katydecorah
youtube_id: s84wFRD8vfE
topic: Unconventional use cases for Jekyll
year: 2016
- speaker: David Darnes
twitter_handle: DavidDarnes
youtube_id: Y4qwpN40Dvg
topic: Doing a lot with a little
year: 2016
- speaker: Ronan Berder
twitter_handle: hunvreus
youtube_id: TteAQq25_Ns
topic: Designing fast websites with Jekyll
year: 2016
- speaker: David Von Lehman
twitter_handle: davidvlsea
youtube_id: wMlPlKCZfEk
topic: Continuous deployment of Jekyll sites powered by Docker
year: 2016
- speaker: David Jones
twitter_handle: d_jones
youtube_id: 4XxYQ7efk0E
topic: Building our agency site with Jekyll
year: 2016
- speaker: Scott Hewitt
twitter_handle: scotthewitt
youtube_id: qSd3pXQaPsE
topic: Jekyll For Every Case
year: 2016
- speaker: Tim Carry
twitter_handle: pixelastic
youtube_id: ivMML1J4ABY
topic: Algolia search on Jekyll sites
year: 2016
- speaker: Nils Borchers
twitter_handle: nilsborchers
youtube_id: DtNMjuv6Rbo
topic: Building a living brand guide with Jekyll and Hologram
year: 2016
- speaker: Mike Neumegen
twitter_handle: mikeneumegen
youtube_id: rJ5EhVmTR7I
topic: Learning resources for the Jekyll community
year: 2016
- speaker: Oliver Pattison
twitter_handle: olivermakes
youtube_id: BIf6oNpGl74
topic: Responsive srcset images with imgix
year: 2016
- speaker: Michael Lee
twitter_handle: michaelsoolee
youtube_id: F4bJRLEvXIc
topic: Jekyll, Your Website's Baseplate
year: 2016
- speaker: Paul Webb
twitter_handle: NetOpWibby
youtube_id: BRB5DgAE5nM
topic: Deploy Jekyll Like A Boss
year: 2016
- speaker: Tom Johnson
twitter_handle: tomjohnson
youtube_id: nq1AUB72GCQ
topic: Overcoming challenges in using Jekyll for documentation projects
year: 2016

View File

@@ -1,13 +0,0 @@
- title: Tutorials
tutorials:
- home
- video-walkthroughs
- navigation
- orderofinterpretation
- custom-404-page
- convert-site-to-jekyll
- using-jekyll-with-bundler
#- title: Another section
# tutorials:
# - sample

View File

@@ -1,93 +0,0 @@
---
title: Assets
permalink: /docs/assets/
---
Jekyll provides built-in support for Sass and can work with CoffeeScript via
a Ruby gem. In order to use them, you must first create a file with the
proper extension name (one of `.sass`, `.scss`, or `.coffee`) and ***start the
file with two lines of triple dashes***, like this:
```sass
---
---
// start content
.my-definition
font-size: 1.2em
```
Jekyll treats these files the same as a regular page, in that the output file
will be placed in the same directory that it came from. For instance, if you
have a file named `css/styles.scss` in your site's source folder, Jekyll
will process it and put it in your site's destination folder under
`css/styles.css`.
<div class="note info">
<h5>Jekyll processes all Liquid filters and tags in asset files</h5>
<p>If you are using <a href="https://mustache.github.io">Mustache</a>
or another JavaScript templating language that conflicts with
the <a href="/docs/templates/">Liquid template syntax</a>, you
will need to place <code>{&#37; raw &#37;}</code> and
<code>{&#37; endraw &#37;}</code> tags around your code.</p>
</div>
## Sass/SCSS
Jekyll allows you to customize your Sass conversion in certain ways.
Place all your partials in your `sass_dir`, which defaults to
`<source>/_sass`. Place your main SCSS or Sass files in the place you want
them to be in the output file, such as `<source>/css`. For an example, take
a look at [this example site using Sass support in Jekyll][example-sass].
If you are using Sass `@import` statements, you'll need to ensure that your
`sass_dir` is set to the base directory that contains your Sass files. You
can do that thusly:
```yaml
sass:
sass_dir: _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
<div class="note info">
<h5>The <code>sass_dir</code> is only used by Sass</h5>
<p>
Note that the <code>sass_dir</code> becomes the load path for Sass imports,
nothing more. This means that Jekyll does not know about these files
directly, so any files here should not contain the YAML Front Matter as
described above nor will they be transformed as described above. This
folder should only contain imports.
</p>
</div>
You may also specify the output style with the `style` option in your
`_config.yml` file:
```yaml
sass:
style: compressed
```
These are passed to Sass, so any output style options Sass supports are valid
here, too.
## Coffeescript
To enable Coffeescript in Jekyll 3.0 and up you must
* Install the `jekyll-coffeescript` gem
* Ensure that your `_config.yml` is up-to-date and includes the following:
```yaml
plugins:
- jekyll-coffeescript
```

View File

@@ -1,55 +0,0 @@
---
title: Code of Conduct
permalink: "/docs/code_of_conduct/"
note: This file is autogenerated. Edit /CODE_OF_CONDUCT.markdown instead.
redirect_from: "/conduct/index.html"
editable: false
---
As contributors and maintainers of this project, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free
experience for everyone, regardless of level of experience, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information, such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
By adopting this Code of Conduct, project maintainers commit themselves to
fairly and consistently applying these principles to every aspect of managing
this project. Project maintainers who do not follow or enforce the Code of
Conduct may be permanently removed from the project team.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by opening an issue or contacting a project maintainer. All complaints
will be reviewed and investigated and will result in a response that is deemed
necessary and appropriate to the circumstances. Maintainers are obligated to
maintain confidentiality with regard to the reporter of an incident.
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.3.0, available at
[http://contributor-covenant.org/version/1/3/0/][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/3/0/

View File

@@ -1,505 +0,0 @@
---
title: Collections
permalink: /docs/collections/
---
Not everything is a post or a page. Maybe you want to document the various
methods in your open source project, members of a team, or talks at a
conference. Collections allow you to define a new type of document that behave
like Pages or Posts do normally, but also have their own unique properties and
namespace.
## Using Collections
To start using collections, follow these 3 steps:
* [Step 1: Tell Jekyll to read in your collection](#step1)
* [Step 2: Add your content](#step2)
* [Step 3: Optionally render your collection's documents into independent files](#step3)
### Step 1: Tell Jekyll to read in your collection {#step1}
Add the following to your site's `_config.yml` file, replacing `my_collection`
with the name of your collection:
```yaml
collections:
- my_collection
```
You can optionally specify metadata for your collection in the configuration:
```yaml
collections:
my_collection:
foo: bar
```
Default attributes can also be set for a collection:
```yaml
defaults:
- scope:
path: ""
type: my_collection
values:
layout: page
```
<div class="note">
<h5>Gather your collections {%- include docs_version_badge.html version="3.7.0" -%}</h5>
<p>You can optionally specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>.</p>
<p>Then Jekyll will look in <code>my_collections/_books</code> for the <code>books</code> collection, and
in <code>my_collections/_recipes</code> for the <code>recipes</code> collection.</p>
</div>
<div class="note warning">
<h5>Be sure to move 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
documents. YAML front matter is processed if the front matter exists, and everything
after the front matter is pushed into the document's `content` attribute. If no YAML front
matter is provided, Jekyll will not generate the file in your collection.
<div class="note info">
<h5>Be sure to name your directories correctly</h5>
<p>
The folder must be named identically to the collection you defined in
your <code>_config.yml</code> file, with the addition of the preceding <code>_</code> character.
</p>
</div>
### Step 3: Optionally render your collection's documents into independent files {#step3}
If you'd like Jekyll to create a public-facing, rendered version of each
document in your collection, set the `output` key to `true` in your collection
metadata in your `_config.yml`:
```yaml
collections:
my_collection:
output: true
```
This will produce a file for each document in the collection.
For example, if you have `_my_collection/some_subdir/some_doc.md`,
it will be rendered using Liquid and the Markdown converter of your
choice and written out to `<dest>/my_collection/some_subdir/some_doc.html`.
If you wish a specific page to be shown when accessing `/my_collection/`,
simply add `permalink: /my_collection/index.html` to a page.
To list items from the collection, on that page or any other, you can use:
{% raw %}
```liquid
{% for item in site.my_collection %}
<h2>{{ item.title }}</h2>
<p>{{ item.description }}</p>
<p><a href="{{ item.url }}">{{ item.title }}</a></p>
{% endfor %}
```
{% endraw %}
<div class="note info">
<h5>Don't forget to add YAML for processing</h5>
<p>
Files in collections that do not have front matter are treated as
<a href="/docs/static-files">static files</a> and simply copied to their
output location without processing.
</p>
</div>
## Configuring permalinks for collections {#permalinks}
If you wish to specify a custom pattern for the URLs where your Collection pages
will reside, you may do so with the [`permalink` property](../permalinks/):
```yaml
collections:
my_collection:
output: true
permalink: /:collection/:name
```
### Examples
For a collection with the following source file structure,
```
_my_collection/
└── some_subdir
└── some_doc.md
```
each of the following `permalink` configurations will produce the document structure shown below it.
* **Default**
Same as `permalink: /:collection/:path`.
```
_site/
├── my_collection
│   └── some_subdir
│   └── some_doc.html
...
```
* `permalink: pretty`
Same as `permalink: /:collection/:path/`.
```
_site/
├── my_collection
│   └── some_subdir
│   └── some_doc
│   └── index.html
...
```
* `permalink: /doc/:path`
```
_site/
├── doc
│   └── some_subdir
│   └── some_doc.html
...
```
* `permalink: /doc/:name`
```
_site/
├── doc
│   └── some_doc.html
...
```
* `permalink: /:name`
```
_site/
├── some_doc.html
...
```
### Template Variables
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>:collection</code></p>
</td>
<td>
<p>Label of the containing collection.</p>
</td>
</tr>
<tr>
<td>
<p><code>:path</code></p>
</td>
<td>
<p>Path to the document relative to the collection's directory.</p>
</td>
</tr>
<tr>
<td>
<p><code>:name</code></p>
</td>
<td>
<p>The document's base filename, with every sequence of spaces
and non-alphanumeric characters replaced by a hyphen.</p>
</td>
</tr>
<tr>
<td>
<p><code>:title</code></p>
</td>
<td>
<p>
The <code>:title</code> template variable will take the
<code>slug</code> <a href="/docs/frontmatter/">front matter</a>
variable value if any is present in the document; if none is
defined then <code>:title</code> will be equivalent to
<code>:name</code>, aka the slug generated from the filename.
</p>
</td>
</tr>
<tr>
<td>
<p><code>:output_ext</code></p>
</td>
<td>
<p>Extension of the output file. (Included by default and usually unnecessary.)</p>
</td>
</tr>
</tbody>
</table>
</div>
## Liquid Attributes
### Collections
Each collection is accessible as a field on the `site` variable. For example, if
you want to access the `albums` collection found in `_albums`, you'd use
`site.albums`.
Each collection is itself an array of documents (e.g., `site.albums` is an array of documents, much like `site.pages` and
`site.posts`). See the table below for how to access attributes of those documents.
The collections are also available under `site.collections`, with the metadata
you specified in your `_config.yml` (if present) and the following information:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>label</code></p>
</td>
<td>
<p>
The name of your collection, e.g. <code>my_collection</code>.
</p>
</td>
</tr>
<tr>
<td>
<p><code>docs</code></p>
</td>
<td>
<p>
An array of <a href="#documents">documents</a>.
</p>
</td>
</tr>
<tr>
<td>
<p><code>files</code></p>
</td>
<td>
<p>
An array of static files in the collection.
</p>
</td>
</tr>
<tr>
<td>
<p><code>relative_directory</code></p>
</td>
<td>
<p>
The path to the collection's source directory, relative to the site
source.
</p>
</td>
</tr>
<tr>
<td>
<p><code>directory</code></p>
</td>
<td>
<p>
The full path to the collections's source directory.
</p>
</td>
</tr>
<tr>
<td>
<p><code>output</code></p>
</td>
<td>
<p>
Whether the collection's documents will be output as individual
files.
</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note info">
<h5>A Hard-Coded Collection</h5>
<p>In addition to any collections you create yourself, the
<code>posts</code> collection is hard-coded into Jekyll. It exists whether
you have a <code>_posts</code> directory or not. This is something to note
when iterating through <code>site.collections</code> as you may need to
filter it out.</p>
<p>You may wish to use filters to find your collection:
<code>{% raw %}{{ site.collections | where: "label", "myCollection" | first }}{% endraw %}</code></p>
</div>
<div class="note info">
<h5>Collections and Time</h5>
<p>Except for documents in hard-coded default collection <code>posts</code>, all documents in collections
you create, are accessible via Liquid irrespective of their assigned date, if any, and therefore renderable.
</p>
<p>However documents are attempted to be written to disk only if the concerned collection
metadata has <code>output: true</code>. Additionally, future-dated documents are only written if
<code>site.future</code> <em>is also true</em>.
</p>
<p>More fine-grained control over documents being written to disk can be exercised by setting
<code>published: false</code> (<em><code>true</code> by default</em>) in the document's front matter.
</p>
</div>
### Documents
In addition to any YAML Front Matter provided in the document's corresponding
file, each document has the following attributes:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>content</code></p>
</td>
<td>
<p>
The (unrendered) content of the document. If no YAML Front Matter is
provided, Jekyll will not generate the file in your collection. If
YAML Front Matter is used, then this is all the contents of the file
after the terminating
`---` of the front matter.
</p>
</td>
</tr>
<tr>
<td>
<p><code>output</code></p>
</td>
<td>
<p>
The rendered output of the document, based on the
<code>content</code>.
</p>
</td>
</tr>
<tr>
<td>
<p><code>path</code></p>
</td>
<td>
<p>
The full path to the document's source file.
</p>
</td>
</tr>
<tr>
<td>
<p><code>relative_path</code></p>
</td>
<td>
<p>
The path to the document's source file relative to the site source.
</p>
</td>
</tr>
<tr>
<td>
<p><code>url</code></p>
</td>
<td>
<p>
The URL of the rendered collection. The file is only written to the destination when the collection to which it belongs has <code>output: true</code> in the site's configuration.
</p>
</td>
</tr>
<tr>
<td>
<p><code>collection</code></p>
</td>
<td>
<p>
The name of the document's collection.
</p>
</td>
</tr>
<tr>
<td>
<p><code>date</code></p>
</td>
<td>
<p>
The date of the document's collection.
</p>
</td>
</tr>
</tbody>
</table>
</div>
## Accessing Collection Attributes
Attributes from the YAML front matter can be accessed as data anywhere in the
site. Using the above example for configuring a collection as `site.albums`,
you might have front matter in an individual file structured as follows (which
must use a supported markup format, and cannot be saved with a `.yaml`
extension):
```yaml
title: "Josquin: Missa De beata virgine and Missa Ave maris stella"
artist: "The Tallis Scholars"
director: "Peter Phillips"
works:
- title: "Missa De beata virgine"
composer: "Josquin des Prez"
tracks:
- title: "Kyrie"
duration: "4:25"
- title: "Gloria"
duration: "9:53"
- title: "Credo"
duration: "9:09"
- title: "Sanctus & Benedictus"
duration: "7:47"
- title: "Agnus Dei I, II & III"
duration: "6:49"
```
Every album in the collection could be listed on a single page with a template:
```liquid
{% raw %}
{% for album in site.albums %}
<h2>{{ album.title }}</h2>
<p>Performed by {{ album.artist }}{% if album.director %}, directed by {{ album.director }}{% endif %}</p>
{% for work in album.works %}
<h3>{{ work.title }}</h3>
<p>Composed by {{ work.composer }}</p>
<ul>
{% for track in work.tracks %}
<li>{{ track.title }} ({{ track.duration }})</li>
{% endfor %}
</ul>
{% endfor %}
{% endfor %}
{% endraw %}
```

View File

@@ -1,55 +0,0 @@
---
title: Code of Conduct
permalink: "/docs/conduct/"
note: This file is autogenerated. Edit /CONDUCT.markdown instead.
redirect_from: "/conduct/index.html"
editable: false
---
As contributors and maintainers of this project, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free
experience for everyone, regardless of level of experience, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information, such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
By adopting this Code of Conduct, project maintainers commit themselves to
fairly and consistently applying these principles to every aspect of managing
this project. Project maintainers who do not follow or enforce the Code of
Conduct may be permanently removed from the project team.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by opening an issue or contacting a project maintainer. All complaints
will be reviewed and investigated and will result in a response that is deemed
necessary and appropriate to the circumstances. Maintainers are obligated to
maintain confidentiality with regard to the reporter of an incident.
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.3.0, available at
[http://contributor-covenant.org/version/1/3/0/][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/3/0/

View File

@@ -1,784 +0,0 @@
---
title: Configuration
permalink: /docs/configuration/
---
Jekyll allows you to concoct your sites in any way you can dream up, and its
thanks to the powerful and flexible configuration options that this is possible.
These options can either be specified in a `_config.yml` file placed in your
sites root directory, or can be specified as flags for the `jekyll` executable
in the terminal.
## Configuration Settings
### Global Configuration
The table below lists the available settings for Jekyll, and the various <code
class="option">options</code> (specified in the configuration file) and <code
class="flag">flags</code> (specified on the command-line) that control them.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Setting</th>
<th>
<span class="option">Options</span> and <span class="flag">Flags</span>
</th>
</tr>
</thead>
<tbody>
<tr class="setting">
<td>
<p class="name"><strong>Site Source</strong></p>
<p class="description">Change the directory where Jekyll will read files</p>
</td>
<td class="align-center">
<p><code class="option">source: DIR</code></p>
<p><code class="flag">-s, --source DIR</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Site Destination</strong></p>
<p class="description">Change the directory where Jekyll will write files</p>
</td>
<td class="align-center">
<p><code class="option">destination: DIR</code></p>
<p><code class="flag">-d, --destination DIR</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Safe</strong></p>
<p class="description">Disable <a href="../plugins/">custom plugins, and ignore symbolic links</a>.</p>
</td>
<td class="align-center">
<p><code class="option">safe: BOOL</code></p>
<p><code class="flag">--safe</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Exclude</strong></p>
<p class="description">
Exclude directories and/or files from the
conversion. These exclusions are relative to the site's
source directory and cannot be outside the source directory.
</p>
</td>
<td class="align-center">
<p><code class="option">exclude: [DIR, FILE, ...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Include</strong></p>
<p class="description">
Force inclusion of directories and/or files in the conversion.
<code>.htaccess</code> is a good example since dotfiles are excluded
by default.
</p>
</td>
<td class="align-center">
<p><code class="option">include: [DIR, FILE, ...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Keep files</strong></p>
<p class="description">
When clobbering the site destination, keep the selected files.
Useful for files that are not generated by jekyll; e.g. files or
assets that are generated by your build tool.
The paths are relative to the <code>destination</code>.
</p>
</td>
<td class="align-center">
<p><code class="option">keep_files: [DIR, FILE, ...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Time Zone</strong></p>
<p class="description">
Set the time zone for site generation. This sets the <code>TZ</code>
environment variable, which Ruby uses to handle time and date
creation and manipulation. Any entry from the
<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.
</p>
</td>
<td class="align-center">
<p><code class="option">timezone: TIMEZONE</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Encoding</strong></p>
<p class="description">
Set the encoding of files by name (only available for Ruby
1.9 or later).
The default value is <code>utf-8</code> starting in 2.0.0,
and <code>nil</code> before 2.0.0, which will yield the Ruby
default of <code>ASCII-8BIT</code>.
Available encodings can be shown by the
command <code>ruby -e 'puts Encoding::list.join("\n")'</code>.
</p>
</td>
<td class="align-center">
<p><code class="option">encoding: ENCODING</code></p>
</td>
</tr>
<tr>
<td>
<p class='name'><strong>Defaults</strong></p>
<p class='description'>
Set defaults for <a href="../frontmatter/" title="YAML Front Matter">YAML Front Matter</a>
variables.
</p>
</td>
<td class='align-center'>
<p>see <a href="#front-matter-defaults" title="details">below</a></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note warning">
<h5>Destination folders are cleaned on site builds</h5>
<p>
The contents of <code>&lt;destination&gt;</code> are automatically
cleaned, by default, when the site is built. Files or folders that are not
created by your site will be removed. Some files could be retained
by specifying them within the <code>&lt;keep_files&gt;</code> configuration directive.
</p>
<p>
Do not use an important location for <code>&lt;destination&gt;</code>; instead, use it as
a staging area and copy files from there to your web server.
</p>
</div>
### Build Command Options
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Setting</th>
<th><span class="option">Options</span> and <span class="flag">Flags</span></th>
</tr>
</thead>
<tbody>
<tr class="setting">
<td>
<p class="name"><strong>Regeneration</strong></p>
<p class="description">Enable auto-regeneration of the site when files are modified.</p>
</td>
<td class="align-center">
<p><code class="flag">-w, --[no-]watch</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Configuration</strong></p>
<p class="description">Specify config files instead of using <code>_config.yml</code> automatically. Settings in later files override settings in earlier files.</p>
</td>
<td class="align-center">
<p><code class="flag">--config FILE1[,FILE2,...]</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Drafts</strong></p>
<p class="description">Process and render draft posts.</p>
</td>
<td class="align-center">
<p><code class="option">show_drafts: BOOL</code></p>
<p><code class="flag">--drafts</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Environment</strong></p>
<p class="description">Use a specific environment value in the build.</p>
</td>
<td class="align-center">
<p><code class="flag">JEKYLL_ENV=production</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Future</strong></p>
<p class="description">Publish posts or collection documents with a future date.</p>
</td>
<td class="align-center">
<p><code class="option">future: BOOL</code></p>
<p><code class="flag">--future</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Unpublished</strong></p>
<p class="description">Render posts that were marked as unpublished.</p>
</td>
<td class="align-center">
<p><code class="option">unpublished: BOOL</code></p>
<p><code class="flag">--unpublished</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>LSI</strong></p>
<p class="description">Produce an index for related posts. Requires the <a href="http://www.classifier-reborn.com/">classifier-reborn</a> plugin.</p>
</td>
<td class="align-center">
<p><code class="option">lsi: BOOL</code></p>
<p><code class="flag">--lsi</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Limit Posts</strong></p>
<p class="description">Limit the number of posts to parse and publish.</p>
</td>
<td class="align-center">
<p><code class="option">limit_posts: NUM</code></p>
<p><code class="flag">--limit_posts NUM</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Force polling</strong></p>
<p class="description">Force watch to use polling.</p>
</td>
<td class="align-center">
<p><code class="flag">--force_polling</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Verbose output</strong></p>
<p class="description">Print verbose output.</p>
</td>
<td class="align-center">
<p><code class="flag">-V, --verbose</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Silence Output</strong></p>
<p class="description">Silence the normal output from Jekyll
during a build</p>
</td>
<td class="align-center">
<p><code class="flag">-q, --quiet</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Incremental build</strong></p>
<p class="description">
Enable the experimental incremental build feature. Incremental build only
re-builds posts and pages that have changed, resulting in significant performance
improvements for large sites, but may also break site generation in certain
cases.
</p>
</td>
<td class="align-center">
<p><code class="option">incremental: BOOL</code></p>
<p><code class="flag">-I, --incremental</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Liquid profiler</strong></p>
<p class="description">
Generate a Liquid rendering profile to help you identify performance bottlenecks.
</p>
</td>
<td class="align-center">
<p><code class="option">profile: BOOL</code></p>
<p><code class="flag">--profile</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Strict Front Matter</strong></p>
<p class="description">
Cause a build to fail if there is a YAML syntax error in a page's front matter.
</p>
</td>
<td class="align-center">
<p><code class="option">strict_front_matter: BOOL</code></p>
<p><code class="flag">--strict_front_matter</code></p>
</td>
</tr>
</tbody>
</table>
</div>
### Serve Command Options
In addition to the options below, the `serve` sub-command can accept any of the options
for the `build` sub-command, which are then applied to the site build which occurs right
before your site is served.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Setting</th>
<th><span class="option">Options</span> and <span class="flag">Flags</span></th>
</tr>
</thead>
<tbody>
<tr class="setting">
<td>
<p class="name"><strong>Local Server Port</strong></p>
<p class="description">Listen on the given port.</p>
</td>
<td class="align-center">
<p><code class="option">port: PORT</code></p>
<p><code class="flag">--port PORT</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Local Server Hostname</strong></p>
<p class="description">Listen at the given hostname.</p>
</td>
<td class="align-center">
<p><code class="option">host: HOSTNAME</code></p>
<p><code class="flag">--host HOSTNAME</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Base URL</strong></p>
<p class="description">Serve the website from the given base URL</p>
</td>
<td class="align-center">
<p><code class="option">baseurl: URL</code></p>
<p><code class="flag">--baseurl URL</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Detach</strong></p>
<p class="description">Detach the server from the terminal</p>
</td>
<td class="align-center">
<p><code class="option">detach: BOOL</code></p>
<p><code class="flag">-B, --detach</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>Skips the initial site build.</strong></p>
<p class="description">Skips the initial site build which occurs before the server is started.</p>
</td>
<td class="align-center">
<p><code class="flag">--skip-initial-build</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>X.509 (SSL) Private Key</strong></p>
<p class="description">SSL Private Key.</p>
</td>
<td class="align-center">
<p><code class="flag">--ssl-key</code></p>
</td>
</tr>
<tr class="setting">
<td>
<p class="name"><strong>X.509 (SSL) Certificate</strong></p>
<p class="description">SSL Public certificate.</p>
</td>
<td class="align-center">
<p><code class="flag">--ssl-cert</code></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note warning">
<h5>Do not use tabs in configuration files</h5>
<p>
This will either lead to parsing errors, or Jekyll will revert to the
default settings. Use spaces instead.
</p>
</div>
## Custom WEBrick Headers
You can provide custom headers for your site by adding them to `_config.yml`
```yaml
# File: _config.yml
webrick:
headers:
My-Header: My-Value
My-Other-Header: My-Other-Value
```
### Defaults
We provide by default `Content-Type` and `Cache-Control` response headers: one
dynamic in order to specify the nature of the data being served, the other
static in order to disable caching so that you don't have to fight with Chrome's
aggressive caching when you are in development mode.
## Specifying a Jekyll environment at build time
In the build (or serve) arguments, you can specify a Jekyll environment and value. The build will then apply this value in any conditional statements in your content.
For example, suppose you set this conditional statement in your code:
```liquid
{% raw %}
{% if jekyll.environment == "production" %}
{% include disqus.html %}
{% endif %}
{% endraw %}
```
When you build your Jekyll site, the content inside the `if` statement won't be run unless you also specify a `production` environment in the build command, like this:
```sh
JEKYLL_ENV=production jekyll build
```
Specifying an environment value allows you to make certain content available only within specific environments.
The default value for `JEKYLL_ENV` is `development`. Therefore if you omit `JEKYLL_ENV` from the build arguments, the default value will be `JEKYLL_ENV=development`. Any content inside `{% raw %}{% if jekyll.environment == "development" %}{% endraw %}` tags will automatically appear in the build.
Your environment values can be anything you want (not just `development` or `production`). Some elements you might want to hide in development environments include Disqus comment forms or Google Analytics. Conversely, you might want to expose an "Edit me in GitHub" button in a development environment but not include it in production environments.
By specifying the option in the build command, you avoid having to change values in your configuration files when moving from one environment to another.
## Front Matter defaults
Using [YAML Front Matter](../frontmatter/) is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter.
Often times, you will find that you are repeating a lot of configuration options. Setting the same layout in each file, adding the same category - or categories - to a post, etc. You can even add custom variables like author names, which might be the same for the majority of posts on your blog.
Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the `defaults` key in the `_config.yml` file in your project's root directory.
The `defaults` key holds an array of scope/values pairs that define what defaults should be set for a particular file path, and optionally, a file type in that path.
Let's say that you want to add a default layout to all pages and posts in your site. You would add this to your `_config.yml` file:
```yaml
defaults:
-
scope:
path: "" # an empty string here means all files in the project
values:
layout: "default"
```
<div class="note info">
<h5>Please stop and rerun `jekyll serve` command.</h5>
<p>
The <code>_config.yml</code> master configuration file contains global configurations
and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
during automatic regeneration are not loaded until the next execution.
</p>
<p>
Note <a href="../datafiles">Data Files</a> are included and reloaded during automatic regeneration.
</p>
</div>
Here, we are scoping the `values` to any file that exists in the path `scope`. Since the path is set as an empty string, it will apply to **all files** in your project. You probably don't want to set a layout on every file in your project - like css files, for example - so you can also specify a `type` value under the `scope` key.
```yaml
defaults:
-
scope:
path: "" # an empty string here means all files in the project
type: "posts" # previously `post` in Jekyll 2.2.
values:
layout: "default"
```
Now, this will only set the layout for files where the type is `posts`.
The different types that are available to you are `pages`, `posts`, `drafts` or any collection in your site. While `type` is optional, you must specify a value for `path` when creating a `scope/values` pair.
As mentioned earlier, you can set multiple scope/values pairs for `defaults`.
```yaml
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "my-site"
-
scope:
path: "projects"
type: "pages" # previously `page` in Jekyll 2.2.
values:
layout: "project" # overrides previous default layout
author: "Mr. Hyde"
```
With these defaults, all pages would use the `my-site` layout. Any html files that exist in the `projects/` folder will use the `project` layout, if it exists. Those files will also have the `page.author` [liquid variable](../variables/) set to `Mr. Hyde`.
```yaml
collections:
my_collection:
output: true
defaults:
-
scope:
path: ""
type: "my_collection" # a collection in your site, in plural form
values:
layout: "default"
```
In this example, the `layout` is set to `default` inside the
[collection](../collections/) with the name `my_collection`.
### Glob patterns in Front Matter defaults
It is also possible to use glob patterns (currently limited to patterns that contain `*`) when matching defaults. For example, it is possible to set specific layout for each `special-page.html` in any subfolder of `section` folder. {%- include docs_version_badge.html version="3.7.0" -%}
```yaml
collections:
my_collection:
output: true
defaults:
-
scope:
path: "section/*/special-page.html"
values:
layout: "specific-layout"
```
<div class="note warning">
<h5>Globbing and Performance</h5>
<p>
Please note that globbing a path is known to have a negative effect on
performance and is currently not optimized, especially on Windows.
Globbing a path will increase your build times in proportion to the size
of the associated collection directory.
</p>
</div>
### Precedence
Jekyll will apply all of the configuration settings you specify in the `defaults` section of your `_config.yml` file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.
You can see that in the second to last example above. First, we set the default page layout to `my-site`. Then, using a more specific path, we set the default layout for pages in the `projects/` path to `project`. This can be done with any value that you would set in the page or post front matter.
Finally, if you set defaults in the site configuration by adding a `defaults` section to your `_config.yml` file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:
```yaml
# In _config.yml
...
defaults:
-
scope:
path: "projects"
type: "pages"
values:
layout: "project"
author: "Mr. Hyde"
category: "project"
...
```
```yaml
# In projects/foo_project.md
---
author: "John Smith"
layout: "foobar"
---
The post text goes here...
```
The `projects/foo_project.md` would have the `layout` set to `foobar` instead
of `project` and the `author` set to `John Smith` instead of `Mr. Hyde` when
the site is built.
## Default Configuration
Jekyll runs with the following configuration options by default. Alternative
settings for these options can be explicitly specified in the configuration
file or on the command-line.
<div class="note warning">
<h5>There are two unsupported kramdown options</h5>
<p>
Please note that both <code>remove_block_html_tags</code> and
<code>remove_span_html_tags</code> are currently unsupported in Jekyll due
to the fact that they are not included within the kramdown HTML converter.
</p>
</div>
```yaml
# Where things are
source: .
destination: ./_site
collections_dir: .
plugins_dir: _plugins
layouts_dir: _layouts
data_dir: _data
includes_dir: _includes
collections:
posts:
output: true
# Handling Reading
safe: false
include: [".htaccess"]
exclude: ["Gemfile", "Gemfile.lock", "node_modules", "vendor/bundle/", "vendor/cache/", "vendor/gems/", "vendor/ruby/"]
keep_files: [".git", ".svn"]
encoding: "utf-8"
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
strict_front_matter: false
# Filtering Content
show_drafts: null
limit_posts: 0
future: false
unpublished: false
# Plugins
whitelist: []
plugins: []
# Conversion
markdown: kramdown
highlighter: rouge
lsi: false
excerpt_separator: "\n\n"
incremental: false
# Serving
detach: false
port: 4000
host: 127.0.0.1
baseurl: "" # does not include hostname
show_dir_listing: false
# Outputting
permalink: date
paginate_path: /page:num
timezone: null
quiet: false
verbose: false
defaults: []
liquid:
error_mode: warn
strict_filters: false
strict_variables: false
# Markdown Processors
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
```
## Liquid Options
Liquid's response to errors can be configured by setting `error_mode`. The
options are
- `lax` --- Ignore all errors.
- `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.
### 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:
```ruby
class Jekyll::Converters::Markdown::MyCustomProcessor
def initialize(config)
require 'funky_markdown'
@config = config
rescue LoadError
STDERR.puts 'You are missing a library required for Markdown. Please run:'
STDERR.puts ' $ [sudo] gem install funky_markdown'
raise FatalException.new("Missing dependency: funky_markdown")
end
def convert(content)
::FunkyMarkdown.new(content).convert
end
end
```
Once you've created your class and have it properly set up either as a plugin
in the `_plugins` folder or as a gem, specify it in your `_config.yml`:
```yaml
markdown: MyCustomProcessor
```
## Incremental Regeneration
<div class="note warning">
<h5>Incremental regeneration is still an experimental feature</h5>
<p>
While incremental regeneration will work for the most common cases, it will
not work correctly in every scenario. Please be extremely cautious when
using the feature, and report any problems not listed below by
<a href="https://github.com/jekyll/jekyll/issues/new">opening an issue on GitHub</a>.
</p>
</div>
Incremental regeneration helps shorten build times by only generating documents
and pages that were updated since the previous build. It does this by keeping
track of both file modification times and inter-document dependencies in the
`.jekyll-metadata` file.
Under the current implementation, incremental regeneration will only generate a
document or page if either it, or one of its dependencies, is modified. Currently,
the only types of dependencies tracked are includes (using the
{% raw %}`{% include %}`{% endraw %} tag) and layouts. This means that plain
references to other documents (for example, the common case of iterating over
`site.posts` in a post listings page) will not be detected as a dependency.
To remedy some of these shortfalls, putting `regenerate: true` in the front-matter
of a document will force Jekyll to regenerate it regardless of whether it has been
modified. Note that this will generate the specified document only; references
to other documents' contents will not work since they won't be re-rendered.
Incremental regeneration can be enabled via the `--incremental` flag (`-I` for
short) from the command-line or by setting `incremental: true` in your
configuration file.

View File

@@ -1,62 +0,0 @@
---
title: "Buddy"
---
[Buddy][buddy-homepage] is a [Docker][docker-homepage]-based CI server that you can set up in 15-20 minutes to build, test, and deploy your Jekyll websites. It supports [GitHub][github-homepage], [Bitbucket][bitbucket-homepage], and [GitLab][gitlab-homepage] repositories, and can be installed on-premises or used in cloud. The following guide will show you how to set up a free environment to build and test your Jekyll project.
[buddy-homepage]: https://buddy.works
[docker-homepage]: https://www.docker.com/
[github-homepage]: https://github.com
[bitbucket-homepage]: https://bitbucket.org/
[gitlab-homepage]: https://gitlab.com
## 1. Getting started
1. Log in at [https://buddy.works][buddy-homepage] with your GitHub/Bitbucket account or email
2. Choose your Git provider and select or push your Jekyll Project
3. Create a new pipeline and set the trigger mode to 'On every push'
4. Add and configure the Jekyll action and save the pipeline
## 2. How it works
Whenever you make a push to the selected branch, the Jekyll action runs `jekyll build` in an isolated [Jekyll Docker image][jekyll-docker-image]. The output is generated to the `/filesystem` directory, and can be further deployed to FTP/SFTP and IaaS services. You can add your own commands, install additional packages, attach services, and run Selenium tests, as well as add other actions down the pipeline, eg. a Slack notification or an SSH script that will restart your server.
![Jekyll Build](https://buddy.works/data/blog/_images/buddyworks-jekyll-small.png)
[jekyll-docker-image]: https://hub.docker.com/r/jekyll/jekyll/
## 3. Using YAML for configuration
If you prefer configuration as code over GUI, you can generate a `buddy.yml` that will create a pipeline with the Jekyll action once you push it to the target branch:
```yaml
- pipeline: "Build and Deploy Jekyll site"
trigger_mode: "ON_EVERY_PUSH"
ref_name: "master"
actions:
- action: "Execute: jekyll build"
type: "BUILD"
docker_image_name: "jekyll/jekyll"
docker_image_tag: "latest"
execute_commands:
- "chown jekyll:jekyll $WORKING_DIR"
- "jekyll build"
```
## 4. Setting up on-premises server
The self-hosted version of Buddy can be installed on any type of server supporting Docker, including [Linux][bw-linux], [Mac][bw-mac], [AWS EC2][bw-aws-ec2], [DigitalOcean][bw-digitalocean], and [Microsoft Azure][bw-azure].
[bw-linux]: https://buddy.works/knowledge/standalone/installation-linux
[bw-mac]: https://buddy.works/knowledge/standalone/installation-mac-osx
[bw-aws-ec2]: https://buddy.works/knowledge/standalone/installation-amazon-ec2
[bw-digitalocean]: https://buddy.works/knowledge/standalone/installation-digitalocean
[bw-azure]: https://buddy.works/knowledge/standalone/installation-azure
## 5. Questions?
This entire guide is open-source. Go ahead and [edit it][jekyll-docs-ci-buddy] if you want to expand it or have a fix or [ask for help][jekyll-help] if you run into trouble and need assistance. Buddy also has an [online community][buddy-forum] for help.
[jekyll-docs-ci-buddy]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md
[jekyll-help]: https://jekyllrb.com/help/
[buddy-forum]: http://forum.buddy.works/

View File

@@ -1,92 +0,0 @@
---
title: "CircleCI"
---
Building, testing, and deploying your Jekyll-generated website can quickly be done with [CircleCI][0], a continuous integration & delivery tool. CircleCI supports [GitHub][1] and [Bitbucket][2], and you can get started for free using an open-source or private repository.
[0]: https://circleci.com/
[1]: https://github.com/
[2]: https://bitbucket.org/
## 1. Follow Your Project on CircleCI
To start building your project on CircleCI, all you need to do is 'follow' your project from CircleCI's website:
1. Visit the 'Add Projects' page: <https://circleci.com/add-projects>
1. From the GitHub or Bitbucket tab on the left, choose a user or organization.
1. Find your project in the list and click 'Build project' on the right.
1. The first build will start on its own. You can start telling CircleCI how to build your project by creating a [circle.yml][3] file in the root of your repository.
[3]: https://circleci.com/docs/configuration/
## 2. Dependencies
The easiest way to manage dependencies for a Jekyll project (with or without CircleCI) is via a [Gemfile][4]. You'd want to have Jekyll, any Jekyll plugins, [HTML Proofer](#html-proofer), and any other gems that you are using in the `Gemfile`. Don't forget to version `Gemfile.lock` as well. Here's an example `Gemfile`:
[4]: http://bundler.io/gemfile.html
```ruby
source 'https://rubygems.org'
ruby '2.4.0'
gem 'jekyll'
gem 'html-proofer'
```
CircleCI detects when `Gemfile` is present is will automatically run `bundle install` for you in the `dependencies` phase.
## 3. Testing
The most basic test that can be run is simply seeing if `jekyll build` actually works. This is a blocker, a dependency if you will, for other tests you might run on the generate site. So we'll run Jekyll, via Bundler, in the `dependencies` phase.
```yaml
dependencies:
post:
- bundle exec jekyll build
```
### HTML Proofer
With your site built, it's useful to run tests to check for valid HTML, broken links, etc. There's a few tools out there but [HTML Proofer][5] is popular amongst Jekyll users. We'll run it in the `test` phase with a few preferred flags. Check out the `html-proofer` [README][6] for all available flags, or run `htmlproofer --help` locally.
[5]: https://github.com/gjtorikian/html-proofer
[6]: https://github.com/gjtorikian/html-proofer/blob/master/README.md#configuration
```yaml
test:
post:
- bundle exec htmlproofer ./_site --check-html --disable-external
```
## Complete Example circle.yml File
When you put it all together, here's an example of what that `circle.yml` file could look like:
```yaml
machine:
environment:
NOKOGIRI_USE_SYSTEM_LIBRARIES: true # speeds up installation of html-proofer
dependencies:
post:
- bundle exec jekyll build
test:
post:
- bundle exec htmlproofer ./_site --allow-hash-href --check-favicon --check-html --disable-external
deployment:
prod:
branch: master
commands:
- rsync -va --delete ./_site username@my-website:/var/html
```
## Questions?
This entire guide is open-source. Go ahead and [edit it][7] if you have a fix or [ask for help][8] if you run into trouble and need some help. CircleCI also has an [online community][9] for help.
[7]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/circleci.md
[8]: https://jekyllrb.com/help/
[9]: https://discuss.circleci.com

View File

@@ -1,10 +0,0 @@
---
title: Continuous Integration
permalink: /docs/continuous-integration/
---
Continuous Integration (CI) enables you to publish your Jekyll generated website with confidence by automating the quality assurance and deployment processes. You can quickly get started using CI with one of the providers below:
* [Travis CI](travis-ci)
* [CircleCI](circleci)
* [Buddy](buddyworks)

View File

@@ -1,229 +0,0 @@
---
title: "Travis CI"
---
You can easily test your website build against one or more versions of Ruby.
The following guide will show you how to set up a free build environment on
[Travis][travis], with [GitHub][github] integration for pull requests.
[travis]: https://travis-ci.org/
[github]: https://github.com/
## 1. Enabling Travis and GitHub
Enabling Travis builds for your GitHub repository is pretty simple:
1. Go to your profile on travis-ci.org: https://travis-ci.org/profile/username
2. Find the repository for which you're interested in enabling builds.
3. Flick the repository switch on so that it turns blue.
4. Optionally configure the build by clicking on the gear icon. Further
configuration happens via your `.travis.yml` file. More details below.
## 2. The Test Script
The simplest test script simply runs `jekyll build` and ensures that Jekyll
doesn't fail to build the site. It doesn't check the resulting site, but it
does ensure things are built properly.
When testing Jekyll output, there is no better tool than [html-proofer][html-proofer].
This tool checks your resulting site to ensure all links and images exist.
Utilize it either with the convenient `htmlproofer` command-line executable,
or write a Ruby script which utilizes the gem.
Save the commands you want to run and succeed in a file: `./script/cibuild`
### The HTML Proofer Executable
```sh
#!/usr/bin/env bash
set -e # halt script on error
bundle exec jekyll build
bundle exec htmlproofer ./_site
```
Some options can be specified via command-line switches. Check out the
`html-proofer` README for more information about these switches, or run
`htmlproofer --help` locally.
For example to avoid testing external sites, use this command:
```sh
bundle exec htmlproofer ./_site --disable-external
```
### The HTML Proofer Library
You can also invoke `html-proofer` in Ruby scripts (e.g. in a Rakefile):
```ruby
#!/usr/bin/env ruby
require 'html-proofer'
HTMLProofer.check_directory("./_site").run
```
Options are given as a second argument to `.new`, and are encoded in a
symbol-keyed Ruby Hash. For more information about the configuration options,
check out `html-proofer`'s README file.
[html-proofer]: https://github.com/gjtorikian/html-proofer
## 3. Configuring Your Travis Builds
This file is used to configure your Travis builds. Because Jekyll is built
with Ruby and requires RubyGems to install, we use the Ruby language build
environment. Below is a sample `.travis.yml` file, followed by
an explanation of each line.
**Note:** You will need a Gemfile as well, [Travis will automatically install](https://docs.travis-ci.com/user/languages/ruby/#Dependency-Management) the dependencies based on the referenced gems:
```ruby
source "https://rubygems.org"
gem "jekyll"
gem "html-proofer"
```
Your `.travis.yml` file should look like this:
```yaml
language: ruby
rvm:
- 2.3.3
before_script:
- chmod +x ./script/cibuild # or do this locally and commit
# Assume bundler is being used, therefore
# the `install` step will run `bundle install` by default.
script: ./script/cibuild
# branch whitelist, only for GitHub Pages
branches:
only:
- gh-pages # test the gh-pages branch
- /pages-(.*)/ # test every branch which starts with "pages-"
env:
global:
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
sudo: false # route your build to the container-based infrastructure for a faster build
```
Ok, now for an explanation of each line:
```yaml
language: ruby
```
This line tells Travis to use a Ruby build container. It gives your script
access to Bundler, RubyGems, and a Ruby runtime.
```yaml
rvm:
- 2.3.3
```
RVM is a popular Ruby Version Manager (like rbenv, chruby, etc). This
directive tells Travis the Ruby version to use when running your test
script.
```yaml
before_script:
- chmod +x ./script/cibuild
```
The build script file needs to have the *executable* attribute set or
Travis will fail with a permission denied error. You can also run this
locally and commit the permissions directly, thus rendering this step
irrelevant.
```yaml
script: ./script/cibuild
```
Travis allows you to run any arbitrary shell script to test your site. One
convention is to put all scripts for your project in the `script`
directory, and to call your test script `cibuild`. This line is completely
customizable. If your script won't change much, you can write your test
incantation here directly:
```yaml
install: gem install jekyll html-proofer
script: jekyll build && htmlproofer ./_site
```
The `script` directive can be absolutely any valid shell command.
```yaml
# branch whitelist, only for GitHub Pages
branches:
only:
- gh-pages # test the gh-pages branch
- /pages-(.*)/ # test every branch which starts with "pages-"
```
You want to ensure the Travis builds for your site are being run only on
the branch or branches which contain your site. One means of ensuring this
isolation is including a branch whitelist in your Travis configuration
file. By specifying the `gh-pages` branch, you will ensure the associated
test script (discussed above) is only executed on site branches. If you use
a pull request flow for proposing changes, you may wish to enforce a
convention for your builds such that all branches containing edits are
prefixed, exemplified above with the `/pages-(.*)/` regular expression.
The `branches` directive is completely optional. Travis will build from every
push to any branch of your repo if leave it out.
```yaml
env:
global:
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
```
Using `html-proofer`? You'll want this environment variable. Nokogiri, used
to parse HTML files in your compiled site, comes bundled with libraries
which it must compile each time it is installed. Luckily, you can
dramatically decrease the install time of Nokogiri by setting the
environment variable `NOKOGIRI_USE_SYSTEM_LIBRARIES` to `true`.
<div class="note warning">
<h5>Be sure to exclude <code>vendor</code> from your
<code>_config.yml</code></h5>
<p>Travis bundles all gems in the <code>vendor</code> directory on its build
servers, which Jekyll will mistakenly read and explode on.</p>
</div>
```yaml
exclude: [vendor]
```
By default you should supply the `sudo: false` command to Travis. This command
explicitly tells Travis to run your build on Travis's [container-based
infrastructure](https://docs.travis-ci.com/user/workers/container-based-infrastructure/#Routing-your-build-to-container-based-infrastructure). Running on the container-based infrastructure can often times
speed up your build. If you have any trouble with your build, or if your build
does need `sudo` access, modify the line to `sudo: required`.
```yaml
sudo: false
```
### Troubleshooting
**Travis error:** *"You are trying to install in deployment mode after changing
your Gemfile. Run bundle install elsewhere and add the updated Gemfile.lock
to version control."*
**Workaround:** Either run `bundle install` locally and commit your changes to
`Gemfile.lock`, or remove the `Gemfile.lock` file from your repository and add
an entry in the `.gitignore` file to avoid it from being checked in again.
### Questions?
This entire guide is open-source. Go ahead and [edit it][3] if you have a
fix or [ask for help][4] if you run into trouble and need some help.
[3]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/travis-ci.md
[4]: https://jekyllrb.com/help/

View File

@@ -1,155 +0,0 @@
---
title: Contributing
permalink: "/docs/contributing/"
note: This file is autogenerated. Edit /.github/CONTRIBUTING.markdown instead.
---
Hi there! Interested in contributing to Jekyll? We'd love your help. Jekyll is an open source project, built one contribution at a time by users like you.
## Where to get help or report a problem
See [the support guidelines](https://jekyllrb.com/docs/support/)
## Ways to contribute
Whether you're a developer, a designer, or just a Jekyll devotee, there are lots of ways to contribute. Here's a few ideas:
* [Install Jekyll on your computer](https://jekyllrb.com/docs/installation/) and kick the tires. Does it work? Does it do what you'd expect? If not, [open an issue](https://github.com/jekyll/jekyll/issues/new) and let us know.
* Comment on some of the project's [open issues](https://github.com/jekyll/jekyll/issues). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?
* Read through [the documentation](https://jekyllrb.com/docs/home/), and click the "improve this page" button, any time you see something confusing, or have a suggestion for something that could be improved.
* Browse through [the Jekyll discussion forum](https://talk.jekyllrb.com/), and lend a hand answering questions. There's a good chance you've already experienced what another user is experiencing.
* Find [an open issue](https://github.com/jekyll/jekyll/issues) (especially [those labeled `help-wanted`](https://github.com/jekyll/jekyll/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted)), and submit a proposed fix. If it's your first pull request, we promise we won't bite, and are glad to answer any questions.
* Help evaluate [open pull requests](https://github.com/jekyll/jekyll/pulls), by testing the changes locally and reviewing what's proposed.
## Submitting a pull request
### Pull requests generally
* The smaller the proposed change, the better. If you'd like to propose two unrelated changes, submit two pull requests.
* The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
* Pull requests are easy and fun. If this is your first pull request, it may help to [understand GitHub Flow](https://guides.github.com/introduction/flow/).
* If you're submitting a code contribution, be sure to read the [code contributions](#code-contributions) section below.
### Submitting a pull request via github.com
Many small changes can be made entirely through the github.com web interface.
1. Navigate to the file within [`jekyll/jekyll`](https://github.com/jekyll/jekyll) that you'd like to edit.
2. Click the pencil icon in the top right corner to edit the file
3. Make your proposed changes
4. Click "Propose file change"
5. Click "Create pull request"
6. Add a descriptive title and detailed description for your proposed change. The more information the better.
7. Click "Create pull request"
That's it! You'll be automatically subscribed to receive updates as others review your proposed change and provide feedback.
### Submitting a pull request via Git command line
1. Fork the project by clicking "Fork" in the top right corner of [`jekyll/jekyll`](https://github.com/jekyll/jekyll).
2. Clone the repository locally `git clone https://github.com/<you-username>/jekyll`.
3. Create a new, descriptively named branch to contain your change ( `git checkout -b my-awesome-feature` ).
4. Hack away, add tests. Not necessarily in that order.
5. Make sure everything still passes by running `script/cibuild` (see [the tests section](#running-tests-locally) below)
6. Push the branch up ( `git push origin my-awesome-feature` ).
7. Create a pull request by visiting `https://github.com/<your-username>/jekyll` and following the instructions at the top of the screen.
## Proposing updates to the documentation
We want the Jekyll documentation to be the best it can be. We've open-sourced our docs and we welcome any pull requests if you find it lacking.
### How to submit changes
You can find the documentation for jekyllrb.com in the [docs](https://github.com/jekyll/jekyll/tree/master/docs) directory. See the section above, [submitting a pull request](#submitting-a-pull-request) for information on how to propose a change.
One gotcha, all pull requests should be directed at the `master` branch (the default branch).
### Updating FontAwesome iconset for jekyllrb.com
We use a custom version of FontAwesome which contains just the icons we use.
If you ever need to update our documentation with an icon that is not already available in our custom iconset, you'll have to regenerate the iconset using Icomoon's Generator:
1. Go to <https://icomoon.io/app/>.
2. Click `Import Icons` on the top-horizontal-bar and upload the existing `<jekyll>/docs/icomoon-selection.json`.
3. Click `Add Icons from Library..` further down on the page, and add 'Font Awesome'.
4. Select the required icon(s) from the Library (make sure its the 'FontAwesome' library instead of 'IcoMoon-Free' library).
5. Click `Generate Font` on the bottom-horizontal-bar.
6. Inspect the included icons and proceed by clicking `Download`.
7. Extract the font files and adapt the CSS to the paths we use in Jekyll:
- Copy the entire `fonts` directory over and overwrite existing ones at `<jekyll>/docs/`.
- Copy the contents of `selection.json` and overwrite existing content inside `<jekyll>/docs/icomoon-selection.json`.
- Copy the entire `@font-face {}` declaration and only the **new-icon(s)' css declarations** further below, to update the
`<jekyll>/docs/_sass/_font-awesome.scss` sass partial.
- Fix paths in the `@font-face {}` declaration by adding `../` before `fonts/FontAwesome.*` like so:
`('../fonts/Fontawesome.woff?9h6hxj')`.
### Adding plugins
If you want to add your plugin to the [list of plugins](https://jekyllrb.com/docs/plugins/#available-plugins), please submit a pull request modifying the [plugins page source file](https://github.com/jekyll/jekyll/blob/master/docs/_docs/plugins.md) by adding a link to your plugin under the proper subheading depending upon its type.
## Code Contributions
Interesting in submitting a pull request? Awesome. Read on. There's a few common gotchas that we'd love to help you avoid.
### Tests and documentation
Any time you propose a code change, you should also include updates to the documentation and tests within the same pull request.
#### Documentation
If your contribution changes any Jekyll behavior, make sure to update the documentation. Documentation lives in the `docs/_docs` folder (spoiler alert: it's a Jekyll site!). If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, `jekyllrb.com` will be updated.
#### Tests
* If you're creating a small fix or patch to an existing feature, a simple test is more than enough. You can usually copy/paste from an existing example in the `tests` folder, but if you need you can find out about our tests suites [Shoulda](https://github.com/thoughtbot/shoulda/tree/master) and [RSpec-Mocks](https://github.com/rspec/rspec-mocks).
* If it's a brand new feature, create a new [Cucumber](https://github.com/cucumber/cucumber/) feature, reusing existing steps where appropriate.
### Code contributions generally
* Jekyll uses the [Rubocop](https://github.com/bbatsov/rubocop) static analyzer to ensure that contributions follow the [GitHub Ruby Styleguide](https://github.com/styleguide/ruby). Please check your code using `script/fmt` and resolve any errors before pushing your branch.
* Don't bump the Gem version in your pull request (if you don't know what that means, you probably didn't).
* You can use the command `script/console` to start a REPL to explore the result of
Jekyll's methods. It also provides you with helpful methods to quickly create a
site or configuration. [Feel free to check it out!](https://github.com/jekyll/jekyll/blob/master/script/console)
## Running tests locally
### Test Dependencies
To run the test suite and build the gem you'll need to install Jekyll's dependencies by running the following command:
```sh
script/bootstrap
```
Before you make any changes, run the tests and make sure that they pass (to confirm your environment is configured properly):
```sh
script/cibuild
```
If you are only updating a file in `test/`, you can use the command:
```sh
script/test test/blah_test.rb
```
If you are only updating a `.feature` file, you can use the command:
```sh
script/cucumber features/blah.feature
```
Both `script/test` and `script/cucumber` can be run without arguments to
run its entire respective suite.
## A thank you
Thanks! Hacking on Jekyll should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation!

View File

@@ -1,155 +0,0 @@
---
title: Data Files
permalink: /docs/datafiles/
---
In addition to the [built-in variables](../variables/) available from Jekyll,
you can specify your own custom data that can be accessed via the [Liquid
templating system](https://wiki.github.com/shopify/liquid/liquid-for-designers).
Jekyll supports loading data from [YAML](http://yaml.org/), [JSON](http://www.json.org/),
and [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) files located in the `_data` directory.
Note that CSV files *must* contain a header row.
This powerful feature allows you to avoid repetition in your templates and to
set site specific options without changing `_config.yml`.
Plugins/themes can also leverage Data Files to set configuration variables.
## The Data Folder
As explained on the [directory structure](../structure/) page, the `_data`
folder is where you can store additional data for Jekyll to use when generating
your site. These files must be YAML, JSON, or CSV files (using either
the `.yml`, `.yaml`, `.json` or `.csv` extension), and they will be
accessible via `site.data`.
## Example: List of members
Here is a basic example of using Data Files to avoid copy-pasting large chunks
of code in your Jekyll templates:
In `_data/members.yml`:
```yaml
- name: Eric Mill
github: konklone
- name: Parker Moore
github: parkr
- name: Liu Fengyun
github: liufengyun
```
Or `_data/members.csv`:
```text
name,github
Eric Mill,konklone
Parker Moore,parkr
Liu Fengyun,liufengyun
```
This data can be accessed via `site.data.members` (notice that the filename
determines the variable name).
You can now render the list of members in a template:
{% raw %}
```liquid
<ul>
{% for member in site.data.members %}
<li>
<a href="https://github.com/{{ member.github }}">
{{ member.name }}
</a>
</li>
{% endfor %}
</ul>
```
{% endraw %}
{: .note .info }
If your Jekyll site has a lot of pages, such as with documentation websites, see the detailed examples in [how to build robust navigation for your site]({% link _tutorials/navigation.md %}).
## Example: Organizations
Data files can also be placed in sub-folders of the `_data` folder. Each folder
level will be added to a variable's namespace. The example below shows how
GitHub organizations could be defined separately in a file under the `orgs`
folder:
In `_data/orgs/jekyll.yml`:
```yaml
username: jekyll
name: Jekyll
members:
- name: Tom Preston-Werner
github: mojombo
- name: Parker Moore
github: parkr
```
In `_data/orgs/doeorg.yml`:
```yaml
username: doeorg
name: Doe Org
members:
- name: John Doe
github: jdoe
```
The organizations can then be accessed via `site.data.orgs`, followed by the
file name:
{% raw %}
```liquid
<ul>
{% for org_hash in site.data.orgs %}
{% assign org = org_hash[1] %}
<li>
<a href="https://github.com/{{ org.username }}">
{{ org.name }}
</a>
({{ org.members | size }} members)
</li>
{% endfor %}
</ul>
```
{% endraw %}
## Example: Accessing a specific author
Pages and posts can also access a specific data item. The example below shows how to access a specific item:
`_data/people.yml`:
```yaml
dave:
name: David Smith
twitter: DavidSilvaSmith
```
The author can then be specified as a page variable in a post's frontmatter:
{% raw %}
```liquid
---
title: sample post
author: dave
---
{% assign author = site.data.people[page.author] %}
<a rel="author"
href="https://twitter.com/{{ author.twitter }}"
title="{{ author.name }}">
{{ author.name }}
</a>
```
{% endraw %}
For information on how to build robust navigation for your site (especially if you have a documentation website or another type of Jekyll site with a lot of pages to organize), see [Navigation](/tutorials/navigation).

View File

@@ -1,216 +0,0 @@
---
title: Deployment methods
permalink: /docs/deployment-methods/
---
Sites built using Jekyll can be deployed in a large number of ways due to the static nature of the generated output. A few of the most common deployment techniques are described below.
<div class="note">
<h5>ProTip™: Use GitHub Pages for zero-hassle Jekyll hosting</h5>
<p>GitHub Pages are powered by Jekyll behind the scenes, so if youre looking for a zero-hassle, zero-cost solution, GitHub Pages are a great way to <a href="../github-pages/">host your Jekyll-powered website for free</a>.</p>
</div>
## Netlify
Netlify provides Global CDN, Continuous Deployment, one click HTTPS and [much more](https://www.netlify.com/features/), providing developers the most robust toolset available for modern web projects, without added complexity. Netlify supports custom plugins for Jekyll and has a free plan for open source projects.
Read this [Jekyll step-by-step guide](https://www.netlify.com/blog/2015/10/28/a-step-by-step-guide-jekyll-3.0-on-netlify/) to setup your Jekyll site on Netlify.
## Aerobatic
[Aerobatic](https://www.aerobatic.com) has custom domains, global CDN distribution, basic auth, CORS proxying, and a growing list of plugins all included.
Automating the deployment of a Jekyll site is simple. See their [Jekyll docs](https://www.aerobatic.com/docs/static-site-generators/#jekyll) for more details. Your built `_site` folder is deployed to their highly-available, globally distributed hosting service.
## Kickster
Use [Kickster](http://kickster.nielsenramon.com/) for easy (automated) deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
Setting up Kickster is very easy, just install the gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
## Web hosting providers (FTP)
Just about any traditional web hosting provider will let you upload files to their servers over FTP. To upload a Jekyll site to a web host using FTP, simply run the `jekyll build` command and copy the contents of the generated `_site` folder to the root folder of your hosting account. This is most likely to be the `httpdocs` or `public_html` folder on most hosting providers.
## Self-managed web server
If you have direct access to the deployment web server, the process is essentially the same, except you might have other methods available to you (such as `scp`, or even direct filesystem access) for transferring the files. Just remember to make sure the contents of the generated `_site` folder get placed in the appropriate web root directory for your web server.
## Automated methods
There are also a number of ways to easily automate the deployment of a Jekyll site. If youve got another method that isnt listed below, wed love it if you [contributed](../contributing/) so that everyone else can benefit too.
### Git post-update hook
If you store your Jekyll site in [Git](https://git-scm.com/) (you are using
version control, right?), its pretty easy to automate the
deployment process by setting up a post-update hook in your Git
repository, [like
this](http://web.archive.org/web/20091223025644/http://www.taknado.com/en/2009/03/26/deploying-a-jekyll-generated-site/).
### Git post-receive hook
To have a remote server handle the deploy for you every time you push changes using Git, you can create a user account which has all the public keys that are authorized to deploy in its `authorized_keys` file. With that in place, setting up the post-receive hook is done as follows:
```sh
laptop$ ssh deployer@example.com
server$ mkdir myrepo.git
server$ cd myrepo.git
server$ git --bare init
server$ cp hooks/post-receive.sample hooks/post-receive
server$ mkdir /var/www/myrepo
```
Next, add the following lines to hooks/post-receive and be sure Jekyll is
installed on the server:
```bash
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
rm -Rf $TMP_GIT_CLONE
exit
```
Finally, run the following command on any users laptop that needs to be able to
deploy using this hook:
```sh
laptops$ git remote add deploy deployer@example.com:~/myrepo.git
```
Deploying is now as easy as telling nginx or Apache to look at
`/var/www/myrepo` and running the following:
```sh
laptops$ git push deploy master
```
### Static Publisher
[Static Publisher](https://github.com/static-publisher/static-publisher) is another automated deployment option with a server listening for webhook posts, though it's not tied to GitHub specifically. It has a one-click deploy to Heroku, it can watch multiple projects from one server, it has an easy to user admin interface and can publish to either S3 or to a git repository (e.g. gh-pages).
### Rake
Another way to deploy your Jekyll site is to use [Rake](https://github.com/ruby/rake), [HighLine](https://github.com/JEG2/highline), and
[Net::SSH](https://github.com/net-ssh/net-ssh). A more complex example of deploying Jekyll with Rake that deals with multiple branches can be found in [Git Ready](https://github.com/gitready/gitready/blob/cdfbc4ec5321ff8d18c3ce936e9c749dbbc4f190/Rakefile).
### scp
Once youve generated the `_site` directory, you can easily scp its content using a
`tasks/deploy` shell script similar to [this deploy script][]. Youd obviously
need to change the values to reflect your sites details. There is even [a
matching TextMate command][] that will help you run this script.
[this deploy script]: https://github.com/henrik/henrik.nyh.se/blob/master/script/deploy
[a matching TextMate command]: https://gist.github.com/henrik/214959
### rsync
Once youve generated the `_site` directory, you can easily rsync its content using a `tasks/deploy` shell script similar to [this deploy script here](https://github.com/vitalyrepin/vrepinblog/blob/master/transfer.sh). Youd obviously need to change the values to reflect your sites details.
Certificate-based authorization is another way to simplify the publishing
process. It makes sense to restrict rsync access only to the directory which it is supposed to sync. This can be done using rrsync.
#### Step 1: Install rrsync to your home folder (server-side)
If it is not already installed by your host, you can do it yourself:
- [Download rrsync](https://ftp.samba.org/pub/unpacked/rsync/support/rrsync)
- Place it in the `bin` subdirectory of your home folder (`~/bin`)
- Make it executable (`chmod +x`)
#### Step 2: Set up certificate-based SSH access (server side)
This [process](https://wiki.gentoo.org/wiki/SSH#Passwordless_Authentication) is
described in several places online. What is different from the typical approach
is to put the restriction to certificate-based authorization in
`~/.ssh/authorized_keys`. Then, launch `rrsync` and supply
it with the folder it shall have read-write access to:
```sh
command="$HOME/bin/rrsync <folder>",no-agent-forwarding,no-port-forwarding,no-pty,no-user-rc,no-X11-forwarding ssh-rsa <cert>
```
`<folder>` is the path to your site. E.g., `~/public_html/you.org/blog-html/`.
#### Step 3: Rsync (client-side)
Add the `deploy` script to the site source folder:
```sh
#!/bin/sh
rsync -crvz --rsh='ssh -p2222' --delete-after --delete-excluded <folder> <user>@<site>:
```
Command line parameters are:
- `--rsh=ssh -p2222` &mdash; The port for SSH access. It is required if
your host uses a different port than the default (e.g, HostGator)
- `<folder>` &mdash; The name of the local output folder (defaults to `_site`)
- `<user>` &mdash; The username for your hosting account
- `<site>` &mdash; Your hosting server
Using this setup, you might run the following command:
```sh
rsync -crvz --rsh='ssh -p2222' --delete-after --delete-excluded _site/ hostuser@example.org:
```
Don't forget the column `:` after server name!
#### Step 4 (Optional): Exclude the transfer script from being copied to the output folder.
This step is recommended if you use these instructions to deploy your site. If
you put the `deploy` script in the root folder of your project, Jekyll will
copy it to the output folder. This behavior can be changed in `_config.yml`.
Just add the following line:
```yaml
# Do not copy these files to the output directory
exclude: ["deploy"]
```
Alternatively, you can use an `rsync-exclude.txt` file to control which files will be transferred to your server.
#### Done!
Now it's possible to publish your website simply by running the `deploy`
script. If your SSH certificate is [passphrase-protected](https://martin.kleppmann.com/2013/05/24/improving-security-of-ssh-private-keys.html), you will be asked to enter it when the
script executes.
## Rack-Jekyll
[Rack-Jekyll](https://github.com/adaoraul/rack-jekyll/) is an easy way to deploy your site on any Rack server such as Amazon EC2, Slicehost, Heroku, and so forth. It also can run with [shotgun](https://github.com/rtomayko/shotgun/), [rackup](https://github.com/rack/rack), [mongrel](https://github.com/mongrel/mongrel), [unicorn](https://github.com/defunkt/unicorn/), and [others](https://github.com/adaoraul/rack-jekyll#readme).
Read [this post](http://andycroll.com/ruby/serving-a-jekyll-blog-using-heroku/) on how to deploy to Heroku using Rack-Jekyll.
## Jekyll-Admin for Rails
If you want to maintain Jekyll inside your existing Rails app, [Jekyll-Admin](https://github.com/zkarpinski/Jekyll-Admin) contains drop in code to make this possible. See Jekyll-Admins [README](https://github.com/zkarpinski/Jekyll-Admin/blob/master/README) for more details.
## Amazon S3
If you want to host your site in Amazon S3, you can do so by
using the [s3_website](https://github.com/laurilehmijoki/s3_website)
application. It will push your site to Amazon S3 where it can be served like
any web server,
dynamically scaling to almost unlimited traffic. This approach has the
benefit of being about the cheapest hosting option available for
low-volume blogs as you only pay for what you use.
## OpenShift
If you'd like to deploy your site to an OpenShift gear, there's [a cartridge
for that](https://github.com/openshift-quickstart/jekyll-openshift).

View File

@@ -1,19 +0,0 @@
---
title: Working with drafts
permalink: /docs/drafts/
---
Drafts are posts without a date. They're posts you're still working on and
don't want to publish yet. To get up and running with drafts, create a
`_drafts` folder in your site's root (as described in the [site structure](/docs/structure/) section) and create your
first draft:
```text
|-- _drafts/
| |-- a-draft-post.md
```
To preview your site with drafts, simply run `jekyll serve` or `jekyll build`
with the `--drafts` switch. Each will be assigned the value modification time
of the draft file for its date, and thus you will see currently edited drafts
as the latest posts.

View File

@@ -1,31 +0,0 @@
---
title: Extras
permalink: /docs/extras/
---
There are a number of (optional) extra features that Jekyll supports that you
may want to install, depending on how you plan to use Jekyll.
## Web Highlights and Commenting
Register your site with [txtpen](https://txtpen.com). Then append
```html
<script src="https://txtpen.com/embed.js?site=<your site name>"></script>
```
to your template files in `/_layout` folder.
## Math Support
Kramdown comes with optional support for LaTeX to PNG rendering via [MathJax](https://www.mathjax.org) within math blocks. See the Kramdown documentation on [math blocks](http://kramdown.gettalong.org/syntax.html#math-blocks) and [math support](http://kramdown.gettalong.org/converter/html.html#math-support) for more details. MathJax requires you to include JavaScript or CSS to render the LaTeX, e.g.
```html
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
```
For more information about getting started, check out [this excellent blog post](http://gastonsanchez.com/visually-enforced/opinion/2014/02/16/Mathjax-with-jekyll/).
## Alternative Markdown Processors
See the Markdown section on the [configuration page](/docs/configuration/#markdown-options) for instructions on how to use and configure alternative Markdown processors, as well as how to create [custom processors](/docs/configuration/#custom-markdown-processors).

View File

@@ -1,213 +0,0 @@
---
title: Front Matter
permalink: /docs/frontmatter/
---
The front matter is where Jekyll starts to get really cool. Any file that
contains a [YAML](http://yaml.org/) front matter block will be processed by
Jekyll as a special file. The front matter must be the first thing in the file
and must take the form of valid YAML set between triple-dashed lines. Here is a
basic example:
```yaml
---
layout: post
title: Blogging Like a Hacker
---
```
Between these triple-dashed lines, you can set predefined variables (see below
for a reference) or even create custom ones of your own. These variables will
then be available to you to access using Liquid tags both further down in the
file and also in any layouts or includes that the page or post in question
relies on.
<div class="note warning">
<h5>UTF-8 Character Encoding Warning</h5>
<p>
If you use UTF-8 encoding, make sure that no <code>BOM</code> header
characters exist in your files or very, very bad things will happen to
Jekyll. This is especially relevant if youre running
<a href="../windows/">Jekyll on Windows</a>.
</p>
</div>
<div class="note">
<h5>ProTip™: Front Matter Variables Are Optional</h5>
<p>
If you want to use <a href="../variables/">Liquid tags and variables</a>
but dont need anything in your front matter, just leave it empty! The set
of triple-dashed lines with nothing in between will still get Jekyll to
process your file. (This is useful for things like CSS and RSS feeds!)
</p>
</div>
## Predefined Global Variables
There are a number of predefined global variables that you can set in the
front matter of a page or post.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>layout</code></p>
</td>
<td>
<p>
If set, this specifies the layout file to use. Use the layout file
name without the file extension. Layout files must be placed in the
<code>_layouts</code> directory.
</p>
<ul>
<li>
Using <code>null</code> will produce a file without using a layout
file. However this is overridden if the file is a post/document and has a
layout defined in the <a href="../configuration/#front-matter-defaults">
frontmatter defaults</a>.
</li>
<li>
Starting from version 3.5.0, using <code>none</code> in a post/document will
produce a file without using a layout file regardless of frontmatter defaults.
Using <code>none</code> in a page, however, will cause Jekyll to attempt to
use a layout named "none".
</li>
</ul>
</td>
</tr>
<tr>
<td>
<p><code>permalink</code></p>
</td>
<td>
<p>
If you need your processed blog post URLs to be something other than
the site-wide style (default <code>/year/month/day/title.html</code>), then you can set
this variable and it will be used as the final URL.
</p>
</td>
</tr>
<tr>
<td>
<p><code>published</code></p>
</td>
<td>
<p>
Set to false if you dont want a specific post to show up when the
site is generated.
</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note">
<h5>ProTip™: Render Posts Marked As Unpublished</h5>
<p>
To preview unpublished pages, simply run `jekyll serve` or `jekyll build`
with the `--unpublished` switch. Jekyll also has a handy <a href="../drafts/">drafts</a>
feature tailored specifically for blog posts.
</p>
</div>
## Custom Variables
Any variables in the front matter that are not predefined are mixed into the
data that is sent to the Liquid templating engine during the conversion. For
instance, if you set a title, you can use that in your layout to set the page
title:
```liquid
<!DOCTYPE HTML>
<html>
<head>
<title>{% raw %}{{ page.title }}{% endraw %}</title>
</head>
<body>
```
## Predefined Variables for Posts
These are available out-of-the-box to be used in the front matter for a post.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>date</code></p>
</td>
<td>
<p>
A date here overrides the date from the name of the post. This can be
used to ensure correct sorting of posts. A date is specified in the
format <code>YYYY-MM-DD HH:MM:SS +/-TTTT</code>; hours, minutes, seconds, and timezone offset
are optional.
</p>
</td>
</tr>
<tr>
<td>
<p><code>category</code></p>
<p><code>categories</code></p>
</td>
<td>
<p>
Instead of placing posts inside of folders, you can specify one or
more categories that the post belongs to. When the site is generated
the post will act as though it had been set with these categories
normally. Categories (plural key) can be specified as a <a
href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
space-separated string.
</p>
</td>
</tr>
<tr>
<td>
<p><code>tags</code></p>
</td>
<td>
<p>
Similar to categories, one or multiple tags can be added to a post.
Also like categories, tags can be specified as a <a
href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
space-separated string.
</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note">
<h5>ProTip™: Don't repeat yourself</h5>
<p>
If you don't want to repeat your frequently used front matter variables
over and over, just define <a href="../configuration/#front-matter-defaults" title="Front Matter defaults">defaults</a>
for them and only override them where necessary (or not at all). This works
both for predefined and custom variables.
</p>
</div>

View File

@@ -1,140 +0,0 @@
---
title: GitHub Pages
permalink: /docs/github-pages/
---
[GitHub Pages](https://pages.github.com) are public web pages for users,
organizations, and repositories, that are freely hosted on GitHub's `github.io`
domain or on a custom domain name of your choice. GitHub Pages are powered by
Jekyll behind the scenes, so they're a great way to host your Jekyll-powered
website for free.
Your site is automatically generated by GitHub Pages when you push your source
files. Note that GitHub Pages works equally well for regular HTML content,
simply because Jekyll treats files without YAML front matter as static assets.
So if you only need to push generated HTML, you're good to go without any
further setup.
Never built a website with GitHub Pages before? [See this marvelous guide by
Jonathan McGlone](http://jmcglone.com/guides/github-pages/) to get you up and
running. This guide will teach you what you need to know about Git, GitHub, and
Jekyll to create your very own website on GitHub Pages.
## The github-pages gem
Our friends at GitHub have provided the
[github-pages](https://github.com/github/pages-gem) gem which is used to manage
[Jekyll and its dependencies on GitHub Pages](https://pages.github.com/versions/).
Using it in your projects means that when you deploy your site to GitHub Pages,
you will not be caught by unexpected differences between various versions of the
gems.
Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted
plugins](https://help.github.com/articles/configuring-jekyll-plugins/#default-plugins).
To use the currently-deployed version of the gem in your project, add the
following to your `Gemfile`:
```ruby
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
```
Be sure to run `bundle update` often.
<div class="note">
<h5>GitHub Pages Documentation, Help, and Support</h5>
<p>
For more information about what you can do with GitHub Pages, as well as for
troubleshooting guides, you should check out
<a href="https://help.github.com/categories/github-pages-basics/">GitHubs Pages Help section</a>.
If all else fails, you should contact <a href="https://github.com/contact">GitHub Support</a>.
</p>
</div>
### Project Page URL Structure
Sometimes it's nice to preview your Jekyll site before you push your `gh-pages`
branch to GitHub. However, the subdirectory-like URL structure GitHub uses for
Project Pages complicates the proper resolution of URLs. In order to assure your
site builds properly, use the handy [URL filters](../templates/#filters):
{% raw %}
```liquid
<!-- For styles with static names... -->
<link href="{{ "/assets/css/style.css" | relative_url }}" rel="stylesheet">
<!-- For documents/pages whose URLs can change... -->
[{{ page.title }}]("{{ page.url | relative_url }}")
```
{% endraw %}
This way you can preview your site locally from the site root on localhost,
but when GitHub generates your pages from the `gh-pages` branch all the URLs
will resolve properly.
## Deploying Jekyll to GitHub Pages
GitHub Pages work by looking at certain branches of repositories on GitHub.
There are two basic types available: [user/organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/).
The way to deploy these two types of sites are nearly identical, except for a
few minor details.
### User and Organization Pages
User and organization pages live in a special GitHub repository dedicated to
only the GitHub Pages files. This repository must be named after the account
name. For example, [@mojombos user page repository](https://github.com/mojombo/mojombo.github.io) has the name
`mojombo.github.io`.
Content from the `master` branch of your repository will be used to build and
publish the GitHub Pages site, so make sure your Jekyll site is stored there.
<div class="note info">
<h5>Custom domains do not affect repository names</h5>
<p>
GitHub Pages are initially configured to live under the
<code>username.github.io</code> subdomain, which is why repositories must
be named this way <strong>even if a custom domain is being used</strong>.
</p>
</div>
### Project Pages
Unlike user and organization Pages, Project Pages are kept in the same
repository as the project they are for, except that the website content is
stored in a specially named `gh-pages` branch or in a `docs` folder on the
`master` branch. The content will be rendered using Jekyll, and the output
will become available under a subpath of your user pages subdomain, such as
`username.github.io/project` (unless a custom domain is specified).
The Jekyll project repository itself is a perfect example of this branch
structure—the [master branch]({{ site.repository }}) contains the
actual software project for Jekyll, and the Jekyll website that youre
looking at right now is contained in the [docs
folder]({{ site.repository }}/tree/master/docs) of the same repository.
Please refer to GitHub official documentation on
[user, organization and project pages](https://help.github.com/articles/user-organization-and-project-pages/)
to see more detailed examples.
<div class="note warning">
<h5>Source files must be in the root directory</h5>
<p>
GitHub Pages <a href="https://help.github.com/articles/troubleshooting-github-pages-build-failures#source-setting">overrides</a>
the <a href="/docs/configuration/#global-configuration">“Site Source”</a>
configuration value, so if you locate your files anywhere other than the
root directory, your site may not build correctly.
</p>
</div>
<div class="note info">
<h5>Installing the <code>github-pages</code> gem on Windows</h5>
<p>
While Windows is not officially supported, it is possible
to install the <code>github-pages</code> gem on Windows.
Special instructions can be found on our
<a href="../windows/#installation">Windows-specific docs page</a>.
</p>
</div>

File diff suppressed because it is too large Load Diff

View File

@@ -1,190 +0,0 @@
---
title: Includes
permalink: /docs/includes/
---
The `include` tag allows you to include the content from another file stored in the `_includes` folder:
{% raw %}
```liquid
{% include footer.html %}
```
{% endraw %}
Jekyll will look for the referenced file (in this case, `footer.html`) in the `_includes` directory at the root of your source directory and insert its contents.
### Including files relative to another file
You can choose to include file fragments relative to the current file by using the `include_relative` tag:
{% raw %}
```liquid
{% include_relative somedir/footer.html %}
```
{% endraw %}
You won't need to place your included content within the `_includes` directory. Instead,
the inclusion is specifically relative to the file where the tag is being used. For example,
if `_posts/2014-09-03-my-file.markdown` uses the `include_relative` tag, the included file
must be within the `_posts` directory or one of its subdirectories.
Note that you cannot use the `../` syntax to specify an include location that refers to a higher-level directory.
All the other capabilities of the `include` tag are available to the `include_relative` tag,
such as variables.
### Using variables names for the include file
The name of the file you want to embed 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 include:
{% raw %}
```liquid
{% include {{ page.my_variable }} %}
```
{% endraw %}
In this example, the include would insert the file `footer_company_a.html` from the `_includes/footer_company_a.html` directory.
### Passing parameters to includes
You can also pass parameters to an include. For example, suppose you have a file called `note.html` in your `_includes` folder that contains this formatting:
{% raw %}
```liquid
<div markdown="span" class="alert alert-info" role="alert">
<i class="fa fa-info-circle"></i> <b>Note:</b>
{{ include.content }}
</div>
```
{% endraw %}
The `{% raw %}{{ include.content }}{% endraw %}` is a parameter that gets populated when you call the include and specify a value for that parameter, like this:
{% raw %}
```liquid
{% include note.html content="This is my sample note." %}
```
{% endraw %}
The value of `content` (which is `This is my sample note`) will be inserted into the {% raw %}`{{ include.content }}`{% endraw %} parameter.
Passing parameters to includes is especially helpful when you want to hide away complex formatting from your Markdown content.
For example, suppose you have a special image syntax with complex formatting, and you don't want your authors to remember the complex formatting. As a result, you decide to simplify the formatting by using an include with parameters. Here's an example of the special image syntax you might want to populate with an include:
```html
<figure>
<a href="http://jekyllrb.com">
<img src="logo.png" style="max-width: 200px;"
alt="Jekyll logo" />
<figcaption>This is the Jekyll logo</figcaption>
</figure>
```
You could templatize this content in your include and make each value available as a parameter, like this:
{% raw %}
```liquid
<figure>
<a href="{{ include.url }}">
<img src="{{ include.file }}" style="max-width: {{ include.max-width }};"
alt="{{ include.alt }}"/>
<figcaption>{{ include.caption }}</figcaption>
</figure>
```
{% endraw %}
This include contains 5 parameters:
* `url`
* `max-width`
* `file`
* `alt`
* `caption`
Here's an example that passes all the parameters to this include (the include file is named `image.html`):
{% raw %}
```liquid
{% include image.html url="http://jekyllrb.com"
max-width="200px" file="logo.png" alt="Jekyll logo"
caption="This is the Jekyll logo." %}
```
{% endraw %}
The result is the original HTML code shown earlier.
To safeguard situations where users don't supply a value for the parameter, you can use [Liquid's default filter](https://shopify.github.io/liquid/filters/default/).
Overall, you can create includes that act as templates for a variety of uses &mdash; inserting audio or video clips, alerts, special formatting, and more. However, note that you should avoid using too many includes, as this will slow down the build time of your site. For example, don't use includes every time you insert an image. (The above technique shows a use case for special images.)
### Passing parameter variables to includes
Suppose the parameter you want to pass to the include is a variable rather than a string. For example, you might be using {% raw %}`{{ site.product_name }}`{% endraw %} to refer to every instance of your product rather than the actual hard-coded name. (In this case, your `_config.yml` file would have a key called `product_name` with a value of your product's name.)
The string you pass to your include parameter can't contain curly braces. For example, you can't pass a parameter that contains this: {% raw %}`"The latest version of {{ site.product_name }} is now available."`{% endraw %}
If you want to include this variable in your parameter that you pass to an include, you need to store the entire parameter as a variable before passing it to the include. You can use `capture` tags to create the variable:
{% raw %}
```liquid
{% capture download_note %}
The latest version of {{ site.product_name }} is now available.
{% endcapture %}
```
{% endraw %}
Then pass this captured variable into the parameter for the include. Omit the quotation marks around the parameter content because it's no longer a string (it's a variable):
{% raw %}
```liquid
{% include note.html content=download_note %}
```
{% endraw %}
### Passing references to YAML files as parameter values
Instead of passing string variables to the include, you can pass a reference to a YAML data file stored in the `_data` folder.
Here's an example. In the `_data` folder, suppose you have a YAML file called `profiles.yml`. Its content looks like this:
```yaml
- name: John Doe
login_age: old
image: johndoe.jpg
- name: Jane Doe
login_age: new
image: janedoe.jpg
```
In the `_includes` folder, assume you have a file called `spotlight.html` with this code:
{% raw %}
```liquid
{% for person in include.participants %}
{% if person.login_age == "new" %}
{{ person.name }}
{% endif %}
{% endfor %}
```
{% endraw %}
Now when you insert the `spotlight.html` include file, you can submit the YAML file as a parameter:
{% raw %}
```liquid
{% include spotlight.html participants=site.data.profiles %}
```
{% endraw %}
In this instance, `site.data.profiles` gets inserted in place of {% raw %}`include.participants`{% endraw %} in the include file, and the Liquid logic processes. The result will be `Jane Doe`.

View File

@@ -1,41 +0,0 @@
---
title: Welcome
permalink: /docs/home/
redirect_from: /docs/index.html
---
This site aims to be a comprehensive guide to Jekyll. Well cover topics such as getting your site up and running, creating and managing content, customizing your build, and deploying.
## What is Jekyll, exactly?
Jekyll is a simple, blog-aware, static site generator.
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.
Jekyll happens to be the engine behind [GitHub Pages](https://pages.github.com), so you can host your projects Jekyll page/blog/website on GitHubs servers **for free**.
## Navigating the Guide
Throughout this guide, you'll see these special sections that help you get the most out of Jekyll:
<div class="note">
<h5>ProTips™</h5>
<p>Tips and tricks that'll make you a Jekyll wizard!</p>
</div>
<div class="note info">
<h5>Notes</h5>
<p>Extra tidbits that are sometimes necessary to understand Jekyll.</p>
</div>
<div class="note warning">
<h5>Warnings</h5>
<p>Common pitfalls to avoid.</p>
</div>
<div class="note unreleased">
<h5>Unreleased</h5>
<p>Features planned for future versions of Jekyll, but not available yet.</p>
</div>
If you find anything we havent covered, or would like to share a tip that others might find handy, please [file an issue]({{ site.repository }}/issues/new) and well see about adding it to the guide.

View File

@@ -1,202 +0,0 @@
---
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.
- [Requirements](#requirements)
- [Install Jekyll on macOS](#macOS)
- [Install Jekyll on Ubuntu Linux](#ubuntu)
- [Install Jekyll on Windows](../windows/)
- [Upgrade Jekyll](#upgrade-jekyll)
## Requirements
Before you start, make sure your system has the following:
- [Ruby](https://www.ruby-lang.org/en/downloads/) version 2.2.5 or above, including all development headers (ruby installation can be checked by running `ruby -v`)
- [RubyGems](https://rubygems.org/pages/download) (which you can check by running `gem -v`)
- [GCC](https://gcc.gnu.org/install/) and [Make](https://www.gnu.org/software/make/) (in case your system doesn't have them installed, which you can check by running `gcc -v`,`g++ -v` and `make -v` in your system's command line interface)
## Install on macOS {#macOS}
We only cover macOS High Sierra 10.13 here, which comes with Ruby 2.3.3, older systems will need to [install a more recent Ruby version via Homebrew](#homebrew).
First, you need to install the command-line tools to be able to compile native extensions, open a terminal and run:
```sh
xcode-select --install
```
### Set up Ruby included with the OS
Check your Ruby version meet our requirements:
```sh
ruby -v
2.3.3
```
Great, let's install Jekyll. We also need [Bundler](https://bundler.io/) to help us handle [plugins](../plugins) and [themes](../themes):
```sh
gem install bundler jekyll
```
That's it, you're ready to go, either by installing our [default minimal blog theme](https://github.com/jekyll/minima) with `jekyll new jekyll-website` or by starting from scratch:
```sh
mkdir jekyll-website
cd jekyll-website
# Create a Gemfile
bundle init
# Add Jekyll
bundle add jekyll
# Install gems
bundle install
```
Great, from there you can now either use a [theme](../themes/) or [create your own layouts](../templates/).
### Install a newer Ruby version via Homebrew {#homebrew}
If you wish to install the latest version of Ruby and get faster builds, we recommend to do it via [Homebrew](https://brew.sh) a handy package manager for macOS.
```sh
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install ruby
ruby -v
ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin17]
```
Yay! Now you have a shiny Ruby on your system!
### Install multiple Ruby versions with rbenv {#rbenv}
Developers often use [rbenv](https://github.com/rbenv/rbenv) to manage multiple Ruby versions. This can be useful if you want to run the same Ruby version used by [GitHub Pages](https://pages.github.com/versions/) or [Netlify](https://www.netlify.com/docs/#ruby) for instance.
```sh
# Install rbenv and ruby-build
brew install rbenv
# Setup rbenv integration to your shell
rbenv init
# Check your install
curl -fsSL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-doctor | bash
```
Restart your terminal for changes to take effect.
Now we can install the Ruby version of our choice, let's go with Ruby 2.5.1 here:
```sh
rbenv install 2.5.1
rbenv global 2.5.1
ruby -v
ruby 2.5.1p57 (2018-03-29 revision 63029) [x86_64-darwin17]
```
That's it! Head over [rbenv command references](https://github.com/rbenv/rbenv#command-reference) to learn how to use different versions of Ruby in your projects.
<div class="note info" markdown="1">
##### Problems installing Jekyll?
Check out the [troubleshooting](../troubleshooting/) page or
[ask for help on our forum](https://talk.jekyllrb.com).
</div>
## Install on Ubuntu Linux {#ubuntu}
Before we install Jekyll, we need to make sure we have all the required
dependencies.
```sh
sudo apt-get install ruby ruby-dev build-essential
```
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:
```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.
## Pre-releases
In order to install a pre-release, make sure you have all the requirements
installed properly and run:
```sh
gem install jekyll --pre
```
This will install the latest pre-release. If you want a particular pre-release,
use the `-v` switch to indicate the version you'd like to install:
```sh
gem install jekyll -v '2.0.0.alpha.1'
```
If you'd like to install a development version of Jekyll, the process is a bit
more involved. This gives you the advantage of having the latest and greatest,
but may be unstable.
```sh
git clone git://github.com/jekyll/jekyll.git
cd jekyll
script/bootstrap
bundle exec rake build
ls pkg/*.gem | head -n 1 | xargs gem install -l
```
Now that youve got everything up-to-date and installed, lets get to work!

View File

@@ -1,28 +0,0 @@
---
title: Affinity Team Captains
---
**This guide is for affinity team captains.** These special people are **team maintainers** of one of our [affinity teams][] and help triage and evaluate the issues and contributions of others. You may find what is written here interesting, but its definitely not for everyone.
{: .note .info }
## Affinity teams & their captains
The Jekyll project uses [affinity teams][] to help break up the work of incoming issues and pull requests from community members. We receive a sizeable number of issues and pull requests each week; the use of affinity teams helps distribute this load across a number of specialized groups instead of pushing it all onto @jekyll/core.
## Responsibilities of Team Captains
Each affinity team has a few captains who manage the issues and pull requests for that team. When an issue or PR is opened with a `/cc` for a given affinity team, @jekyllbot automatically assigns a random affinity team captain to the issue to triage it. They have access to add labels, reassign the issue, give LGTM's, and so forth. While they do not merge PR's today, they are still asked to review PR's for parts of the codebase under their purview.
## How do I become a team captain?
Just ask! Feel free to open an issue on `jekyll/jekyll` and add `/cc @jekyll/core`. We can add you. :smile:
Alternatively, you can email or otherwise reach out to [@parkr](https://github.com/parkr) directly if you prefer the more private route.
## Ugh, I'm tired and don't have time to be a captain anymore. What now?
No sweat at all! Email [@parkr](https://github.com/parkr) and ask to be removed. Alternatively, you should be able to go to your team's page on GitHub.com (go to https://github.com/jekyll, click "Teams", click the link to your team) and change your status to either "member" or leave the team.
We realize that being a captain is no easy feat so we want to make it a great experience. As always, communicate as much as you can with us about what is working, and what isn't. Thanks for dedicating some time to Jekyll! :sparkles:
[affinity teams]: https://teams.jekyllrb.com/

View File

@@ -1,30 +0,0 @@
---
title: "Avoiding Burnout"
---
**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 its definitely not for everyone.
{: .note .info }
# 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.
# 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.
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.
# 3. Prioritise Maintainers Over Users
It's important to be user-focused but ultimately, as long as you follow #1 above, Jekyll's minimum number of users will be the number of maintainers. However, if Jekyll has no maintainers it will quickly become useless to all users and the project will die. As a result, no user complaint, behaviour or need takes priority over the burnout of maintainers. If users do not like the direction of the project, the easiest way to influence it is to make significant, high-quality code contributions and become a maintainer.
# 4. Learn To Say No
Jekyll gets a lot of feature requests, non-reproducible bug reports, usage questions and PRs we won't accept. These should be closed out as soon as we realise that they aren't going to be resolved or merged. This is kinder than deciding this after a long period of review. Our issue tracker should reflect work to be done.
---
Thanks to https://gist.github.com/ryanflorence/124070e7c4b3839d4573 which influenced this document.
Thanks to [Homebrew's "Avoiding Burnout" document](https://github.com/Homebrew/brew/blob/master/docs/Maintainers-Avoiding-Burnout.md) for providing a perfect base for this document.

View File

@@ -1,38 +0,0 @@
---
title: "Becoming a Maintainer"
---
**This guide is for contributors.** These special people have contributed to one or more of Jekyll's repositories, but do not yet have write access to any. You may find what is written here interesting, but its definitely not for everyone.
{: .note .info }
So you want to become a maintainer of a Jekyll project? We'd love to have you! Here are some things we like to see from community members before we promote them to maintainers.
## 1. Use Jekyll
You want to maintain Jekyll? Use it often. Do weird things with it. Do normal things with it. Does it work? Does it have any weaknesses? Is there a gap in the product that you think should be filled?
## 2. Help Triage Issues
Watch the repository you're interested in. Join [an Affinity Team](https://teams.jekyllrb.com) and receive mentions regarding a particular interest area of the project. When you receive a notification for an issue that has not been triaged by a maintainer, dive in. Can you reproduce the issue? Can you determine the fix? [More tips on Triaging an Issue in our maintainer guide](../triaging-an-issue). Every maintainer loves an issue that is resolved before they get to it. :smiley:
## 3. Write Documentation
Good documentation means less confusion for our users and fewer issues to triage. Documentation is always in need of fixes and updates as we change the code. Read through the documentation during your normal usage of the product and submit changes as you feel they are necessary.
## 4. Write Code
As a maintainer, you will be reviewing pull requests which update code. You should feel comfortable with the Jekyll codebase enough to confidently review any pull request put forward. In order to become more comfortable, write some code of your own and send a pull request. A great place to start is with any issue labeled "bug" in the issue tracker. Write a test which replicates the problem and fails, then work on fixing the code such that the test passes.
## 5. Review Pull Requests
Start by reviewing one pull request a week. Leave detailed comments and [follow our guide for reviewing pull requests](../reviewing-a-pull-request).
## 6. Ask!
Open an issue describing your contributions to the project and why you wish to be a maintainer. Issues are nice because you can easily reference where you have demonstrated that you help triage issues, write code & documentation, and review pull requests. You may also email any maintainer privately if you do not feel comfortable asking in the open.
We would love to expand the team and look forward to many more community members becoming maintainers!
# Helping Out Elsewhere
In addition to maintainers of our core and plugin code, the Jekyll team is comprised of moderators for our forums. These helpful community members take a look at the topics posted to [https://talk.jekyllrb.com](https://talk.jekyllrb.com) and ensure they are properly categorized and are acceptable under our Code of Conduct. If you would like to be a moderator, email one of the maintainers with links to where you have answered questions and a request to be added as a moderator. More help is always welcome.

View File

@@ -1,21 +0,0 @@
---
title: Maintaining Jekyll
permalink: /docs/maintaining/
---
**This guide is for Jekyll contributors and maintainers.** These special people contribute to one or more of Jekyll's repositories or help merge the contributions of others. You may find what is written here interesting, but its definitely not for everyone.
{: .note .info }
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/)
Interested in becoming a maintainer? Here is some documentation for **contributors**:
- [Becoming a maintainer](becoming-a-maintainer/)

View File

@@ -1,55 +0,0 @@
---
title: "Merging a Pull Request"
---
**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 its definitely not for everyone.
{: .note .info }
## Code Review
All pull requests should be subject to code review. Code review is a [foundational value](https://blog.fullstory.com/what-we-learned-from-google-code-reviews-arent-just-for-catching-bugs-b125a13aa292) of good engineering teams. Besides providing validation of correctness, it promotes a sense of community and gives other maintainers understanding of all parts of the code base. In short, code review is crucial to a healthy open source project.
**Read our guide for [Reviewing a pull request](../reviewing-a-pull-request) before merging.** Notably, the change must have tests if for code, and at least two maintainers must give it an OK.
## Merging
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
To merge a pull request, leave a comment thanking the contributor, then add the special merge request:
```text
Thank you very much for your contribution. Folks like you make this project and community strong. :heart:
@jekyllbot: merge +dev
```
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.
The categories match the headings in the `History.markdown` 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)
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/`
6. Development Fixes (`+dev`) changes which do not affect user-facing functionality or documentation, such as test fixes or bumping internal dependencies
7. Forward Ports (`+port`) — bug fixes applied to a previous version of Jekyll pulled onto `master`, e.g. cherry-picked commits from `3-1-stable` to `master`
Once @jekyllbot has merged the pull request, you should see three things:
1. A successful merge
2. Addition of labels for the necessary category if they aren't already applied
3. A commit to the `History.markdown` file which adds a note about the change
If you forget the category, that's just fine. You can always go back and move the line to the proper category header later. The category is always necessary for `jekyll/jekyll`, but many plugins have too few changes to necessitate changelog categories.
## Rejoice
You did it! Thanks for being a maintainer for one of our official Jekyll projects. Your work means the world to our thousands of users who rely on Jekyll daily. :heart:

View File

@@ -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 its 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!

View File

@@ -1,46 +0,0 @@
---
title: "Reviewing a Pull Request"
---
**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 its definitely not for everyone.
{: .note .info }
## Respond Kindly
Above all else, please review a pull request kindly. Our community can only be strong if we make it a welcoming and inclusive environment. To further promote this, the Jekyll community is governed by a [Code of Conduct](/docs/conduct/) by which all community members must abide.
Use emoji liberally :heart: :tada: :sparkles: :confetti_ball: and feel free to be emotive!! Contributions keep this project moving forward and we're always happy to receive them, even if the pull request isn't ultimately merged.
Mike McQuaid's post on the GitHub blog entitled ["Kindly Closing Pull Requests"](https://github.com/blog/2124-kindly-closing-pull-requests) is a great place to start. It describes various scenarios in which it would be acceptable to close a pull request for reasons other than lack of technical integrity or accuracy. Part of being kind is responding to and resolving pull requests quickly.
## Respond Quickly
We should be able to review all pull requests within one week. The only time initial review should take longer is if all the maintainers mysteriously took vacation during the same week. Promptness encourages frequent, high-quality contributions from community members and other maintainers.
If your response requires a response on the part of the author, please add the `pending-feedback` tag. @jekyllbot will automatically remove the tag once the author of the pull request responds.
## Resolve Quickly
Similarly, we should aim to resolve pull requests quickly. If a pull request introduces a feature which does not fit into the core purpose or goal of the project, close it promptly with a kind explanation of why it is not acceptable.
Leave detailed comments wherever possible. Provide the contributor with context around why the change you are requesting is necessary, or why the question you are asking is important to resolve. The more context we can clearly communicate to the contributor, the better able the contributor is to provide high-quality patches.
You may close a pull request if more than 30 days pass without a response from the author.
In some cases, review will involve many weeks of back-and-forth. As long as communication continues, this is fine. Ideally, any PR would be capable of resolution within 30 days of it being opened.
## Look for Tests
If this is a code change, are there tests for the updated or added behaviour? Shipping a version with bugs is inevitable, but ensuring changes are tested helps keep bugs and regressions to a minimum.
## CI Must Pass
It is fine to ask a contributor to investigate failures on Travis and patch them up before you begin your review. It is helpful to leave a message for the contributor indicating that the tests have failed and that no review will occur before the tests pass. If they ask for help, take a look and assist if you can.
## Rule of Two
A pull request may be merged once two maintainers have reviewed the pull request and indicated that it is acceptable to them. There is no need to wait for a third unless one of the two reviewers wishes for another set of eyes.
## Think Security
We owe it to our users to ensure that using a theme from the community or building someone else's site doesn't come with built-in security vulnerabilities. Things like where files may be read from and written to are important to keep secure. Jekyll is also the basis for hosted services such as [GitHub Pages](https://pages.github.com), which cannot upgrade when security issues are introduced.

View File

@@ -1,24 +0,0 @@
---
title: "Special Labels"
---
**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 its definitely not for everyone.
{: .note .info }
We use a series of "special labels" on GitHub.com to automate handling of some parts of the pull request and issue process. @jekyllbot may automatically apply or remove certain labels based on actions taken by users or maintainers. Below are the labels and how they work:
## `pending-feedback`
This label is used to indicate that we need more information from the issue/PR author in order to continue. It may be that you need more info before you can properly triage a bug report, or that you have some unanswered questions about a PR that need to be resolved before moving forward. You can safely ignore any issue with this label, as it is waiting for feedback.
## `needs-work` & `pending-rebase`
These labels are used to indicate that the Git state of a pull request must change. Both are removed once a push is registered (a "synchronize" event for the pull request) and the pull request becomes mergable. Add `needs-work` to a PR if, after your review, it requires code changes. Add `pending-rebase` to a PR if the code is fine but the branch is not automatically mergable with the target branch (e.g. `master`).
## `stale`
This label is automatically added and removed by @jekyllbot based on activity on an issue or pull request. The rules for this label are laid out in [Triaging an Issue: Staleness and automatic closure](../triaging-an-issue/#staleness-and-automatic-closure).
## `pinned`
This label is for @jekyllbot to ignore the age of the issue, which means that the `stale` label won't be automatically added, and the issue won't be closed after a while. This needs to be set manually, and should be set with care. (The `has-pull-request` label does the same thing, but shouldn't be used to _only_ keep an issue open)

View File

@@ -1,54 +0,0 @@
---
title: "Triaging an Issue"
---
**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 its definitely not for everyone.
{: .note .info }
Before evaluating an issue, it is important to identify if it is a feature
request or a bug. For the Jekyll project the following definitions are used
to identify a feature or a bug:
**Feature** - A feature is defined as a request that adds functionality to
Jekyll outside of its current capabilities.
**Bug** - A bug is defined as an issue that identifies an error that a user
(or users) encounter when using current Jekyll functionalities.
## Feature?
If the issue describes a feature request, ask:
1. Is this a setting? [Settings are a crutch](http://ben.balter.com/2016/03/08/optimizing-for-power-users-and-edge-cases/#settings-are-a-crutch) for doing "the right thing". Settings usually point to a bad default or an edge case that could be solved easily with a plugin. Keep the :christmas_tree: of settings as small as possible so as not to reduce the usability of the product. We like the philosophy "decisions not options."
2. Would at least 80% of users find it useful? If even a quarter of our users won't use it, it's very likely that the request doesn't fit our product's core goal.
3. Is there another way to accomplish the end goal of the request? Most feature requests are due to bad documentation for or understanding of a pre-existing feature. See if you can clarify the end goal of the request. What is the user trying to do? Could they accomplish that goal through another feature we already support?
4. Even if 80% of our users will use it, does it fit the core goal of our project? We are writing a tool for making static websites, not a swiss army knife for publishing more generally.
Feel free to get others' opinions and ask questions of the issue author, but depending upon the answers to the questions above, it may be out of scope for our project.
If the request is within scope, prioritize it on the product roadmap with the other maintainers. Apply the appropriate tags and ensure the right people have weighed in to define the feature's scope and implementation. If you want to be the _best ever_, submit a PR yourself which adds the feature.
## Bug?
### Reproducibility
If the bug has clear reproduction steps, take a minute to try them. If it helps, write a test in our test suite for the scenario which replicates the problem. Can you reliably replicate the issue?
If you can't replicate the issue, post your replication steps which didn't work and ask for clarification from the issue author.
### Supported Platform
Is the author using a supported platform? We support the latest versions of macOS, Ubuntu, Debian, CentOS, Fedora, and Arch Linux.
You may close the issue immediately if the author cannot reproduce the issue on a supported platform. For Windows-related problems, leave a comment letting the user know that Windows is not officially supported, but that they may absolutely continue using the issue to communicate with folks from `@jekyll/windows` to further investigate. Additionally, you can point them to Jekyll Talk (https://talk.jekyllrb.com) as a means of getting support from the community.
If the user is experiencing issues with GitHub Pages or another hosted platform that we cannot reproduce, please direct them to the platform's support channel and close the issue.
### What they wanted vs. what they got
An issue without a clear explanation of what the user got and what they were expecting to get is not an issue we can accurately respond to. If the user doesn't provide this information, please ask for clarification and apply the `pending-feedback` label. This information helps us build test cases such that we do not break the behaviour again in the future. The `pending-feedback` label will be removed automatically once the issue author posts a reply.
Is what they wanted to get something we want to happen? Sometimes a bug report is actually masquerading as a feature request. See the guidance above for handling feature requests.
### Staleness and automatic closure
@jekyllbot will automatically mark issues as `stale` if no activity occurs for at least one month. @jekyllbot leaves a comment asking for information about reproducibility in current versions. If no one responds after another month, the issue is automatically closed. This behaviour can be suppressed by setting the [`pinned` label](../maintaining/special-labels.md/#pinned).

View File

@@ -1,8 +0,0 @@
---
title: Blog migrations
permalink: /docs/migrations/
---
If youre switching to Jekyll from another blogging system, Jekylls importers
can help you with the move. To learn more about importing your site to Jekyll,
visit our [`jekyll-import` docs site](https://import.jekyllrb.com/docs/home/).

View File

@@ -1,74 +0,0 @@
---
title: Creating pages
permalink: /docs/pages/
---
In addition to [writing posts](../posts/), you might also want to add static pages (content that isn't date-based) to your Jekyll site. By taking advantage of the way Jekyll copies files and directories, this is easy to do.
## Homepage
Just about every web server configuration you come across will look for an HTML
file called `index.html` (by convention) in the site's root folder and display
that as the homepage. Unless the web server youre using is configured to look
for some different filename as the default, this file will turn into the
homepage of your Jekyll-generated site.
<div class="note">
<h5>ProTip™: Use layouts on your homepage</h5>
<p>
Any HTML file on your site can use layouts and/or includes, even the
homepage. Common content, like headers and footers, make excellent
candidates for extraction into a layout.
</p>
</div>
## Where additional pages live
Where you put HTML or [Markdown](https://daringfireball.net/projects/markdown/)
files for pages depends on how you want the pages to work. There are two main ways of creating pages:
- Place named HTML or [Markdown](https://daringfireball.net/projects/markdown/)
files for each page in your site's root folder.
- Place pages inside folders and subfolders named whatever you want.
Both methods work fine (and can be used in conjunction with each other),
with the only real difference being the resulting URLs. By default, pages retain the same folder structure in `_site` as they do in the source directory.
### Named HTML files
The simplest way of adding a page is just to add an HTML file in the root
directory with a suitable name for the page you want to create. For a site with
a homepage, an about page, and a contact page, heres what the root directory
and associated URLs might look like:
```sh
.
|-- _config.yml
|-- _includes/
|-- _layouts/
|-- _posts/
|-- _site/
|-- about.html # => http://example.com/about.html
|-- index.html # => http://example.com/
|-- other.md # => http://example.com/other.html
└── contact.html # => http://example.com/contact.html
```
If you have a lot of pages, you can organize those pages into subfolders. The same subfolders that are used to group your pages in our project's source will exist in the `_site` folder when your site builds.
## Flattening pages from subfolders into the root directory
If you have pages organized into subfolders in your source folder and want to flatten them in the root folder on build, you must add the [permalink]({% link _docs/permalinks.md %}) property directly in your page's front matter like this:
```yaml
---
title: My page
permalink: mypageurl.html
---
```
### Named folders containing index HTML files
If you don't want file extensions (`.html`) to appear in your page URLs (file extensions are the default), you can choose a [permalink style](../permalinks/#builtinpermalinkstyles) that has a trailing slash instead of a file extension.
Note if you want to view your site offline *without the Jekyll preview server*, your browser will need the file extension to display the page, and all assets will need to be relative links that function without the server baseurl.

View File

@@ -1,231 +0,0 @@
---
title: Pagination
permalink: /docs/pagination/
---
With many websites &mdash; especially blogs &mdash; its very common to
break the main listing of posts up into smaller lists and display them over
multiple pages. Jekyll offers a pagination plugin, so you can automatically
generate the appropriate files and folders you need for paginated listings.
For Jekyll 3, include the `jekyll-paginate` plugin in your Gemfile and in
your `_config.yml` under `plugins`. For Jekyll 2, this is standard.
<div class="note info">
<h5>Pagination only works within HTML files</h5>
<p>
Pagination does not work from within Markdown or Textile files from
your Jekyll site. Pagination works when called from within the HTML
file, named <code>index.html</code>, which optionally may reside in and
produce pagination from within a subdirectory, via the
<code>paginate_path</code> configuration value.
</p>
</div>
## Enable pagination
To enable pagination for posts on your blog, add a line to the `_config.yml` file that
specifies how many items should be displayed per page:
```yaml
paginate: 5
```
The number should be the maximum number of Posts youd like to be displayed
per-page in the generated site.
You may also specify the destination of the pagination pages:
```yaml
paginate_path: "/blog/page:num/"
```
This will read in `blog/index.html`, send it each pagination page in Liquid as
`paginator` and write the output to `blog/page:num/`, where `:num` is the
pagination page number, starting with `2`. If a site has 12 posts and specifies
`paginate: 5`, Jekyll will write `blog/index.html` with the first 5 posts, `blog/page2/index.html` with the next 5 posts
and `blog/page3/index.html` with the last 2 posts into the destination
directory.
<div class="note warning">
<h5>Don't set a permalink</h5>
<p>
Setting a permalink in the front matter of your blog page will cause
pagination to break. Just omit the permalink.
</p>
</div>
<div class="note info">
<h5>Pagination for categories, tags and collections</h5>
<p>
The more recent <a href="https://github.com/sverrirs/jekyll-paginate-v2">jekyll-paginate-v2</a> plugin supports more features. See the <a href="https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples">pagination examples</a> in the repository.
<strong>This plugin is not supported by GitHub Pages</strong>.
</p>
</div>
## Liquid Attributes Available
The pagination plugin exposes the `paginator` liquid object with the following
attributes:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Attribute</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><p><code>page</code></p></td>
<td><p>current page number</p></td>
</tr>
<tr>
<td><p><code>per_page</code></p></td>
<td><p>number of posts per page</p></td>
</tr>
<tr>
<td><p><code>posts</code></p></td>
<td><p>a list of posts for the current page</p></td>
</tr>
<tr>
<td><p><code>total_posts</code></p></td>
<td><p>total number of posts in the site</p></td>
</tr>
<tr>
<td><p><code>total_pages</code></p></td>
<td><p>number of pagination pages</p></td>
</tr>
<tr>
<td><p><code>previous_page</code></p></td>
<td>
<p>
page number of the previous pagination page,
or <code>nil</code> if no previous page exists
</p>
</td>
</tr>
<tr>
<td><p><code>previous_page_path</code></p></td>
<td>
<p>
path of previous pagination page,
or <code>nil</code> if no previous page exists
</p>
</td>
</tr>
<tr>
<td><p><code>next_page</code></p></td>
<td>
<p>
page number of the next pagination page,
or <code>nil</code> if no subsequent page exists
</p>
</td>
</tr>
<tr>
<td><p><code>next_page_path</code></p></td>
<td>
<p>
path of next pagination page,
or <code>nil</code> if no subsequent page exists
</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note info">
<h5>Pagination does not support tags or categories</h5>
<p>Pagination pages through every post in the <code>posts</code>
variable unless a post has <code>hidden: true</code> in its YAML Front Matter.
It does not currently allow paging over groups of posts linked
by a common tag or category. It cannot include any collection of
documents because it is restricted to posts.</p>
</div>
## Render the paginated Posts
The next thing you need to do is to actually display your posts in a list using
the `paginator` variable that will now be available to you. Youll probably
want to do this in one of the main pages of your site. Heres one example of a
simple way of rendering paginated Posts in a HTML file:
{% raw %}
```liquid
---
layout: default
title: My Blog
---
<!-- This loops through the paginated posts -->
{% for post in paginator.posts %}
<h1><a href="{{ post.url }}">{{ post.title }}</a></h1>
<p class="author">
<span class="date">{{ post.date }}</span>
</p>
<div class="content">
{{ post.content }}
</div>
{% endfor %}
<!-- Pagination links -->
<div class="pagination">
{% if paginator.previous_page %}
<a href="{{ paginator.previous_page_path }}" class="previous">Previous</a>
{% else %}
<span class="previous">Previous</span>
{% endif %}
<span class="page_number ">Page: {{ paginator.page }} of {{ paginator.total_pages }}</span>
{% if paginator.next_page %}
<a href="{{ paginator.next_page_path }}" class="next">Next</a>
{% else %}
<span class="next ">Next</span>
{% endif %}
</div>
```
{% endraw %}
<div class="note warning">
<h5>Beware the page one edge-case</h5>
<p>
Jekyll does not generate a page1 folder, so the above code will not work
when a <code>/page1</code> link is produced. See below for a way to handle
this if its a problem for you.
</p>
</div>
The following HTML snippet should handle page one, and render a list of each
page with links to all but the current page.
{% raw %}
```liquid
{% if paginator.total_pages > 1 %}
<div class="pagination">
{% if paginator.previous_page %}
<a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">&laquo; Prev</a>
{% else %}
<span>&laquo; Prev</span>
{% endif %}
{% for page in (1..paginator.total_pages) %}
{% if page == paginator.page %}
<em>{{ page }}</em>
{% elsif page == 1 %}
<a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">{{ page }}</a>
{% else %}
<a href="{{ site.paginate_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}">{{ page }}</a>
{% endif %}
{% endfor %}
{% if paginator.next_page %}
<a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Next &raquo;</a>
{% else %}
<span>Next &raquo;</span>
{% endif %}
</div>
{% endif %}
```
{% endraw %}

View File

@@ -1,394 +0,0 @@
---
title: Permalinks
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.
## Where to configure permalinks
You can configure your site's permalinks through the [Configuration]({% link _docs/configuration.md %}) file or in the [Front Matter]({% link _docs/frontmatter.md %}) for each post, page, or collection.
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
```
If you don't specify any permalink setting, Jekyll uses the above pattern as the default.
The permalink can also be set using a built-in permalink style:
```yaml
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.
Setting the permalink in your post, page, or collection's front matter overrides any global settings. Here's an example:
```yaml
---
title: My page title
permalink: /mypageurl/
---
```
Even if your configuration file specifies the `date` style, the URL for this page would be `http://somedomain.com/mypageurl/`.
When you use permalinks that omit the `.html` file extension (called "pretty URLs") Jekyll builds the file as index.html placed inside a folder with the page's name. For example:
```
├── mypageurl
│   └── index.html
```
With a URL such as `/mypageurl/`, servers automatically load the index.html file inside the folder, so users can simply navigate to `http://somedomain.com/mypageurl/` to get to `mypageurl/index.html`.
## Template variables for permalinks {#template-variables}
The following table lists the template variables available for permalinks. You can use these variables in the `permalink` property in your config file.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>year</code></p>
</td>
<td>
<p>
Year from the post's filename. May be overridden via the documents
<code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
<td>
<p><code>month</code></p>
</td>
<td>
<p>
Month from the post's filename. May be overridden via the documents
<code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
<td>
<p><code>i_month</code></p>
</td>
<td>
<p>
Month without leading zeros from the post's filename. May be
overridden via the documents <code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
<td>
<p><code>day</code></p>
</td>
<td>
<p>
Day from the post's filename. May be overridden via the documents
<code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
<td>
<p><code>i_day</code></p>
</td>
<td>
<p>
Day without leading zeros from the post's filename. May be overridden
via the documents <code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
<td>
<p><code>y_day</code></p>
</td>_
<td>
<p>Day of the year from the post's filename, with leading zeros.</p>
</td>
</tr>
<tr>
<td>
<p><code>short_year</code></p>
</td>
<td>
<p>
Year without the century from the post's filename. May be overridden
via the documents <code>date</code> YAML front matter
</p>
</td>
</tr>
<tr>
<td>
<p><code>hour</code></p>
</td>
<td>
<p>
Hour of the day, 24-hour clock, zero-padded from the post's
<code>date</code> front matter. (00..23)
</p>
</td>
</tr>
<tr>
<td>
<p><code>minute</code></p>
</td>
<td>
<p>
Minute of the hour from the post's <code>date</code> front matter. (00..59)
</p>
</td>
</tr>
<tr>
<td>
<p><code>second</code></p>
</td>
<td>
<p>
Second of the minute from the post's <code>date</code> front matter. (00..59)
</p>
</td>
</tr>
<tr>
<td>
<p><code>title</code></p>
</td>
<td>
<p>
Title from the documents filename. May be overridden via
the documents <code>slug</code> YAML front matter.
</p>
</td>
</tr>
<tr>
<td>
<p><code>slug</code></p>
</td>
<td>
<p>
Slugified title from the documents filename (any character
except numbers and letters is replaced as hyphen). May be
overridden via the documents <code>slug</code> YAML front matter.
</p>
</td>
</tr>
<tr>
<td>
<p><code>categories</code></p>
</td>
<td>
<p>
The specified categories for this post. If a post has multiple
categories, Jekyll will create a hierarchy (e.g. <code>/category1/category2</code>).
Also Jekyll automatically parses out double slashes in the URLs,
so if no categories are present, it will ignore this.
</p>
</td>
</tr>
</tbody>
</table>
</div>
Note that all template variables relating to time or categories are available to posts only.
## Built-in permalink styles {#builtinpermalinkstyles}
Although you can specify a custom permalink pattern using [template variables](#template-variables), Jekyll also provides the following built-in styles for convenience.
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Permalink Style</th>
<th>URL Template</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>date</code></p>
</td>
<td>
<p><code>/:categories/:year/:month/:day/:title:output_ext</code></p>
</td>
</tr>
<tr>
<td>
<p><code>pretty</code></p>
</td>
<td>
<p><code>/:categories/:year/:month/:day/:title/</code></p>
</td>
</tr>
<tr>
<td>
<p><code>ordinal</code></p>
</td>
<td>
<p><code>/:categories/:year/:y_day/:title:output_ext</code></p>
</td>
</tr>
<tr>
<td>
<p><code>none</code></p>
</td>
<td>
<p><code>/:categories/:title:output_ext</code></p>
</td>
</tr>
</tbody>
</table>
</div>
Rather than typing `permalink: /:categories/:year/:month/:day/:title/`, you can just type `permalink: pretty`.
<div class="note info">
<h5>Specifying permalinks through the YAML Front Matter</h5>
<p>Built-in permalink styles are not recognized in YAML Front Matter. As a result, <code>permalink: pretty</code> will not work.</p>
</div>
## Permalink style examples with posts {#permalink-style-examples}
Here are a few examples to clarify how permalink styles get applied with posts.
Given a post named: `/2009-04-29-slap-chop.md`
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>URL Template</th>
<th>Resulting Permalink URL</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p>None specified, or <code>permalink: date</code></p>
</td>
<td>
<p><code>/2009/04/29/slap-chop.html</code></p>
</td>
</tr>
<tr>
<td>
<p><code>pretty</code></p>
</td>
<td>
<p><code>/2009/04/29/slap-chop/</code></p>
</td>
</tr>
<tr>
<td>
<p><code>/:month-:day-:year/:title:output_ext</code></p>
</td>
<td>
<p><code>/04-29-2009/slap-chop.html</code></p>
</td>
</tr>
<tr>
<td>
<p><code>/blog/:year/:month/:day/:title/</code></p>
</td>
<td>
<p><code>/blog/2009/04/29/slap-chop/</code></p>
</td>
</tr>
<tr>
<td>
<p><code>/:year/:month/:title</code></p>
<p>See <a href="#extensionless-permalinks">Extensionless permalinks with no trailing slashes</a> for details.</p>
</td>
<td>
<p><code>/2009/04/slap-chop</code></p>
</td>
</tr>
</tbody>
</table>
</div>
## Permalink settings for pages and collections {#pages-and-collections}
The permalink setting in your configuration file specifies the permalink style used for posts, pages, and collections. However, because pages and collections don't have time or categories, these aspects of the permalink style are ignored with pages and collections.
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 `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.
## Permalinks and default paths
The path to the post or page in the built site differs for posts, pages, and collections:
### Posts
The subfolders into which you may have organized your posts inside the `_posts` directory will not be part of the permalink.
If you use a permalink style that omits the `.html` file extension, each post is rendered as an `index.html` file inside a folder with the post's name (for example, `categoryname/2016/12/01/mypostname/index.html`).
### Pages
Unlike posts, pages by default mimic the source directory structure exactly. (The only exception is if your page has a `permalink` declared its front matter &mdash; in that case, the structure honors the permalink setting instead of the source folder structure.)
As with posts, if you use a permalink style that omits the `.html` file extension, each page is rendered as an `index.html` file inserted inside a folder with the page's name (for example, `mypage/index.html`).
### Collections
By default, collections follow a similar structure in the `_site` folder as pages, except that the path is prefaced by the collection name. For example: `collectionname/mypage.html`. For permalink settings that omit the file extension, the path would be `collection_name/mypage/index.html`.
Collections have their own way of setting permalinks. Additionally, collections have unique template variables available (such as `path` and `output_ext`). See the [Configuring permalinks for collections](../collections/#permalinks) in Collections for more information.
## Flattening pages in \_site on build
If you want to flatten your pages (pull them out of subfolders) in the `_site` directory when your site builds (similar to posts), add the `permalink` property to the front matter of each page, with no path specified:
```yaml
---
title: My page
permalink: mypageurl.html
---
```
## Extensionless permalinks with no trailing slashes {#extensionless-permalinks}
Jekyll supports permalinks that contain neither a trailing slash nor a file extension, but this requires additional support from the web server to properly serve. When using these types of permalinks, output files written to disk will still have the proper file extension (typically `.html`), so the web server must be able to map requests without file extensions to these files.
Both [GitHub Pages](../github-pages/) and the Jekyll's built-in WEBrick server handle these requests properly without any additional work.
### Apache
The Apache web server has extensive support for content negotiation and can handle extensionless URLs by setting the [multiviews](https://httpd.apache.org/docs/current/content-negotiation.html#multiviews) option in your `httpd.conf` or `.htaccess` file:
{% highlight apache %}
Options +MultiViews
{% endhighlight %}
### Nginx
The [try_files](http://nginx.org/en/docs/http/ngx_http_core_module.html#try_files) directive allows you to specify a list of files to search for to process a request. The following configuration will instruct nginx to search for a file with an `.html` extension if an exact match for the requested URI is not found.
{% highlight nginx %}
try_files $uri $uri.html $uri/ =404;
{% endhighlight %}
## Linking without regard to permalink styles
You can create links in your topics to other posts, pages, or collection items in a way that is valid no matter what permalink configuration you choose. By using the `link` tag, if you change your permalinks, your links won't break. See [Linking to pages](../templates#link) in Templates for more details.

View File

@@ -1,946 +0,0 @@
---
title: Plugins
permalink: /docs/plugins/
---
Jekyll has a plugin system with hooks that allow you to create custom generated
content specific to your site. You can run custom code for your site without
having to modify the Jekyll source itself.
<div class="note info">
<h5>Plugins on GitHub Pages</h5>
<p>
<a href="https://pages.github.com/">GitHub Pages</a> is powered by Jekyll.
However, all Pages sites are generated using the <code>--safe</code> option
to disable custom plugins for security reasons. Unfortunately, this means
your plugins wont work if youre deploying to GitHub Pages.<br><br>
You can still use GitHub Pages to publish your site, but youll need to
convert the site locally and push the generated static files to your GitHub
repository instead of the Jekyll source files.
</p>
</div>
## Installing a plugin
You have 3 options for installing plugins:
1. In your site source root, make a `_plugins` directory. Place your plugins
here. Any file ending in `*.rb` inside this directory will be loaded before
Jekyll generates your site.
2. In your `_config.yml` file, add a new array with the key `plugins` (or `gems` for Jekyll < `3.5.0`) and the
values of the gem names of the plugins you'd like to use. An example:
```yaml
# This will require each of these plugins automatically.
plugins:
- jekyll-gist
- jekyll-coffeescript
- jekyll-assets
- another-jekyll-plugin
```
Then install your plugins using `gem install jekyll-gist jekyll-coffeescript jekyll-assets another-jekyll-plugin`
3. Add the relevant plugins to a Bundler group in your `Gemfile`. An
example:
```ruby
group :jekyll_plugins do
gem "jekyll-gist"
gem "jekyll-coffeescript"
gem "jekyll-assets"
gem "another-jekyll-plugin"
end
```
Now you need to install all plugins from your Bundler group by running single command `bundle install`.
<div class="note info">
<h5>
<code>_plugins</code>, <code>_config.yml</code> and <code>Gemfile</code>
can be used simultaneously
</h5>
<p>
You may use any of the aforementioned plugin options simultaneously in the
same site if you so choose. Use of one does not restrict the use of the
others.
</p>
</div>
### The jekyll_plugins group
Jekyll gives this particular group of gems in your `Gemfile` a different
treatment. Any gem included in this group is loaded before Jekyll starts
processing the rest of your source directory.
A gem included here will be activated even if its not explicitly listed under
the `plugins:` key in your site's config file.
<div class="note warning">
<p>
Gems included in the <code>:jekyll-plugins</code> group are activated
regardless of the <code>--safe</code> mode setting. Be aware of what
gems are included under this group!
</p>
</div>
In general, plugins you make will fall broadly into one of five categories:
1. [Generators](#generators)
2. [Converters](#converters)
3. [Commands](#commands)
4. [Tags](#tags)
5. [Hooks](#hooks)
See the bottom of the page for a [list of available plugins](#available-plugins).
For further information on how to develop your own plugins, check out the [Liquid documentation](https://github.com/Shopify/liquid/wiki/Liquid-for-Programmers) as well.
If you never developed a Jekyll plugin [check this useful wrap-up](https://ayastreb.me/writing-a-jekyll-plugin/) by @ayastreb to get started.
## Generators
You can create a generator when you need Jekyll to create additional content
based on your own rules.
A generator is a subclass of `Jekyll::Generator` that defines a `generate`
method, which receives an instance of
[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb). The
return value of `generate` is ignored.
Generators run after Jekyll has made an inventory of the existing content, and
before the site is generated. Pages with YAML Front Matters are stored as
instances of
[`Jekyll::Page`]({{ site.repository }}/blob/master/lib/jekyll/page.rb)
and are available via `site.pages`. Static files become instances of
[`Jekyll::StaticFile`]({{ site.repository }}/blob/master/lib/jekyll/static_file.rb)
and are available via `site.static_files`. See
[the Variables documentation page](/docs/variables/) and
[`Jekyll::Site`]({{ site.repository }}/blob/master/lib/jekyll/site.rb)
for more details.
For instance, a generator can inject values computed at build time for template
variables. In the following example the template `reading.html` has two
variables `ongoing` and `done` that we fill in the generator:
```ruby
module Reading
class Generator < Jekyll::Generator
def generate(site)
ongoing, done = Book.all.partition(&:ongoing?)
reading = site.pages.detect {|page| page.name == 'reading.html'}
reading.data['ongoing'] = ongoing
reading.data['done'] = done
end
end
end
```
This is a more complex generator that generates new pages:
```ruby
module Jekyll
class CategoryPage < Page
def initialize(site, base, dir, category)
@site = site
@base = base
@dir = dir
@name = 'index.html'
self.process(@name)
self.read_yaml(File.join(base, '_layouts'), 'category_index.html')
self.data['category'] = category
category_title_prefix = site.config['category_title_prefix'] || 'Category: '
self.data['title'] = "#{category_title_prefix}#{category}"
end
end
class CategoryPageGenerator < Generator
safe true
def generate(site)
if site.layouts.key? 'category_index'
dir = site.config['category_dir'] || 'categories'
site.categories.each_key do |category|
site.pages << CategoryPage.new(site, site.source, File.join(dir, category), category)
end
end
end
end
end
```
In this example, our generator will create a series of files under the
`categories` directory for each category, listing the posts in each category
using the `category_index.html` layout.
Generators are only required to implement one method:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>generate</code></p>
</td>
<td>
<p>Generates content as a side-effect.</p>
</td>
</tr>
</tbody>
</table>
</div>
## Converters
If you have a new markup language youd like to use with your site, you can
include it by implementing your own converter. Both the Markdown and
[Textile](https://github.com/jekyll/jekyll-textile-converter) markup
languages are implemented using this method.
<div class="note info">
<h5>Remember your YAML Front Matter</h5>
<p>
Jekyll will only convert files that have a YAML header at the top, even for
converters you add using a plugin.
</p>
</div>
Below is a converter that will take all posts ending in `.upcase` and process
them using the `UpcaseConverter`:
```ruby
module Jekyll
class UpcaseConverter < Converter
safe true
priority :low
def matches(ext)
ext =~ /^\.upcase$/i
end
def output_ext(ext)
".html"
end
def convert(content)
content.upcase
end
end
end
```
Converters should implement at a minimum 3 methods:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>matches</code></p>
</td>
<td><p>
Does the given extension match this converters list of acceptable
extensions? Takes one argument: the files extension (including the
dot). Must return <code>true</code> if it matches, <code>false</code>
otherwise.
</p></td>
</tr>
<tr>
<td>
<p><code>output_ext</code></p>
</td>
<td><p>
The extension to be given to the output file (including the dot).
Usually this will be <code>".html"</code>.
</p></td>
</tr>
<tr>
<td>
<p><code>convert</code></p>
</td>
<td><p>
Logic to do the content conversion. Takes one argument: the raw content
of the file (without YAML Front Matter). Must return a String.
</p></td>
</tr>
</tbody>
</table>
</div>
In our example, `UpcaseConverter#matches` checks if our filename extension is
`.upcase`, and will render using the converter if it is. It will call
`UpcaseConverter#convert` to process the content. In our simple converter were
simply uppercasing the entire content string. Finally, when it saves the page,
it will do so with a `.html` extension.
## Commands
As of version 2.5.0, Jekyll can be extended with plugins which provide
subcommands for the `jekyll` executable. This is possible by including the
relevant plugins in a `Gemfile` group called `:jekyll_plugins`:
```ruby
group :jekyll_plugins do
gem "my_fancy_jekyll_plugin"
end
```
Each `Command` must be a subclass of the `Jekyll::Command` class and must
contain one class method: `init_with_program`. An example:
```ruby
class MyNewCommand < Jekyll::Command
class << self
def init_with_program(prog)
prog.command(:new) do |c|
c.syntax "new [options]"
c.description 'Create a new Jekyll site.'
c.option 'dest', '-d DEST', 'Where the site should go.'
c.action do |args, options|
Jekyll::Site.new_site_at(options['dest'])
end
end
end
end
end
```
Commands should implement this single class method:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>init_with_program</code></p>
</td>
<td><p>
This method accepts one parameter, the
<code><a href="https://github.com/jekyll/mercenary#readme">Mercenary::Program</a></code>
instance, which is the Jekyll program itself. Upon the program,
commands may be created using the above syntax. For more details,
visit the Mercenary repository on GitHub.com.
</p></td>
</tr>
</tbody>
</table>
</div>
## Tags
If youd like to include custom liquid tags in your site, you can do so by
hooking into the tagging system. Built-in examples added by Jekyll include the
`highlight` and `include` tags. Below is an example of a custom liquid tag that
will output the time the page was rendered:
```ruby
module Jekyll
class RenderTimeTag < Liquid::Tag
def initialize(tag_name, text, tokens)
super
@text = text
end
def render(context)
"#{@text} #{Time.now}"
end
end
end
Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
```
At a minimum, liquid tags must implement:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>render</code></p>
</td>
<td>
<p>Outputs the content of the tag.</p>
</td>
</tr>
</tbody>
</table>
</div>
You must also register the custom tag with the Liquid template engine as
follows:
```ruby
Liquid::Template.register_tag('render_time', Jekyll::RenderTimeTag)
```
In the example above, we can place the following tag anywhere in one of our
pages:
{% raw %}
```ruby
<p>{% render_time page rendered at: %}</p>
```
{% endraw %}
And we would get something like this on the page:
```html
<p>page rendered at: Tue June 22 23:38:47 0500 2010</p>
```
### Liquid filters
You can add your own filters to the Liquid template system much like you can
add tags above. Filters are simply modules that export their methods to liquid.
All methods will have to take at least one parameter which represents the input
of the filter. The return value will be the output of the filter.
```ruby
module Jekyll
module AssetFilter
def asset_url(input)
"http://www.example.com/#{input}?#{Time.now.to_i}"
end
end
end
Liquid::Template.register_filter(Jekyll::AssetFilter)
```
<div class="note">
<h5>ProTip™: Access the site object using Liquid</h5>
<p>
Jekyll lets you access the <code>site</code> object through the
<code>context.registers</code> feature of Liquid at <code>context.registers[:site]</code>. For example, you can
access the global configuration file <code>_config.yml</code> using
<code>context.registers[:site].config</code>.
</p>
</div>
### Flags
There are two flags to be aware of when writing a plugin:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Flag</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>safe</code></p>
</td>
<td>
<p>
A boolean flag that informs Jekyll whether this plugin may be safely
executed in an environment where arbitrary code execution is not
allowed. This is used by GitHub Pages to determine which core plugins
may be used, and which are unsafe to run. If your plugin does not
allow for arbitrary code execution, set this to <code>true</code>.
GitHub Pages still wont load your plugin, but if you submit it for
inclusion in core, its best for this to be correct!
</p>
</td>
</tr>
<tr>
<td>
<p><code>priority</code></p>
</td>
<td>
<p>
This flag determines what order the plugin is loaded in. Valid values
are: <code>:lowest</code>, <code>:low</code>, <code>:normal</code>,
<code>:high</code>, and <code>:highest</code>. Highest priority
matches are applied first, lowest priority are applied last.
</p>
</td>
</tr>
</tbody>
</table>
</div>
To use one of the example plugins above as an illustration, here is how youd
specify these two flags:
```ruby
module Jekyll
class UpcaseConverter < Converter
safe true
priority :low
...
end
end
```
## Hooks
Using hooks, your plugin can exercise fine-grained control over various aspects
of the build process. If your plugin defines any hooks, Jekyll will call them
at pre-defined points.
Hooks are registered to a container and an event name. To register one, you
call Jekyll::Hooks.register, and pass the container, event name, and code to
call whenever the hook is triggered. For example, if you want to execute some
custom functionality every time Jekyll renders a post, you could register a
hook like this:
```ruby
Jekyll::Hooks.register :posts, :post_render do |post|
# code to call after Jekyll renders a post
end
```
Jekyll provides hooks for <code>:site</code>, <code>:pages</code>,
<code>:posts</code>, and <code>:documents</code>. In all cases, Jekyll calls
your hooks with the container object as the first callback parameter. However,
all `:pre_render` hooks and the`:site, :post_render` hook will also provide a
payload hash as a second parameter. In the case of `:pre_render`, the payload
gives you full control over the variables that are available while rendering.
In the case of `:site, :post_render`, the payload contains final values after
rendering all the site (useful for sitemaps, feeds, etc).
The complete list of available hooks is below:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Container</th>
<th>Event</th>
<th>Called</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:after_init</code></p>
</td>
<td>
<p>Just after the site initializes, but before setup & render. Good
for modifying the configuration of the site.</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:after_reset</code></p>
</td>
<td>
<p>Just after site reset</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:post_read</code></p>
</td>
<td>
<p>After site data has been read and loaded from disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering the whole site</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering the whole site, but before writing any files</p>
</td>
</tr>
<tr>
<td>
<p><code>:site</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing the whole site to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:post_init</code></p>
</td>
<td>
<p>Whenever a page is initialized</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering a page</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering a page, but before writing it to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:pages</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing a page to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:post_init</code></p>
</td>
<td>
<p>Whenever a post is initialized</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering a post</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering a post, but before writing it to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:posts</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing a post to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:post_init</code></p>
</td>
<td>
<p>Whenever a document is initialized</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:pre_render</code></p>
</td>
<td>
<p>Just before rendering a document</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:post_render</code></p>
</td>
<td>
<p>After rendering a document, but before writing it to disk</p>
</td>
</tr>
<tr>
<td>
<p><code>:documents</code></p>
</td>
<td>
<p><code>:post_write</code></p>
</td>
<td>
<p>After writing a document to disk</p>
</td>
</tr>
</tbody>
</table>
</div>
## Available Plugins
You can find a few useful plugins at the following locations:
#### Generators
- [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.
- [Pageless Redirect Generator by Nick Quinlan](https://github.com/nquinlan/jekyll-pageless-redirects): Generates redirects based on files in the Jekyll root, with support for htaccess style redirects.
- [RssGenerator by Assaf Gelber](https://github.com/agelber/jekyll-rss): Automatically creates an RSS 2.0 feed from your posts.
- [Monthly archive generator by Shigeya Suzuki](https://github.com/shigeya/jekyll-monthly-archive-plugin): Generator and template which renders monthly archive like MovableType style, based on the work by Ilkka Laukkanen and others above.
- [Category archive generator by Shigeya Suzuki](https://github.com/shigeya/jekyll-category-archive-plugin): Generator and template which renders category archive like MovableType style, based on Monthly archive generator.
- [Emoji for Jekyll](https://github.com/yihangho/emoji-for-jekyll): Seamlessly enable emoji for all posts and pages.
- [Compass integration for Jekyll](https://github.com/mscharley/jekyll-compass): Easily integrate Compass and Sass with your Jekyll website.
- [Pages Directory by Ben Baker-Smith](https://github.com/bbakersmith/jekyll-pages-directory): Defines a `_pages` directory for page files which routes its output relative to the project root.
- [Page Collections by Jeff Kolesky](https://github.com/jeffkole/jekyll-page-collections): Generates collections of pages with functionality that resembles posts.
- [Windows 8.1 Live Tile Generation by Matt Sheehan](https://github.com/sheehamj13/jekyll-live-tiles): Generates Internet Explorer 11 config.xml file and Tile Templates for pinning your site to Windows 8.1.
- [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 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.
- [Jekyll Flickr Plugin](https://github.com/lawmurray/indii-jekyll-flickr) by [Lawrence Murray](http://www.indii.org): Generates posts for photos uploaded to a Flickr photostream.
- [Jekyll::Paginate::Category](https://github.com/midnightSuyama/jekyll-paginate-category): Pagination Generator for Jekyll Category.
- [AMP-Jekyll by Juuso Mikkonen](https://github.com/juusaw/amp-jekyll): Generate [Accelerated Mobile Pages](https://www.ampproject.org) of Jekyll posts.
- [Jekyll Art Gallery plugin](https://github.com/alexivkin/Jekyll-Art-Gallery-Plugin): An advanced art/photo gallery generation plugin for creating galleries from a set of image folders. Supports image tagging, thumbnails, sorting, image rotation, post-processing (remove EXIF, add watermark), multiple collections and much more.
- [jekyll-ga](https://github.com/developmentseed/jekyll-ga): A Jekyll plugin that downloads Google Analytics data and adds it to posts. Useful for making a site that lists "most popular" content. [Read the introduction](https://developmentseed.org/blog/google-analytics-jekyll-plugin/) post on the developmentSEED blog.
- [jekyll-multi-paginate](https://github.com/fadhilnapis/jekyll-multi-paginate): Simple Jekyll paginator for multiple page. Ease you to make pagination on multiple page especially like multiple language.
- [jekyll-category-pages](https://github.com/field-theory/jekyll-category-pages): Easy-to-use category index pages with and without pagination. Supports non-URL-safe category keywords and has extensive documentation and test coverage.
- [Tweetsert](https://github.com/ibrado/jekyll-tweetsert): Imports tweets (Twitter statuses) as new posts. Features multiple timeline support, hashtag import, filtering, automatic category and/or tags, optional retweets and replies.
- [Stickyposts](https://github.com/ibrado/jekyll-stickyposts): Moves or copies (pins) posts marked `sticky: true` to the top of the list. Perfect for keeping important announcements on the home page, or giving collections a descriptive entry. Paginator friendly.
- [Jekyll::Paginate::Content](https://github.com/ibrado/jekyll-paginate-content): Content paginator in the style of jekyll-paginator-v2 that splits pages, posts, and collection entries into several pages. Specify a separator or use HTML &lt;h1&gt; 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.
- [Markdown References by Olov Lassus](https://github.com/olov/jekyll-references): Keep all your markdown reference-style link definitions in one \_references.md file.
- [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 pandocs markdown extensions.
- [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/).
- [Lazy Tweet Embedding](https://github.com/takuti/jekyll-lazy-tweet-embedding): Automatically convert tweet urls into twitter cards.
- [jekyll-commonmark](https://github.com/pathawks/jekyll-commonmark): Markdown converter that uses [libcmark](https://github.com/jgm/CommonMark), the reference parser for CommonMark.
#### Filters
- [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.
- [Smilify](https://github.com/SaswatPadhi/jekyll_smilify) by [SaswatPadhi](https://github.com/SaswatPadhi): Convert text emoticons in your content to themeable smiley pics.
- [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.
- [Table of Content Generator](https://github.com/dafi/jekyll-toc-generator): Generate the HTML code containing a table of content (TOC), the TOC can be customized in many way, for example you can decide which pages can be without TOC.
- [jekyll-toc](https://github.com/toshimaru/jekyll-toc): A liquid filter plugin for Jekyll which generates a table of contents.
- [jekyll-humanize](https://github.com/23maverick23/jekyll-humanize): This is a port of the Django app humanize which adds a "human touch" to data. Each method represents a Fluid type filter that can be used in your Jekyll site templates. Given that Jekyll produces static sites, some of the original methods do not make logical sense to port (e.g. naturaltime).
- [Jekyll-Ordinal](https://github.com/PatrickC8t/Jekyll-Ordinal): Jekyll liquid filter to output a date ordinal such as "st", "nd", "rd", or "th".
- [Deprecated articles keeper](https://github.com/kzykbys/JekyllPlugins) by [Kazuya Kobayashi](http://blog.kazuya.co/): A simple Jekyll filter which monitor how old an article is.
- [Jekyll-jalali](https://github.com/mehdisadeghi/jekyll-jalali) by [Mehdi Sadeghi](http://mehdix.ir): A simple Gregorian to Jalali date converter filter.
- [Jekyll Thumbnail Filter](https://github.com/matallo/jekyll-thumbnail-filter): Related posts thumbnail filter.
- [liquid-md5](https://github.com/pathawks/liquid-md5): Returns an MD5 hash. Helpful for generating Gravatars in templates.
- [jekyll-roman](https://github.com/paulrobertlloyd/jekyll-roman): A liquid filter for Jekyll that converts numbers into Roman numerals.
- [jekyll-typogrify](https://github.com/myles/jekyll-typogrify): A Jekyll plugin that brings the functions of [typogruby](http://avdgaag.github.io/typogruby/).
- [Jekyll Email Protect](https://github.com/vwochnik/jekyll-email-protect): Email protection liquid filter for Jekyll
- [Jekyll Uglify Filter](https://github.com/mattg/jekyll-uglify-filter): A Liquid filter that runs your JavaScript through UglifyJS.
- [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
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.
- [Embed.ly client by Robert Böhnke](https://github.com/robb/jekyll-embedly-client): Autogenerate embeds from URLs using 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 Twitters 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.
- [Jekyll-beastiepress](https://github.com/okeeblow/jekyll-beastiepress): FreeBSD utility tags for Jekyll sites.
- [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.
- [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.
- [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 Jehls [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.
- [Jekyll Responsive Image](https://github.com/wildlyinaccurate/jekyll-responsive-image): Responsive images for Jekyll. Automatically resizes images, supports all responsive methods (`<picture>`, `srcset`, Imager.js, etc), super-flexible configuration.
- [Ditaa Tag](https://github.com/matze/jekyll-ditaa) by [matze](https://github.com/matze): Renders ASCII diagram art into PNG images and inserts a figure tag.
- [Jekyll Suggested Tweet](https://github.com/davidensinger/jekyll-suggested-tweet) by [David Ensinger](https://github.com/davidensinger/): A Liquid tag for Jekyll that allows for the embedding of suggested tweets via Twitters Web Intents API.
- [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.
- [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.
- [Jekyll Project Version Tag](https://github.com/rob-murray/jekyll-version-plugin): A Liquid tag plugin that renders a version identifier for your Jekyll site sourced from the git repository containing your code.
- [Piwigo Gallery](https://github.com/AlessandroLorenzi/piwigo_gallery) by [Alessandro Lorenzi](http://blog.alorenzi.eu/): Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag
- [mathml.rb](https://github.com/tmthrgd/jekyll-plugins) by Tom Thorogood: A plugin to convert TeX mathematics into MathML for display.
- [webmention_io.rb](https://github.com/aarongustafson/jekyll-webmention_io) by [Aaron Gustafson](http://aaron-gustafson.com/): A plugin to enable [webmention](https://indieweb.org/webmention) integration using [Webmention.io](https://webmention.io/). Includes an optional JavaScript for updating webmentions automatically between publishes and, if available, in realtime using WebSockets.
- [Jekyll 500px Embed](https://github.com/lkorth/jekyll-500px-embed) by Luke Korth. A Liquid tag plugin that embeds [500px](https://500px.com/) photos.
- [inline\_highlight](https://github.com/bdesham/inline_highlight): A tag for inline syntax highlighting.
- [jekyll-mermaid](https://github.com/jasonbellamy/jekyll-mermaid): Simplify the creation of mermaid diagrams and flowcharts in your posts and pages.
- [twa](https://github.com/Ezmyrelda/twa): Twemoji Awesome plugin for Jekyll. Liquid tag allowing you to use twitter emoji in your jekyll pages.
- [Fetch remote file content](https://github.com/dimitri-koenig/jekyll-plugins) by [Dimitri König](https://www.dimitrikoenig.net/): Using `remote_file_content` tag you can fetch the content of a remote file and include it as if you would put the content right into your markdown file yourself. Very useful for including code from github repo's to always have a current repo version.
- [jekyll-asciinema](https://github.com/mnuessler/jekyll-asciinema): A tag for embedding asciicasts recorded with [asciinema](https://asciinema.org) in your Jekyll pages.
- [Jekyll-Youtube](https://github.com/dommmel/jekyll-youtube) A Liquid tag that embeds Youtube videos. The default emded markup is responsive but you can also specify your own by using an include/partial.
- [Jekyll Flickr Plugin](https://github.com/lawmurray/indii-jekyll-flickr) by [Lawrence Murray](http://www.indii.org): Embeds Flickr photosets (albums) as a gallery of thumbnails, with lightbox links to larger images.
- [jekyll-figure](https://github.com/paulrobertlloyd/jekyll-figure): A liquid tag for Jekyll that generates `<figure>` elements.
- [Jekyll Video Embed](https://github.com/eug/jekyll-video-embed): It provides several tags to easily embed videos (e.g. Youtube, Vimeo, UStream and Ted Talks)
- [jekyll-i18n_tags](https://github.com/KrzysiekJ/jekyll-i18n_tags): Translate your templates.
- [Jekyll Ideal Image Slider](https://github.com/jekylltools/jekyll-ideal-image-slider): Liquid tag plugin to create image sliders using [Ideal Image Slider](https://github.com/gilbitron/Ideal-Image-Slider).
- [Jekyll Tags List Plugin](https://github.com/crispgm/jekyll-tags-list-plugin): A Liquid tag plugin that creates tags list in specific order.
- [Jekyll Maps](https://github.com/ayastreb/jekyll-maps) by [Anatoliy Yastreb](https://github.com/ayastreb): A Jekyll plugin to easily embed maps with filterable locations.
- [Jekyll Cloudinary](https://nhoizey.github.io/jekyll-cloudinary/) by [Nicolas Hoizey](https://nicolas-hoizey.com/): a Jekyll plugin adding a Liquid tag to ease the use of Cloudinary for responsive images in your Markdown/Kramdown posts.
- [jekyll-include-absolute-plugin](https://github.com/tnhu/jekyll-include-absolute-plugin) by [Tan Nhu](https://github.com/tnhu): A Jekyll plugin to include a file from its path relative to Jekyll's source folder.
- [Jekyll Download Tag](https://github.com/mattg/jekyll-download-tag): A Liquid tag that acts like `include`, but for external resources.
- [Jekyll Brand Social Wall](https://github.com/MediaComem/jekyll-brand-social-wall): A jekyll plugin to generate a social wall with your favorite social networks
- [Jekyll If File Exists](https://github.com/k-funk/jekyll-if-file-exists): A Jekyll Plugin that checks if a file exists with an if/else block.
- [BibSonomy](https://github.com/rjoberon/bibsonomy-jekyll): Jekyll
plugin to generate publication lists from [BibSonomy](https://www.bibsonomy.org/).
- [github-cards](https://github.com/edward-shen/github-cards): Creates styleable Github cards for your Github projects.
- [disqus-for-jekyll](https://github.com/kacperduras/disqus-for-jekyll): A Jekyll plugin to view the comments powered by Disqus.
- [jekyll-html](https://github.com/kacperduras/jekyll-html): A Jekyll plugin to use HTML tags in Jekyll pages, posts and collections.
- [jekyll-onebox](https://github.com/rriemann/jekyll-onebox): Liquid tag for displaying HTML previews (embeds) for links to popular domains. Plugin is based on [Onebox](https://github.com/discourse/onebox) that powers link previews in [Discourse](http://github.com/discourse/discourse) forums.
- [jekyll-w2m](https://github.com/kacperduras/jekyll-w2m): A Jekyll plugin to liberate content from Microsoft Word documents (powered by [word-to-markdown](https://github.com/benbalter/word-to-markdown)).
- [jekyll-flickr](https://github.com/rriemann/jekyll-flickr): Liquid tag for responsive Flickr images using HTML5 srcset. Subtitles and automatic license notices are supported.
#### Collections
- [Jekyll Plugins by Recursive Design](https://github.com/recurser/jekyll-plugins): Plugins to generate Project pages from GitHub readmes, a Category page, and a Sitemap generator.
- [Company website and blog plugins](https://github.com/flatterline/jekyll-plugins) by Flatterline, a Ruby on Rails development company: Portfolio/project page generator, team/individual page generator, an author bio liquid tag for use on posts, and a few other smaller plugins.
- [Jekyll plugins by Aucor](https://github.com/aucor/jekyll-plugins): Plugins for trimming unwanted newlines/whitespace and sorting pages by weight attribute.
#### Other
- [Analytics for Jekyll](https://github.com/hendrikschneider/jekyll-analytics) by Hendrik Schneider: An effortless way to add various trackers like Google Analytics, Matomo (formerly Piwik), mPulse, etc. to your site.
- [ditaa-ditaa](https://github.com/tmthrgd/ditaa-ditaa) by Tom Thorogood: a drastic revision of jekyll-ditaa that renders diagrams drawn using ASCII art into PNG images.
- [Pygments Cache Path by Raimonds Simanovskis](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb): Plugin to cache syntax-highlighted code from Pygments.
- [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).
- [Jekyll-localization](https://github.com/blackwinter/jekyll-localization): Jekyll plugin that adds localization features to the rendering engine.
- [Jekyll-rendering](https://github.com/blackwinter/jekyll-rendering): Jekyll plugin to provide alternative rendering engines.
- [Jekyll-pagination](https://github.com/blackwinter/jekyll-pagination): Jekyll plugin to extend the pagination generator.
- [Jekyll-tagging](https://github.com/pattex/jekyll-tagging): Jekyll plugin to automatically generate a tag cloud and tag pages.
- [Jekyll-scholar](https://github.com/inukshuk/jekyll-scholar): Jekyll extensions for the blogging scholar.
- [Jekyll-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.
- [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.
- [grunt-jekyll](https://github.com/dannygarcia/grunt-jekyll): A straightforward [Grunt](http://gruntjs.com/) plugin for Jekyll.
- [jekyll-postfiles](https://github.com/indirect/jekyll-postfiles): Add `_postfiles` directory and {% raw %}`{{ postfile }}`{% endraw %} tag so the files a post refers to will always be right there inside your repo.
- [A layout that compresses HTML](http://jch.penibelst.de/): GitHub Pages compatible, configurable way to compress HTML files on site build.
- [Jekyll CO₂](https://github.com/wdenton/jekyll-co2): Generates HTML showing the monthly change in atmospheric CO₂ at the Mauna Loa observatory in Hawaii.
- [remote-include](http://www.northfieldx.co.uk/remote-include/): Includes files using remote URLs
- [jekyll-minifier](https://github.com/digitalsparky/jekyll-minifier): Minifies HTML, XML, CSS, and Javascript both inline and as separate files utilising yui-compressor and htmlcompressor.
- [Jekyll views router](https://bitbucket.org/nyufac/jekyll-views-router): Simple router between generator plugins and templates.
- [Jekyll Language Plugin](https://github.com/vwochnik/jekyll-language-plugin): Jekyll 3.0-compatible multi-language plugin for posts, pages and includes.
- [Jekyll Deploy](https://github.com/vwochnik/jekyll-deploy): Adds a `deploy` sub-command to Jekyll.
- [Official Contentful Jekyll Plugin](https://github.com/contentful/jekyll-contentful-data-import): Adds a `contentful` sub-command to Jekyll to import data from Contentful.
- [jekyll-paspagon](https://github.com/KrzysiekJ/jekyll-paspagon): Sell your posts in various formats for cryptocurrencies.
- [Hawkins](https://github.com/awood/hawkins): Adds a `liveserve` sub-command to Jekyll that incorporates [LiveReload](http://livereload.com/) into your pages while you preview them. No more hitting the refresh button in your browser!
- [Jekyll Autoprefixer](https://github.com/vwochnik/jekyll-autoprefixer): Autoprefixer integration for Jekyll
- [Jekyll-breadcrumbs](https://github.com/git-no/jekyll-breadcrumbs): Creates breadcrumbs for Jekyll 3.x, includes features like SEO optimization, optional breadcrumb item translation and more.
- [generator-jekyllized](https://github.com/sondr3/generator-jekyllized): A Yeoman generator for rapidly developing sites with Gulp. Live reload your site, automatically minify and optimize your assets and much more.
- [Jekyll-Spotify](https://github.com/MertcanGokgoz/Jekyll-Spotify): Easily output Spotify Embed Player for jekyll
- [jekyll-menus](https://github.com/forestryio/jekyll-menus): Hugo style menus for your Jekyll site... recursive menus included.
- [jekyll-data](https://github.com/ashmaroli/jekyll-data): Read data files within Jekyll Theme Gems.
- [jekyll-pinboard](https://github.com/snaptortoise/jekyll-pinboard-plugin): Access your Pinboard bookmarks within your Jekyll theme.
- [jekyll-migrate-permalink](https://github.com/mpchadwick/jekyll-migrate-permalink): Adds a `migrate-permalink` sub-command to help deal with side effects of changing your permalink.
- [Jekyll-Post](https://github.com/robcrocombe/jekyll-post): A CLI tool to easily draft, edit, and publish Jekyll posts.
- [jekyll-numbered-headings](https://github.com/muratayusuke/jekyll-numbered-headings): Adds ordered number to headings.
- [jekyll-pre-commit](https://github.com/mpchadwick/jekyll-pre-commit): A framework for running checks against your posts using a git pre-commit hook before you publish them.
- [jekyll-pwa-plugin](https://github.com/lavas-project/jekyll-pwa): A plugin provides PWA support for Jekyll. It generates a service worker in Jekyll build process and makes precache and runtime cache available in the runtime with Google Workbox.
- [jekyll-algolia](https://community.algolia.com/jekyll-algolia/): Add fast and relevant search to your Jekyll site through the Algolia API.
<div class="note info">
<h5>Submit your gem plugins</h5>
<p>
You're encouraged to add your Jekyll gem plugins to this list, <a href="../contributing/">read the contributing page</a> to find
out how to make that happen.
</p>
</div>

View File

@@ -1,334 +0,0 @@
---
title: Writing posts
permalink: /docs/posts/
---
One of Jekylls best aspects is that it is “blog aware”. What does this mean,
exactly? Well, simply put, it means that blogging is baked into Jekylls
functionality. If you write articles and publish them online, you can publish
and maintain a blog simply by managing a folder of text-files on your computer.
Compared to the hassle of configuring and maintaining databases and web-based
CMS systems, this will be a welcome change!
## The Posts Folder
As explained on the [directory structure](../structure/) page, the `_posts`
folder is where your blog posts will live. These files are generally
[Markdown](https://daringfireball.net/projects/markdown/) or HTML, but can
be other formats with the proper converter installed.
All posts must have [YAML Front Matter](../frontmatter/), and they will be
converted from their source format into an HTML page that is part of your
static site.
### Creating Post Files
To create a new post, all you need to do is create a file in the `_posts`
directory. How you name files in this folder is important. Jekyll requires blog
post files to be named according to the following format:
```
YEAR-MONTH-DAY-title.MARKUP
```
Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit
numbers, and `MARKUP` is the file extension representing the format used in the
file. For example, the following are examples of valid post filenames:
```
2011-12-31-new-years-eve-is-awesome.md
2012-09-12-how-to-write-a-blog.md
```
<div class="note">
<h5>ProTip™: Link to other posts</h5>
<p>
Use the <a href="../templates/#linking-to-posts"><code>post_url</code></a>
tag to link to other posts without having to worry about the URLs
breaking when the site permalink style changes.
</p>
</div>
### Content Formats
All blog post files must begin with [YAML Front Matter](../frontmatter/). After
that, it's simply a matter of deciding which format you prefer. Jekyll supports
[Markdown](https://daringfireball.net/projects/markdown/) out of the box,
and has [myriad extensions for other formats as well](/docs/plugins/#converters-1),
including the popular [Textile](http://redcloth.org/textile) format. These
formats each have their own way of marking up different types of content
within a post, so you should familiarize yourself with these formats and
decide which one best suits your needs.
<div class="note info">
<h5>Be aware of character sets</h5>
<p>
Content processors can modify certain characters to make them look nicer.
For example, the <code>smart</code> extension in Redcarpet converts standard,
ASCII quotation characters to curly, Unicode ones. In order for the browser
to display those characters properly, define the charset meta value by
including <code>&lt;meta charset=&quot;utf-8&quot;&gt;</code> in the
<code>&lt;head&gt;</code> of your layout.
</p>
</div>
## Including images and resources
Chances are, at some point, you'll want to include images, downloads, or other
digital assets along with your text content. While the syntax for linking to
these resources differs between Markdown and Textile, the problem of working
out where to store these files in your site is something everyone will face.
There are a number of ways to include digital assets in Jekyll.
One common solution is to create a folder in the root of the project directory
called something like `assets`, into which any images, files
or other resources are placed. Then, from within any post, they can be linked
to using the sites root as the path for the asset to include. Again, this will
depend on the way your sites (sub)domain and path are configured, but here are
some examples in Markdown of how you could do this using the `absolute_url`
filter in a post.
Including an image asset in a post:
{% raw %}
```markdown
... which is shown in the screenshot below:
![My helpful screenshot]({{ "/assets/screenshot.jpg" | absolute_url }})
```
{% endraw %}
Linking to a PDF for readers to download:
{% raw %}
```markdown
... you can [get the PDF]({{ "/assets/mydoc.pdf" | absolute_url }}) directly.
```
{% endraw %}
<div class="info">
</div>
## A typical post
Jekyll can handle many different iterations of the idea you might associate with a "post," however a standard blog style post, including a Title, Layout, Publishing Date, and Categories might look like this:
```markdown
---
layout: post
title: "Welcome to Jekyll!"
date: 2015-11-17 16:16:01 -0600
categories: jekyll update
---
Youll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `bundle exec jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated.
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
```
Everything in between the first and second `---` are part of the YAML Front Matter, and everything after the second `---` will be rendered with Markdown and show up as "Content".
## Displaying an index of posts
Its all well and good to have posts in a folder, but a blog is no use unless
you have a list of posts somewhere. Creating an index of posts on another page
(or in a [template](../templates/)) is easy, thanks to the [Liquid template
language](https://docs.shopify.com/themes/liquid/basics) and its tags. Heres a
basic example of how to create a list of links to your blog posts:
{% raw %}
```html
<ul>
{% for post in site.posts %}
<li>
<a href="{{ post.url }}">{{ post.title }}</a>
</li>
{% endfor %}
</ul>
```
{% endraw %}
Of course, you have full control over how (and where) you display your posts,
and how you structure your site. You should read more about [how templates
work](../templates/) with Jekyll if you want to know more.
Note that the `post` variable only exists inside the `for` loop above. If
you wish to access the currently-rendering page/posts's variables (the
variables of the post/page that has the `for` loop in it), use the `page`
variable instead.
## Displaying post categories or tags
Hey, that's pretty neat, but what about showing just some of your posts that are
related to each other? For that you can use any of the [variables definable in
Front Matter](https://jekyllrb.com/docs/frontmatter/). In the "typical post"
section you can see how to define categories. Simply add the categories to your
Front Matter as a [yaml
list](https://en.wikipedia.org/wiki/YAML#Basic_components).
Now that your posts have a category or multiple categories, you can make a page
or a template displaying just the posts in those categories you specify. Here's
a basic example of how to create a list of posts from a specific category.
First, in the `_layouts` directory create a new file called `category.html` - in
that file put (at least) the following:
{% raw %}
```liquid
---
layout: page
---
{% for post in site.categories[page.category] %}
<a href="{{ post.url | absolute_url }}">
{{ post.title }}
</a>
{% endfor %}
```
{% endraw %}
Next, in the root directory of your Jekyll install, create a new directory
called `category` and then create a file for each category you want to list. For
example, if you have a category `blog` then create a file in the new directory
called `blog.html` with at least
```yaml
---
layout: category
title: Blog
category: blog
---
```
In this case, the listing pages will be accessible at `{baseurl}/category/blog.html`
Although categories and tags are very similar, they are used to group posts,
there are a few differences between them. Categories and sub-categories create
hierarchies that, by default, are reflected in the directory structure of your
site. A post with the following header
```yaml
---
layout: post
title: A Trip
category: [ blog, travel ]
---
```
will be accessible at `{baseurl}/blog/travel/year/month/day/A-Trip.html`. On
the other hand, a tagged post
```yaml
---
layout: post
title: A Trip
tags: [ blog, travel ]
---
```
will be saved as `{baseurl}/year/month/day/A-Trip.html`. It is up to you to
create `{baseurl}/tag/blog.html` and `{baseurl}/tag/travel.html` the same way as
described above for categories.
While this example is done with tags and categories, you can easily extend your
lists to filter by any other variable created with extensions.
## Post excerpts
Each post automatically takes the first block of text, from the beginning of
the content to the first occurrence of `excerpt_separator`, and sets it in the
post's data hash.
Take the above example of an index of posts. Perhaps you want to include
a little hint about the post's content by adding the first paragraph of each of
your posts:
{% raw %}
```liquid
<ul>
{% for post in site.posts %}
<li>
<a href="{{ post.url }}">{{ post.title }}</a>
{{ post.excerpt }}
</li>
{% endfor %}
</ul>
```
{% endraw %}
Because Jekyll grabs the first paragraph you will not need to wrap the excerpt
in `p` tags, which is already done for you. These tags can be removed with the
following if you'd prefer:
{% raw %}
```liquid
{{ post.excerpt | remove: '<p>' | remove: '</p>' }}
```
{% endraw %}
If you don't like the automatically-generated post excerpt, it can be
explicitly overridden by adding an `excerpt` value to your post's YAML
Front Matter. Alternatively, you can choose to define a custom
`excerpt_separator` in the post's YAML front matter:
```yaml
---
excerpt_separator: <!--more-->
---
Excerpt
<!--more-->
Out-of-excerpt
```
You can also set the `excerpt_separator` globally in your `_config.yml`
configuration file.
Completely disable excerpts by setting your `excerpt_separator` to `""`.
Also, as with any output generated by Liquid tags, you can pass the
`| strip_html` filter to remove any html tags in the output. This is
particularly helpful if you wish to output a post excerpt as a
`meta="description"` tag within the post `head`, or anywhere else having
html tags along with the content is not desirable.
## Highlighting code snippets
Jekyll also has built-in support for syntax highlighting of code snippets using
either Pygments or Rouge, and including a code snippet in any post is easy.
Just use the dedicated Liquid tag as follows:
{% raw %}
```liquid
{% highlight ruby %}
def show
@widget = Widget(params[:id])
respond_to do |format|
format.html # show.html.erb
format.json { render json: @widget }
end
end
{% endhighlight %}
```
{% endraw %}
And the output will look like this:
```ruby
def show
@widget = Widget(params[:id])
respond_to do |format|
format.html # show.html.erb
format.json { render json: @widget }
end
end
```
<div class="note">
<h5>ProTip™: Show line numbers</h5>
<p>
You can make code snippets include line-numbers by adding the word
<code>linenos</code> to the end of the opening highlight tag like this:
<code>{% raw %}{% highlight ruby linenos %}{% endraw %}</code>.
</p>
</div>
These basics should be enough to get you started writing your first posts. When
youre ready to dig into what else is possible, you might be interested in
doing things like [customizing post permalinks](../permalinks/) or
using [custom variables](../variables/) in your posts and elsewhere on your
site.

View File

@@ -1,53 +0,0 @@
---
title: Quick-start guide
permalink: /docs/quickstart/
---
If you already have a full [Ruby](https://www.ruby-lang.org/en/downloads/) development environment with all headers and [RubyGems](https://rubygems.org/pages/download) installed (see Jekyll's [requirements](/docs/installation/#requirements)), you can create a new Jekyll site by doing the following:
```sh
# Install Jekyll and Bundler gems through RubyGems
gem install jekyll bundler
# Create a new Jekyll site at ./myblog
jekyll new myblog
# Change into your new directory
cd myblog
# Build the site on the preview server
bundle exec jekyll serve
# Now browse to http://localhost:4000
```
If you encounter any unexpected errors during the above, please refer to the [troubleshooting](/docs/troubleshooting/#configuration-problems) page or the already-mentioned [requirements](/docs/installation/#requirements) page, as you might be missing development headers or other prerequisites.
## 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 &mdash; 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:
* To install the Jekyll site into the directory you're currently in, run `jekyll new .` If the existing directory isn't empty, you can pass the `--force` option with `jekyll new . --force`.
* `jekyll new` automatically initiates `bundle install` to install the dependencies required. (If you don't want Bundler to install the gems, use `jekyll new myblog --skip-bundle`.)
* By default, the Jekyll site installed by `jekyll new` uses a gem-based theme called [Minima](https://github.com/jekyll/minima). With [gem-based themes](../themes), some of the directories and files are stored in the theme-gem, hidden from your immediate view.
* We recommend setting up Jekyll with a gem-based theme but if you want to start with a blank slate, use `jekyll new myblog --blank`
* To learn about other parameters you can include with `jekyll new`, type `jekyll new --help`.
When in doubt, use the <code>help</code> command to remind you of all available options and usage, it also works with the <code>new</code>, <code>build</code> and <code>serve</code> subcommands, e.g. <code>jekyll help new</code> or <code>jekyll help build</code>.
{: .note .info }
## Next steps
Building a Jekyll site with the default theme is just the first step. The real magic happens when you start creating blog posts, using the front matter to control templates and layouts, and taking advantage of all the awesome configuration options Jekyll makes available.

View File

@@ -1,62 +0,0 @@
---
title: Resources
permalink: /docs/resources/
---
Jekyll's growing use is producing a wide variety of tutorials, frameworks, extensions, examples, and other resources that can be very helpful. Below is a collection of links to some of the most popular Jekyll resources.
## Editors
- [jekyll-atom](https://atom.io/packages/jekyll): A collection of snippets and tools for Jekyll in Atom
- [markdown-writer](https://atom.io/packages/markdown-writer): An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
- [sublime-jekyll](https://github.com/23maverick23/sublime-jekyll): A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via [Package Control](https://packagecontrol.io/packages/Jekyll).
- [vim-jekyll](https://github.com/parkr/vim-jekyll): A vim plugin to generate new posts and run `jekyll build` all without leaving vim.
- [WordPress2Jekyll](https://wordpress.org/plugins/wp2jekyll/): A WordPress plugin that allows you to use WordPress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.
## Useful Guides
- [CloudCannon Academy](https://learn.cloudcannon.com/) is a set of resources created by [CloudCannon](https://cloudcannon.com/) to help folks get up and running with Jekyll. They cover all skill levels, and even include some great video tutorials.
- [Jekyll Cheatsheet](https://learn.cloudcannon.com/jekyll-cheat-sheet/) is a single-page resource for Jekyll filters, variables, and the like.
- ["Creating and Hosting a Personal Site on GitHub"](http://jmcglone.com/guides/github-pages/)
- ['Build A Blog With Jekyll And GitHub Pages' on Smashing Magazine](https://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/)
- Publishing to GitHub Pages? [Check out our documentation page for just that purpose](/docs/github-pages/).
- [Blogging with Git, Emacs and Jekyll](https://metajack.im/2009/01/23/blogging-with-git-emacs-and-jekyll/)
- [Tips for working with GitHub Pages Integration](https://gist.github.com/jedschneider/2890453)
## Integrations
- 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.
- [Algolia](https://blog.algolia.com/instant-search-blog-documentation-jekyll-plugin/): Add a powerful instant search to your Jekyll site
## Other commentary
- [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)
- ['My Jekyll Fork', by Mike West](https://mikewest.org/2009/11/my-jekyll-fork)
> "Jekyll is a well-architected throwback to a time before WordPress, when men were men, and HTML was static. I like the ideas it espouses, and have made a few improvements to it's core. Here, I'll point out some highlights of my fork in the hopes that they see usage beyond this site."
- ['About this Website', by Carter Allen](http://cartera.me/2010/08/12/about-this-website/)
> "Jekyll is everything that I ever wanted in a blogging engine. Really. It isn't perfect, but what's excellent about it is that if there's something wrong, I know exactly how it works and how to fix it. It runs on the your machine only, and is essentially an added"build" step between you and the browser. I coded this entire site in TextMate using standard HTML5 and CSS3, and then at the end I added just a few little variables to the markup. Presto-chango, my site is built and I am at peace with the world."
- [Generating a Tag Cloud in Jekyll](http://www.justkez.com/generating-a-tag-cloud-in-jekyll/) A guide to implementing a tag cloud and per-tag content pages using Jekyll.
- A way to [extend Jekyll](https://github.com/rfelix/jekyll_ext) without forking and modifying the Jekyll gem codebase and some [portable Jekyll extensions](https://wiki.github.com/rfelix/jekyll_ext/extensions) that can be reused and shared.
- [Using your Rails layouts in Jekyll](http://numbers.brighterplanet.com/2010/08/09/sharing-rails-views-with-jekyll)

View File

@@ -1,22 +0,0 @@
---
title: Sites using Jekyll
permalink: /docs/sites/
---
Its interesting to see what designs and features others have come up
with. Below are some Jekyll-powered blogs which were hand-picked for
learning purposes.
- [Tom Preston-Werner](http://tom.preston-werner.com/)
([source](https://github.com/mojombo/mojombo.github.io))
- [GitHub Official Teaching Materials](https://services.github.com/training/)
([source](https://github.com/github/training-kit))
- [Rasmus Andersson](https://rsms.me/)
([source](https://github.com/rsms/rsms.github.com))
- [MvvmCross](https://mvvmcross.github.io/MvvmCross/)
([source](https://github.com/MvvmCross/MvvmCross/tree/master/docs))
If you would like to explore more examples, you can find a list of sites
and their sources on the ["Sites" page in the Jekyll wiki][jekyll-sites].
[jekyll-sites]: {{ site.repository }}/wiki/Sites

View File

@@ -1,100 +0,0 @@
---
title: Static Files
permalink: /docs/static-files/
---
In addition to renderable and convertible content, we also have **static
files**.
A static file is a file that does not contain any YAML front matter. These
include images, PDFs, and other un-rendered content.
They're accessible in Liquid via `site.static_files` and contain the
following metadata:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><p><code>file.path</code></p></td>
<td><p>
The relative path to the file, e.g. <code>/assets/img/image.jpg</code>
</p></td>
</tr>
<tr>
<td><p><code>file.modified_time</code></p></td>
<td><p>
The `Time` the file was last modified, e.g. <code>2016-04-01 16:35:26 +0200</code>
</p></td>
</tr>
<tr>
<td><p><code>file.name</code></p></td>
<td><p>
The string name of the file e.g. <code>image.jpg</code> for <code>image.jpg</code>
</p></td>
</tr>
<tr>
<td><p><code>file.basename</code></p></td>
<td><p>
The string basename of the file e.g. <code>image</code> for <code>image.jpg</code>
</p></td>
</tr>
<tr>
<td><p><code>file.extname</code></p></td>
<td><p>
The extension name for the file, e.g.
<code>.jpg</code> for <code>image.jpg</code>
</p></td>
</tr>
</tbody>
</table>
</div>
Note that in the above table, `file` can be anything. It's simply an arbitrarily set variable used in your own logic (such as in a for loop). It isn't a global site or page variable.
## Add front matter to static files
Although you can't directly add front matter values to static files, you can set front matter values through the [defaults property](../configuration/#front-matter-defaults) in your configuration file. When Jekyll builds the site, it will use the front matter values you set.
Here's an example:
In your `_config.yml` file, add the following values to the `defaults` property:
```yaml
defaults:
- scope:
path: "assets/img"
values:
image: true
```
This assumes that your Jekyll site has a folder path of `assets/img` where you have images (static files) stored. When Jekyll builds the site, it will treat each image as if it had the front matter value of `image: true`.
Suppose you want to list all your image assets as contained in `assets/img`. You could use this for loop to look in the `static_files` object and get all static files that have this front matter property:
{% raw %}
```liquid
{% assign image_files = site.static_files | where: "image", true %}
{% for myimage in image_files %}
{{ myimage.path }}
{% endfor %}
```
{% endraw %}
When you build your site, the output will list the path to each file that meets this front matter condition.

View File

@@ -1,217 +0,0 @@
---
title: Directory structure
permalink: /docs/structure/
---
Jekyll is, at its core, a text transformation engine. The concept behind the
system is this: you give it text written in your favorite markup language, be
that Markdown, Textile, or just plain HTML, and it churns that through a layout
or a series of layout files. Throughout that process you can tweak how you want
the site URLs to look, what data gets displayed in the layout, and more. This
is all done through editing text files; the static web site is the final
product.
A basic Jekyll site usually looks something like this:
```sh
.
├── _config.yml
├── _data
| └── members.yml
├── _drafts
| ├── begin-with-the-crazy-ideas.md
| └── on-simplicity-in-technology.md
├── _includes
| ├── footer.html
| └── header.html
├── _layouts
| ├── default.html
| └── post.html
├── _posts
| ├── 2007-10-29-why-every-programmer-should-play-nethack.md
| └── 2009-04-26-barcamp-boston-4-roundup.md
├── _sass
| ├── _base.scss
| └── _layout.scss
├── _site
├── .jekyll-metadata
└── index.html # can also be an 'index.md' with valid YAML Frontmatter
```
<div class="note info">
<h5>Directory structure of Jekyll sites using gem-based themes</h5>
<p>
Starting <strong>Jekyll 3.2</strong>, a new Jekyll project bootstrapped with <code>jekyll new</code> uses <a href="../themes/">gem-based themes</a> to define the look of the site. This results in a lighter default directory structure : <code>_layouts</code>, <code>_includes</code> and <code>_sass</code> are stored in the theme-gem, by default.
</p>
<br />
<p>
<a href="https://github.com/jekyll/minima">minima</a> is the current default theme, and <code>bundle show minima</code> will show you where minima theme's files are stored on your computer.
</p>
</div>
An overview of what each of these does:
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>File / Directory</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p><code>_config.yml</code></p>
</td>
<td>
<p>
Stores <a href="../configuration/">configuration</a> data. Many of
these options can be specified from the command line executable but
its easier to specify them here so you dont have to remember them.
</p>
</td>
</tr>
<tr>
<td>
<p><code>_drafts</code></p>
</td>
<td>
<p>
Drafts are unpublished posts. The format of these files is without a
date: <code>title.MARKUP</code>. Learn how to <a href="../drafts/">
work with drafts</a>.
</p>
</td>
</tr>
<tr>
<td>
<p><code>_includes</code></p>
</td>
<td>
<p>
These are the partials that can be mixed and matched by your layouts
and posts to facilitate reuse. The liquid tag
<code>{% raw %}{% include file.ext %}{% endraw %}</code>
can be used to include the partial in
<code>_includes/file.ext</code>.
</p>
</td>
</tr>
<tr>
<td>
<p><code>_layouts</code></p>
</td>
<td>
<p>
These are the templates that wrap posts. Layouts are chosen on a
post-by-post basis in the
<a href="../frontmatter/">YAML Front Matter</a>,
which is described in the next section. The liquid tag
<code>{% raw %}{{ content }}{% endraw %}</code>
is used to inject content into the web page.
</p>
</td>
</tr>
<tr>
<td>
<p><code>_posts</code></p>
</td>
<td>
<p>
Your dynamic content, so to speak. The naming convention of these
files is important, and must follow the format:
<code>YEAR-MONTH-DAY-title.MARKUP</code>.
The <a href="../permalinks/">permalinks</a> can be customized for
each post, but the date and markup language are determined solely by
the file name.
</p>
</td>
</tr>
<tr>
<td>
<p><code>_data</code></p>
</td>
<td>
<p>
Well-formatted site data should be placed here. The Jekyll engine
will autoload all data files (using either the <code>.yml</code>,
<code>.yaml</code>, <code>.json</code> or <code>.csv</code>
formats and extensions) in this directory, and they will be
accessible via `site.data`. If there's a file
<code>members.yml</code> under the directory, then you can access
contents of the file through <code>site.data.members</code>.
</p>
</td>
</tr>
<tr>
<td>
<p><code>_sass</code></p>
</td>
<td>
<p>
These are sass partials that can be imported into your <code>main.scss</code>
which will then be processed into a single stylesheet
<code>main.css</code> that defines the styles to be used by your site.
</p>
</td>
</tr>
<tr>
<td>
<p><code>_site</code></p>
</td>
<td>
<p>
This is where the generated site will be placed (by default) once
Jekyll is done transforming it. Its probably a good idea to add this
to your <code>.gitignore</code> file.
</p>
</td>
</tr>
<tr>
<td>
<p><code>.jekyll-metadata</code></p>
</td>
<td>
<p>
This helps Jekyll keep track of which files have not been modified
since the site was last built, and which files will need to be
regenerated on the next build. This file will not be included in the
generated site. Its probably a good idea to add this to your
<code>.gitignore</code> file.
</p>
</td>
</tr>
<tr>
<td>
<p><code>index.html</code> or <code>index.md</code> and other HTML,
Markdown, Textile files</p>
</td>
<td>
<p>
Provided that the file has a <a href="../frontmatter/">YAML Front
Matter</a> section, it will be transformed by Jekyll. The same will
happen for any <code>.html</code>, <code>.markdown</code>,
<code>.md</code>, or <code>.textile</code> file in your sites root
directory or directories not listed above.
</p>
</td>
</tr>
<tr>
<td>
<p>Other Files/Folders</p>
</td>
<td>
<p>
Every other directory and file except for those listed above—such as
<code>css</code> and <code>images</code> folders,
<code>favicon.ico</code> files, and so forth—will be copied verbatim
to the generated site. There are plenty of <a href="../sites/">sites
already using Jekyll</a> if youre curious to see how theyre laid
out.
</p>
</td>
</tr>
</tbody>
</table>
</div>

View File

@@ -1,24 +0,0 @@
---
title: Support
permalink: "/docs/support/"
note: This file is autogenerated. Edit /.github/SUPPORT.markdown instead.
---
## Getting Help
**Jekyll's issue tracker is not a support forum.**
If you're looking for support for Jekyll, there are a lot of options:
* Read [Jekyll Documentation](https://jekyllrb.com/docs/home/)
* If you have a question about using Jekyll, start a discussion on [Jekyll Forum](https://talk.jekyllrb.com/) or [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll)
* Chat with Jekyllers &mdash; Join [our Gitter channel](https://gitter.im/jekyll/jekyll) or [our IRC channel on Freenode](irc:irc.freenode.net/jekyll)
There are a bunch of helpful community members on these services that should be willing to point you in the right direction.
## Report a bug
* If you think you've found a bug within a Jekyll plugin, open an issue in that plugin's repository &mdash; First [look for the plugin on rubygems](https://rubygems.org/) then click on the `Homepage` link to access the plugin repository.
* If you think you've found a bug within Jekyll itself, [open an issue](https://github.com/jekyll/jekyll/issues/new).
Happy Jekyllin'!

View File

@@ -1,634 +0,0 @@
---
title: Templates
permalink: /docs/templates/
---
Jekyll uses the [Liquid](https://shopify.github.io/liquid/) templating language to
process templates. All of the standard Liquid [tags](https://shopify.github.io/liquid/tags/control-flow/) and
[filters](https://shopify.github.io/liquid/filters/abs/) are
supported. To make common tasks easier, Jekyll even adds a few handy filters
and tags of its own, all of which you can find on this page. Jekyll even lets
you come up with your own tags via plugins.
## Filters
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Description</th>
<th><span class="filter">Filter</span> and <span class="output">Output</span></th>
</tr>
</thead>
<tbody>
<tr>
<td>
<p class="name"><strong>Relative URL</strong></p>
<p>Prepend the <code>baseurl</code> value to the input. Useful if your site is hosted at a subpath rather than the root of the domain.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ "/assets/style.css" | relative_url }}{% endraw %}</code>
</p>
<p>
<code class="output">/my-baseurl/assets/style.css</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Absolute URL</strong></p>
<p>Prepend the <code>url</code> and <code>baseurl</code> value to the input.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ "/assets/style.css" | absolute_url }}{% endraw %}</code>
</p>
<p>
<code class="output">http://example.com/my-baseurl/assets/style.css</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Date to XML Schema</strong></p>
<p>Convert a Date into XML Schema (ISO 8601) format.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.time | date_to_xmlschema }}{% endraw %}</code>
</p>
<p>
<code class="output">2008-11-07T13:07:54-08:00</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Date to RFC-822 Format</strong></p>
<p>Convert a Date into the RFC-822 format used for RSS feeds.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.time | date_to_rfc822 }}{% endraw %}</code>
</p>
<p>
<code class="output">Mon, 07 Nov 2008 13:07:54 -0800</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Date to String</strong></p>
<p>Convert a date to short format.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.time | date_to_string }}{% endraw %}</code>
</p>
<p>
<code class="output">07 Nov 2008</code>
</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>
<p>Format a date to long format.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.time | date_to_long_string }}{% endraw %}</code>
</p>
<p>
<code class="output">07 November 2008</code>
</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>
<p>Select all the objects in an array where the key has the given value.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.members | where:"graduation_year","2014" }}{% endraw %}</code>
</p>
</td>
</tr>
<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>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.members | where_exp:"item",
"item.graduation_year == 2014" }}{% endraw %}</code>
<code class="filter">{% raw %}{{ site.members | where_exp:"item",
"item.graduation_year < 2014" }}{% endraw %}</code>
<code class="filter">{% raw %}{{ site.members | where_exp:"item",
"item.projects contains 'foo'" }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Group By</strong></p>
<p>Group an array's items by a given property.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.members | group_by:"graduation_year" }}{% endraw %}</code>
</p>
<p>
<code class="output">[{"name"=>"2013", "items"=>[...]},
{"name"=>"2014", "items"=>[...]}]</code>
</p>
</td>
</tr>
<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>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.members | group_by_exp:"item",
"item.graduation_year | truncate: 3, \"\"" }}{% endraw %}</code>
</p>
<p>
<code class="output">[{"name"=>"201...", "items"=>[...]},
{"name"=>"200...", "items"=>[...]}]</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>XML Escape</strong></p>
<p>Escape some text for use in XML.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ page.content | xml_escape }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>CGI Escape</strong></p>
<p>
CGI escape a string for use in a URL. Replaces any special characters
with appropriate <code>%XX</code> replacements. CGI escape normally replaces a space with a plus <code>+</code> sign.
</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ "foo, bar; baz?" | cgi_escape }}{% endraw %}</code>
</p>
<p>
<code class="output">foo%2C+bar%3B+baz%3F</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>URI Escape</strong></p>
<p>
Percent encodes any special characters in a URI. URI escape normally replaces a space with <code>%20</code>. <a href="https://en.wikipedia.org/wiki/Percent-encoding#Types_of_URI_characters">Reserved characters</a> will not be escaped.
</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ "http://foo.com/?q=foo, \bar?" | uri_escape }}{% endraw %}</code>
</p>
<p>
<code class="output">http://foo.com/?q=foo,%20%5Cbar?</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Number of Words</strong></p>
<p>Count the number of words in some text.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ page.content | number_of_words }}{% endraw %}</code>
</p>
<p>
<code class="output">1337</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Array to Sentence</strong></p>
<p>Convert an array into a sentence. Useful for listing tags. Optional argument for connector.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ page.tags | array_to_sentence_string }}{% endraw %}</code>
</p>
<p>
<code class="output">foo, bar, and baz</code>
</p>
<p>
<code class="filter">{% raw %}{{ page.tags | array_to_sentence_string: 'or' }}{% endraw %}</code>
</p>
<p>
<code class="output">foo, bar, or baz</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Markdownify</strong></p>
<p>Convert a Markdown-formatted string into HTML.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ page.excerpt | markdownify }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Smartify</strong></p>
<p>Convert "quotes" into &ldquo;smart quotes.&rdquo;</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ page.title | smartify }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Converting Sass/SCSS</strong></p>
<p>Convert a Sass- or SCSS-formatted string into CSS.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ some_scss | scssify }}{% endraw %}</code>
<code class="filter">{% raw %}{{ some_sass | sassify }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Slugify</strong></p>
<p>Convert a string into a lowercase URL "slug". See below for options.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ "The _config.yml file" | slugify }}{% endraw %}</code>
</p>
<p>
<code class="output">the-config-yml-file</code>
</p>
<p>
<code class="filter">{% raw %}{{ "The _config.yml file" | slugify: 'pretty' }}{% endraw %}</code>
</p>
<p>
<code class="output">the-_config.yml-file</code>
</p>
<p>
<code class="filter">{% raw %}{{ "The _cönfig.yml file" | slugify: 'ascii' }}{% endraw %}</code>
</p>
<p>
<code class="output">the-c-nfig-yml-file</code>
</p>
<p>
<code class="filter">{% raw %}{{ "The cönfig.yml file" | slugify: 'latin' }}{% endraw %}</code>
</p>
<p>
<code class="output">the-config-yml-file</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Data To JSON</strong></p>
<p>Convert Hash or Array to JSON.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.data.projects | jsonify }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Normalize Whitespace</strong></p>
<p>Replace any occurrence of whitespace with a single space.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ "a \n b" | normalize_whitespace }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Sort</strong></p>
<p>Sort an array. Optional arguments for hashes: 1.&nbsp;property name 2.&nbsp;nils order (<em>first</em> or <em>last</em>).</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ page.tags | sort }}{% endraw %}</code>
</p>
<p>
<code class="filter">{% raw %}{{ site.posts | sort: 'author' }}{% endraw %}</code>
</p>
<p>
<code class="filter">{% raw %}{{ site.pages | sort: 'title', 'last' }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Sample</strong></p>
<p>Pick a random value from an array. Optional: pick multiple values.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ site.pages | sample }}{% endraw %}</code>
</p>
<p>
<code class="filter">{% raw %}{{ site.pages | sample:2 }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>To Integer</strong></p>
<p>Convert a string or boolean to integer.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ some_var | to_integer }}{% endraw %}</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Array Filters</strong></p>
<p>Push, pop, shift, and unshift elements from an Array.</p>
<p>These are <strong>NON-DESTRUCTIVE</strong>, i.e. they do not mutate the array, but rather make a copy and mutate that.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ page.tags | push: 'Spokane' }}{% endraw %}</code>
</p>
<p>
<code class="output">['Seattle', 'Tacoma', 'Spokane']</code>
</p>
<p>
<code class="filter">{% raw %}{{ page.tags | pop }}{% endraw %}</code>
</p>
<p>
<code class="output">['Seattle']</code>
</p>
<p>
<code class="filter">{% raw %}{{ page.tags | shift }}{% endraw %}</code>
</p>
<p>
<code class="output">['Tacoma']</code>
</p>
<p>
<code class="filter">{% raw %}{{ page.tags | unshift: "Olympia" }}{% endraw %}</code>
</p>
<p>
<code class="output">['Olympia', 'Seattle', 'Tacoma']</code>
</p>
</td>
</tr>
<tr>
<td>
<p class="name"><strong>Inspect</strong></p>
<p>Convert an object into its String representation for debugging.</p>
</td>
<td class="align-center">
<p>
<code class="filter">{% raw %}{{ some_var | inspect }}{% endraw %}</code>
</p>
</td>
</tr>
</tbody>
</table>
</div>
### Options for the `slugify` filter
The `slugify` filter accepts an option, each specifying what to filter.
The default is `default`. They are as follows (with what they filter):
- `none`: no characters
- `raw`: spaces
- `default`: spaces and non-alphanumeric characters
- `pretty`: spaces and non-alphanumeric characters except for `._~!$&'()+,;=@`
- `ascii`: spaces, non-alphanumeric, and non-ASCII characters
- `latin`: like `default`, except Latin characters are first transliterated (e.g. `àèïòü` to `aeiou`) {%- include docs_version_badge.html version="3.7.0" -%}
## Tags
* [Includes](#includes)
* [Code snippet highlighting](#code-snippet-highlighting)
* [Linking to pages, collections and posts (the new and improved way)](#links)
* [Linking to posts (the old way)](#linking-to-posts)
### Includes
If you have small page snippets that you want to include in multiple places on your site, save the snippets as *include files* and insert them where required, by using the `include` tag:
{% raw %}
```liquid
{% include footer.html %}
```
{% endraw %}
Jekyll expects all *include files* to be placed in an `_includes` directory at the root of your source directory. In the above example, this will embed the contents of `_includes/footer.html` into the calling file.
For more advanced information on using includes, see [Includes](../includes).
### Code snippet highlighting
Jekyll has built in support for syntax highlighting of over 60 languages
thanks to [Rouge](http://rouge.jneen.net). Rouge is the default highlighter
in Jekyll 3 and above. To use it in Jekyll 2, set `highlighter` to `rouge`
and ensure the `rouge` gem is installed properly.
Alternatively, you can use [Pygments](http://pygments.org) to highlight
your code snippets. To use Pygments, you must have Python installed on your
system, have the `pygments.rb` gem installed and set `highlighter` to
`pygments` in your site's configuration file. Pygments supports [over 100
languages](http://pygments.org/languages/)
To render a code block with syntax highlighting, surround your code as follows:
{% raw %}
```liquid
{% highlight ruby %}
def foo
puts 'foo'
end
{% endhighlight %}
```
{% endraw %}
The argument to the `highlight` tag (`ruby` in the example above) is the
language identifier. To find the appropriate identifier to use for the language
you want to highlight, look for the “short name” on the [Rouge
wiki](https://github.com/jayferd/rouge/wiki/List-of-supported-languages-and-lexers)
or the [Pygments' Lexers page](http://pygments.org/docs/lexers/).
<div class="note info">
<h5>Jekyll processes all Liquid filters in code blocks</h5>
<p>If you are using a language that contains curly braces, you
will likely need to place <code>{&#37; raw &#37;}</code> and
<code>{&#37; endraw &#37;}</code> tags around your code.</p>
</div>
#### Line numbers
There is a second argument to `highlight` called `linenos` that is optional.
Including the `linenos` argument will force the highlighted code to include line
numbers. For instance, the following code block would include line numbers next
to each line:
{% raw %}
```liquid
{% highlight ruby linenos %}
def foo
puts 'foo'
end
{% endhighlight %}
```
{% endraw %}
#### Stylesheets for syntax highlighting
In order for the highlighting to show up, youll need to include a highlighting
stylesheet. For an example stylesheet you can look at
[syntax.css](https://github.com/mojombo/tpw/tree/master/css/syntax.css). These
are the same styles as used by GitHub and you are free to use them for your own
site. If you use `linenos`, you might want to include an additional CSS class
definition for the `.lineno` class in `syntax.css` to distinguish the line
numbers from the highlighted code.
## Links
### Linking to pages {#link}
To link to a post, a page, collection item, or file, the `link` tag will generate the correct permalink URL for the path you specify. For example, if you use the `link` tag to link to `mypage.html`, even if you change your permalink style to include the file extension or omit it, the URL formed by the `link` tag will always be valid.
You must include the file's original extension when using the `link` tag. Here are some examples:
{% raw %}
```liquid
{{ site.baseurl }}{% link _collection/name-of-document.md %}
{{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %}
{{ site.baseurl }}{% link news/index.html %}
{{ site.baseurl }}{% link /assets/files/doc.pdf %}
```
{% endraw %}
You can also use the `link` tag to create a link in Markdown as follows:
{% raw %}
```liquid
[Link to a document]({{ site.baseurl }}{% link _collection/name-of-document.md %})
[Link to a post]({{ site.baseurl }}{% link _posts/2016-07-26-name-of-post.md %})
[Link to a page]({{ site.baseurl }}{% link news/index.html %})
[Link to a file]({{ site.baseurl }}{% link /assets/files/doc.pdf %})
```
{% endraw %}
(Including `{% raw %}{{ site.baseurl }}{% endraw %}` is optional &mdash; it depends on whether you want to preface the page URL with the `baseurl` value.)
The path to the post, page, or collection is defined as the path relative to the root directory (where your config file is) to the file, not the path from your existing page to the other page.
For example, suppose you're creating a link in `page_a.md` (stored in `pages/folder1/folder2`) to `page_b.md` (stored in `pages/folder1`). Your path in the link would not be `../page_b.html`. Instead, it would be `/pages/folder1/page_b.md`.
If you're unsure of the path, add `{% raw %}{{ page.path }}{% endraw %}` to the page and it will display the path.
One major benefit of using the `link` or `post_url` tag is link validation. If the link doesn't exist, Jekyll won't build your site. This is a good thing, as it will alert you to a broken link so you can fix it (rather than allowing you to build and deploy a site with broken links).
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.
{% raw %}
```liquid
{{ site.baseurl }}{% post_url 2010-07-21-name-of-post %}
```
{% endraw %}
If you organize your posts in subdirectories, you need to include subdirectory path to the post:
{% raw %}
```liquid
{{ site.baseurl }}{% post_url /subdir/2010-07-21-name-of-post %}
```
{% endraw %}
There is no need to include the file extension when using the `post_url` tag.
You can also use this tag to create a link to a post in Markdown as follows:
{% raw %}
```liquid
[Name of Link]({{ site.baseurl }}{% post_url 2010-07-21-name-of-post %})
```
{% endraw %}

View File

@@ -1,313 +0,0 @@
---
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.
## Understanding gem-based themes
When you [create a new Jekyll site](/docs/quickstart) (by running the `jekyll new <PATH>` command), Jekyll installs a site that uses a gem-based theme called [Minima](https://github.com/jekyll/minima).
With gem-based themes, some of the site's directories (such as the `assets`, `_layouts`, `_includes`, and `_sass` directories) are stored in the theme's gem, hidden from your immediate view. Yet all of the necessary directories will be read and processed during Jekyll's build process.
In the case of Minima, you see only the following files in your Jekyll site directory:
```
├── Gemfile
├── Gemfile.lock
├── _config.yml
├── _posts
│ └── 2016-12-04-welcome-to-jekyll.markdown
├── about.md
└── index.md
```
The `Gemfile` and `Gemfile.lock` files are used by Bundler to keep track of the required gems and gem versions you need to build your Jekyll site.
Gem-based themes make it easy for theme developers to make updates available to anyone who has the theme gem. When there's an update, theme developers push the update to RubyGems.
If you have the theme gem, you can (if you desire) run `bundle update` to update all gems in your project. Or you can run `bundle update <THEME>`, replacing `<THEME>` with the theme name, such as `minima`, to just update the theme gem. Any new files or updates the theme developer has made (such as to stylesheets or includes) will be pulled into your project automatically.
The goal of gem-based themes is to allow you to get all the benefits of a robust, continually updated theme without having all the theme's files getting in your way and over-complicating what might be your primary focus: creating content.
## Overriding theme defaults
Jekyll themes set default layouts, includes, and stylesheets. However, you can override any of the theme defaults with your own site content.
To replace layouts or includes in your theme, make a copy in your `_layouts` or `_includes` directory of the specific file you wish to modify, or create the file from scratch giving it the same name as the file you wish to override.
For example, if your selected theme has a `page` layout, you can override the theme's layout by creating your own `page` layout in the `_layouts` directory (that is, `_layouts/page.html`).
To locate a theme's files on your computer:
1. Run `bundle show` followed by the name of the theme's gem, e.g., `bundle show minima` for Jekyll's default theme.
This returns the location of the gem-based theme files. For example, the Minima theme's files might be located in `/usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0` on macOS.
2. Open the theme's directory in Finder or Explorer:
```sh
# On MacOS
open $(bundle show minima)
# On Windows
explorer /usr/local/lib/ruby/gems/2.3.0/gems/minima-2.1.0
```
A Finder or Explorer window opens showing the theme's files and directories. The Minima theme gem contains these files:
```
├── LICENSE.txt
├── README.md
├── _includes
│   ├── disqus_comments.html
│   ├── footer.html
│   ├── google-analytics.html
│   ├── head.html
│   ├── header.html
│   ├── icon-github.html
│   ├── icon-github.svg
│   ├── icon-twitter.html
│   └── icon-twitter.svg
├── _layouts
│   ├── default.html
│   ├── home.html
│   ├── page.html
│   └── post.html
├── _sass
│   ├── minima
│   │   ├── _base.scss
│   │   ├── _layout.scss
│   │   └── _syntax-highlighting.scss
│   └── minima.scss
└── assets
└── main.scss
```
With a clear understanding of the theme's files, you can now override any theme file by creating a similarly named file in your Jekyll site directory.
Let's say, for a second example, you want to override Minima's footer. In your Jekyll site, create an `_includes` folder and add a file in it called `footer.html`. Jekyll will now use your site's `footer.html` file instead of the `footer.html` file from the Minima theme gem.
To modify any stylesheet you must take the extra step of also copying the main sass file (`_sass/minima.scss` in the Minima theme) into the `_sass` directory in your site's source.
Jekyll will look first to your site's content before looking to the theme's defaults for any requested file in the following folders:
- `/assets`
- `/_layouts`
- `/_includes`
- `/_sass`
Note that making copies of theme files will prevent you from receiving any theme updates on those files. An alternative, to continue getting theme updates on all stylesheets, is to use higher specificity CSS selectors in your own additional, originally named CSS files.
Refer to your selected theme's documentation and source repository for more information on what files you can override.
{: .note .info}
## Converting gem-based themes to regular themes
Suppose you want to get rid of the gem-based theme and convert it to a regular theme, where all files are present in your Jekyll site directory, with nothing stored in the theme gem.
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`:
- Open `Gemfile` and remove `gem "minima", "~> 2.0"`.
- Open `_config.yml` and remove `theme: minima`.
Now `bundle update` will no longer get updates for the theme gem.
## Installing a gem-based theme {#installing-a-theme}
The `jekyll new <PATH>` command isn't the only way to create a new Jekyll site with a gem-based theme. You can also find gem-based themes online and incorporate them into your Jekyll project.
For example, search for [jekyll theme on RubyGems](https://rubygems.org/search?utf8=%E2%9C%93&query=jekyll-theme) to find other gem-based themes. (Note that not all themes are using `jekyll-theme` as a convention in the theme name.)
To install a gem-based theme:
1. Add the theme to your site's `Gemfile`:
```ruby
# ./Gemfile
gem "jekyll-theme-awesome"
```
Or if you've started with the `jekyll new` command, replace `gem "minima", "~> 2.0"` with your theme-gem:
```diff
# ./Gemfile
- gem "minima", "~> 2.0"
+ gem "jekyll-theme-awesome"
```
2. Install the theme:
```sh
bundle install
```
3. Add the following to your site's `_config.yml` to activate the theme:
```yaml
theme: jekyll-theme-awesome
```
4. Build your site:
```sh
bundle exec jekyll serve
```
You can have multiple themes listed in your site's `Gemfile`, but only one theme can be selected in your site's `_config.yml`.
{: .note .info }
If you're publishing your Jekyll site on [GitHub Pages](https://pages.github.com/), note that GitHub Pages supports only some gem-based themes. See [Supported Themes](https://pages.github.com/themes/) in GitHub's documentation to see which themes are supported.
## Creating a gem-based theme
If you're a Jekyll theme developer (rather than just a consumer of themes), you can package up your theme in RubyGems and allow users to install it through Bundler.
If you're unfamiliar with creating Ruby gems, don't worry. Jekyll will help you scaffold a new theme with the `new-theme` command. Run `jekyll new-theme` with the theme name as an argument.
Here is an example:
```sh
jekyll new-theme jekyll-theme-awesome
create /path/to/jekyll-theme-awesome/_layouts
create /path/to/jekyll-theme-awesome/_includes
create /path/to/jekyll-theme-awesome/_sass
create /path/to/jekyll-theme-awesome/_layouts/page.html
create /path/to/jekyll-theme-awesome/_layouts/post.html
create /path/to/jekyll-theme-awesome/_layouts/default.html
create /path/to/jekyll-theme-awesome/Gemfile
create /path/to/jekyll-theme-awesome/jekyll-theme-awesome.gemspec
create /path/to/jekyll-theme-awesome/README.md
create /path/to/jekyll-theme-awesome/LICENSE.txt
initialize /path/to/jekyll-theme-awesome/.git
create /path/to/jekyll-theme-awesome/.gitignore
Your new Jekyll theme, jekyll-theme-awesome, is ready for you in /path/to/jekyll-theme-awesome!
For help getting started, read /path/to/jekyll-theme-awesome/README.md.
```
Add your template files in the corresponding folders. Then complete the `.gemspec` and the README files according to your needs.
### Layouts and includes
Theme layouts and includes work just like they work in any Jekyll site. Place layouts in your theme's `/_layouts` folder, and place includes in your themes `/_includes` folder.
For example, if your theme has a `/_layouts/page.html` file, and a page has `layout: page` in its YAML front matter, Jekyll will first look to the site's `_layouts` folder for the `page` layout, and if none exists, will use your theme's `page` layout.
### Assets
Any file in `/assets` will be copied over to the user's site upon build unless they have a file with the same relative path. You can ship any kind of asset here: SCSS, an image, a webfont, etc. These files behave like pages and static files in Jekyll:
- If the file has [YAML front matter](/docs/frontmatter/) at the top, it will be rendered.
- If the file does not have YAML front matter, it will simply be copied over into the resulting site.
This allows theme creators to ship a default `/assets/styles.scss` file which their layouts can depend on as `/assets/styles.css`.
All files in `/assets` will be output into the compiled site in the `/assets` folder just as you'd expect from using Jekyll on your sites.
### Stylesheets
Your theme's stylesheets should be placed in your theme's `_sass` folder, again, just as you would when authoring a Jekyll site.
```
_sass
├── jekyll-theme-awesome.scss
```
Your theme's styles can be included in the user's stylesheet using the `@import` directive.
{% raw %}
```css
@import "{{ site.theme }}";
```
{% endraw %}
### Theme-gem dependencies {%- include docs_version_badge.html version="3.5.0" -%}
Jekyll will automatically require all whitelisted `runtime_dependencies` of your theme-gem even if they're not explicitly included under the `plugins` array in the site's config file. (Note: whitelisting is only required when building or serving with the `--safe` option.)
With this, the end-user need not keep track of the plugins required to be included in their config file for their theme-gem to work as intended.
### Documenting your theme
Your theme should include a `/README.md` file, which explains how site authors can install and use your theme. What layouts are included? What includes? Do they need to add anything special to their site's configuration file?
### 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.
### Previewing your theme
To preview your theme as you're authoring it, it may be helpful to add dummy content in, for example, `/index.html` and `/page.html` files. This will allow you to use the `jekyll build` and `jekyll serve` commands to preview your theme, just as you'd preview a Jekyll site.
If you do preview your theme locally, be sure to add `/_site` to your theme's `.gitignore` file to prevent the compiled site from also being included when you distribute your theme.
{: .info .note}
### Publishing your theme
Themes are published via [RubyGems.org](https://rubygems.org). You will need a RubyGems account, which you can [create for free](https://rubygems.org/sign_up).
1. First, you need to have it in a git repository:
```sh
git init # Only the first time
git add -A
git commit -m "Init commit"
```
2. Next, package your theme, by running the following command, replacing `jekyll-theme-awesome` with the name of your theme:
```sh
gem build jekyll-theme-awesome.gemspec
```
3. Finally, push your packaged theme up to the RubyGems service, by running the following command, again replacing `jekyll-theme-awesome` with the name of your theme:
```sh
gem push jekyll-theme-awesome-*.gem
```
4. To release a new version of your theme, update the version number in the gemspec file, ( `jekyll-theme-awesome.gemspec` in this example ), and then repeat Steps 1 - 3 above. We recommend that you follow [Semantic Versioning](http://semver.org/) while bumping your theme-version.

View File

@@ -1,322 +0,0 @@
---
title: Troubleshooting
permalink: /docs/troubleshooting/
---
If you ever run into problems installing or using Jekyll, here are a few tips
that might be of help. If the problem youre experiencing isnt covered below,
**please [check out our other help resources](/help/)** as well.
- [Installation Problems](#installation-problems)
- [Problems running Jekyll](#problems-running-jekyll)
- [Base-URL Problems](#base-url-problems)
- [Configuration problems](#configuration-problems)
- [Markup Problems](#markup-problems)
- [Production Problems](#production-problems)
## Installation Problems
If you encounter errors during gem installation, you may need to install
the header files for compiling extension modules for Ruby 2.x This
can be done on Ubuntu or Debian by running:
```sh
sudo apt-get install ruby2.3-dev
```
On Red Hat, CentOS, and Fedora systems you can do this by running:
```sh
sudo yum install ruby-devel
```
If you installed the above - specifically on Fedora 23 - but the extensions would still not compile, you are probably running a Fedora image that misses the `redhat-rpm-config` package. To solve this, simply run:
```sh
sudo dnf install redhat-rpm-config
```
On Arch Linux you need to run:
```sh
sudo pacman -S ruby-ffi
```
On Ubuntu if you get stuck after `bundle exec jekyll serve` and see error
messages like `Could not locate Gemfile` or `.bundle/ directory`, it's likely
because all requirements have not been fully met. Recent stock Ubuntu
distributions require the installation of both the `ruby` and `ruby-all-dev`
packages:
```sh
sudo apt-get install ruby ruby-all-dev
```
On [NearlyFreeSpeech](https://www.nearlyfreespeech.net/) you need to run the
following commands before installing Jekyll:
```sh
export GEM_HOME=/home/private/gems
export GEM_PATH=/home/private/gems:/usr/local/lib/ruby/gems/1.8/
export PATH=$PATH:/home/private/gems/bin
export RB_USER_INSTALL='true'
```
To install RubyGems on Gentoo:
```sh
sudo emerge -av dev-ruby/rubygems
```
On Windows, you may need to install [RubyInstaller
DevKit](https://wiki.github.com/oneclick/rubyinstaller/development-kit).
On Android (with Termux) you can install all requirements by running:
```sh
apt update && apt install libffi-dev clang ruby-dev make
```
On macOS, you may need to update RubyGems (using `sudo` only if necessary):
```sh
gem update --system
```
If you still have issues, you can download and install new Command Line
Tools (such as `gcc`) using the following command:
```sh
xcode-select --install
```
which may allow you to install native gems using this command (again, using
`sudo` only if necessary):
```sh
gem install jekyll
```
Note that upgrading macOS does not automatically upgrade Xcode itself
(that can be done separately via the App Store), and having an out-of-date
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 &amp; Mac OS X 10.11
With the introduction of System Integrity Protection, several directories
that were previously writable are now considered system locations and are no
longer available. Given these changes, there are a couple of simple ways to get
up and running. One option is to change the location where the gem will be
installed (again, using `sudo` only if necessary):
```sh
gem install -n /usr/local/bin jekyll
```
Alternatively, Homebrew can be installed and used to set up Ruby. This can be
done as follows:
```sh
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
Once Homebrew is installed, the second step is easy:
```sh
brew install ruby
```
Advanced users (with more complex needs) may find it helpful to choose one of a
number of Ruby version managers ([RVM][], [rbenv][], [chruby][], [etc][].) in
which to install Jekyll.
[RVM]: https://rvm.io
[rbenv]: http://rbenv.org
[chruby]: https://github.com/postmodern/chruby
[etc]: https://github.com/rvm/rvm/blob/master/docs/alt.md
If you elect to use one of the above methods to install Ruby, it might be
necessary to modify your `$PATH` variable using the following command:
```sh
export PATH=/usr/local/bin:$PATH
```
GUI apps can modify the `$PATH` as follows:
```sh
launchctl setenv PATH "/usr/local/bin:$PATH"
```
Either of these approaches are useful because `/usr/local` is considered a
"safe" location on systems which have SIP enabled, they avoid potential
conflicts with the version of Ruby included by Apple, and it keeps Jekyll and
its dependencies in a sandboxed environment. This also has the added
benefit of not requiring `sudo` when you want to add or remove a gem.
### Could not find a JavaScript runtime. (ExecJS::RuntimeUnavailable)
This error can occur during the installation of `jekyll-coffeescript` when
you don't have a proper JavaScript runtime. To solve this, either install
`execjs` and `therubyracer` gems, or install `nodejs`. Check out
[issue #2327](https://github.com/jekyll/jekyll/issues/2327) for more info.
## Problems running Jekyll
On Debian or Ubuntu, you may need to add `/var/lib/gems/1.8/bin/` to your path
in order to have the `jekyll` executable be available in your Terminal.
## Base-URL Problems
If you are using base-url option like:
```sh
jekyll serve --baseurl '/blog'
```
… then make sure that you access the site at:
```
http://localhost:4000/blog/index.html
```
It wont work to just access:
```
http://localhost:4000/blog
```
## Configuration problems
The order of precedence for conflicting [configuration settings](../configuration/)
is as follows:
1. Command-line flags
2. Configuration file settings
3. Defaults
That is: defaults are overridden by options specified in `_config.yml`,
and flags specified at the command-line will override all other settings
specified elsewhere.
**Note: From v3.3.0 onward, Jekyll does not process `node_modules` and certain subdirectories within `vendor`, by default. But, by having an `exclude:` array defined explicitly in the config file overrides this default setting, which results in some users to encounter an error in building the site, with the following error message:**
```sh
ERROR: YOUR SITE COULD NOT BE BUILT:
------------------------------------
Invalid date '<%= Time.now.strftime('%Y-%m-%d %H:%M:%S %z') %>':
Document 'vendor/bundle/gems/jekyll-3.4.3/lib/site_template/_posts/0000-00-00-welcome-to-jekyll.markdown.erb'
does not have a valid date in the YAML front matter.
```
Simply adding `vendor/bundle` to the `exclude:` list will solve this problem but will lead to having other sub-directories under `/vendor/` (and also `/node_modules/`, if present) be processed to the destination folder `_site`.
The proper solution is to incorporate the default setting for `exclude:` rather than override it completely:
For versions upto `v3.4.3`, the `exclude:` setting must look like following:
```yaml
exclude:
- Gemfile
- Gemfile.lock
- node_modules
- vendor/bundle/
- vendor/cache/
- vendor/gems/
- vendor/ruby/
- any_additional_item # any user-specific listing goes at the end
```
From `v3.5` onward, `Gemfile` and `Gemfile.lock` are also excluded by default. So, in most cases there is no need to define another `exclude:` array in the config file. So an existing definition can either be modified as above, or removed completely, or simply commented out to enable easy edits in future.
## Markup Problems
The various markup engines that Jekyll uses may have some issues. This
page will document them to help others who may run into the same
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:
```sh
'{{ "{{" }}' was not properly terminated with regexp: /\}\}/ (Liquid::SyntaxError)
```
### Excerpts
Since v1.0.0, Jekyll has had automatically-generated post excerpts. Since
v1.1.0, Jekyll also passes these excerpts through Liquid, which can cause
strange errors where references don't exist or a tag hasn't been closed. If you
run into these errors, try setting `excerpt_separator: ""` in your
`_config.yml`, or set it to some nonsense string.
## Production Problems
If you run into an issue that a static file can't be found in your
production environment during build since v3.2.0 you should set your
[environment to `production`](../configuration/#specifying-a-jekyll-environment-at-build-time).
The issue is caused by trying to copy a non-existing symlink.
<div class="note">
<h5>Please report issues you encounter!</h5>
<p>
If you come across a bug, please <a href="{{ site.repository }}/issues/new">create an issue</a>
on GitHub describing the problem and any work-arounds you find so we can
document it here for others.
</p>
</div>

View File

@@ -1,29 +0,0 @@
---
layout: docs
title: Upgrading
permalink: /docs/upgrading/
---
Upgrading from an older version of Jekyll? Upgrading to a new major version of
Jekyll (e.g. from v2.x to v3.x) may cause some headaches. Take the following
guides to aid your upgrade:
- [From 0.x to 1.x and 2.x](/docs/upgrading/0-to-2/)
- [From 2.x to 3.x](/docs/upgrading/2-to-3/)
## Minor updates
<div class="note">
<h5>Stay Up to Date</h5>
<p>We recommend you update Jekyll as often as possible to benefit from
the latest bug fixes.
</p>
</div>
If you followed our setup recommendations and installed [Bundler](http://bundler.io/), run `bundle update jekyll` or simply `bundle update` and all your gems will
update to the latest versions.
If you don't have Bundler installed, run `gem update jekyll`.
The procedure is similar [if you use the `github-pages`
gem](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#keeping-your-site-up-to-date-with-the-github-pages-gem).

View File

@@ -1,139 +0,0 @@
---
title: Upgrading from 0.x to 2.x
permalink: /docs/upgrading/0-to-2/
---
Upgrading from an older version of Jekyll? A few things have changed in 1.0
and 2.0 that you'll want to know about.
Before we dive in, go ahead and fetch the latest version of Jekyll:
```sh
gem update jekyll
```
<div class="note feature">
<h5 markdown="1">Diving in</h5>
<p markdown="1">Want to get a new Jekyll site up and running quickly? Simply
run <code>jekyll new SITENAME</code> to create a new folder with a bare bones
Jekyll site.</p>
</div>
### The Jekyll Command
For better clarity, Jekyll now accepts the commands `build` and `serve`.
Whereas before you might simply run the command `jekyll` to generate a site
and `jekyll --server` to view it locally, in v2.0 (and later) you should
use the subcommands `jekyll build` and `jekyll serve` to build and preview
your site.
<div class="note info">
<h5>Watching and Serving</h5>
<p markdown="1">With the new subcommands, the way sites are previewed locally
changed a bit. Instead of specifying `server: true` in the site's
configuration file, use `jekyll serve`. The same holds true for
`watch: true`. Instead, use the `--watch` flag with either `jekyll serve`
or `jekyll build`.</p>
</div>
### Absolute Permalinks
In Jekyll v1.0, we introduced absolute permalinks for pages in
subdirectories. Starting with v2.0, absolute permalinks are opt-out,
meaning Jekyll will default to using absolute permalinks instead of
relative permalinks. Relative permalink backwards-compatibility was removed in v3.0.
<div class="note warning" id="absolute-permalinks-warning">
<h5 markdown="1">Absolute permalinks will be required in v3.0 and on</h5>
<p markdown="1">
Starting with Jekyll v3.0, relative permalinks functionality will be removed and thus unavailable for use.
</p>
</div>
### Draft Posts
Jekyll now lets you write draft posts, and allows you to easily preview how
they will look prior to publishing. To start a draft, simply create a folder
called `_drafts` in your site's source directory (e.g., alongside `_posts`),
and add a new markdown file to it. To preview your new post, simply run the
`jekyll serve` command with the `--drafts` flag.
<div class="note info">
<h5 markdown="1">Drafts don't have dates</h5>
<p markdown="1">
Unlike posts, drafts don't have a date, since they haven't
been published yet. Rather than naming your draft something like
`2013-07-01-my-draft-post.md`, simply name the file what you'd like your
post to eventually be titled, here `my-draft-post.md`.</p>
</div>
### Custom Config File
Rather than passing individual flags via the command line, you can now pass
an entire custom Jekyll config file. This helps to distinguish between
environments, or lets you programmatically override user-specified
defaults. Simply add the `--config` flag to the `jekyll` command, followed
by the path to one or more config files (comma-delimited, no spaces).
#### As a result, the following command line flags are now deprecated:
* `--no-server`
* `--no-auto` (now `--no-watch`)
* `--auto` (now `--watch`)
* `--server`
* `--url=`
* `--maruku`, `--rdiscount`, and `--redcarpet`
* `--pygments`
* `--permalink=`
* `--paginate`
<div class="note info">
<h5>The config flag explicitly specifies your configuration file(s)</h5>
<p markdown="1">If you use the `--config` flag, Jekyll will ignore your
`_config.yml` file. Want to merge a custom configuration with the normal
configuration? No problem. Jekyll will accept more than one custom config
file via the command line. Config files cascade from right to left, such
that if I run `jekyll serve --config _config.yml,_config-dev.yml`,
the values in the config files on the right (`_config-dev.yml`) overwrite
those on the left (`_config.yml`) when both contain the same key.</p>
</div>
### New Config File Options
Jekyll 1.0 introduced several new config file options. Before you upgrade,
you should check to see if any of these are present in your pre-1.0 config
file, and if so, make sure that you're using them properly:
* `excerpt_separator`
* `host`
* `include`
* `keep_files`
* `layouts`
* `show_drafts`
* `timezone`
* `url`
### Baseurl
Often, you'll want the ability to run a Jekyll site in multiple places,
such as previewing locally before pushing to GitHub Pages. Jekyll 1.0 makes
that easier with the new `--baseurl` flag. To take advantage of this
feature, first add the production `baseurl` to your site's `_config.yml`
file. Then, throughout the site, simply prefix relative URLs
with `{% raw %}{{ site.baseurl }}{% endraw %}`.
When you're ready to preview your site locally, pass along the `--baseurl`
flag with your local baseurl (most likely `/`) to `jekyll serve` and Jekyll
will swap in whatever you've passed along, ensuring all your links work as
you'd expect in both environments.
<div class="note warning">
<h5 markdown="1">All page and post URLs contain leading slashes</h5>
<p markdown="1">If you use the method described above, please remember
that the URLs for all posts and pages contain a leading slash. Therefore,
concatenating the site baseurl and the post/page url where
`site.baseurl = /` and `post.url = /2013/06/05/my-fun-post/` will
result in two leading slashes, which will break links. It is thus
suggested that prefixing with `site.baseurl` only be used when the
`baseurl` is something other than the default of `/`.</p>
</div>

View File

@@ -1,138 +0,0 @@
---
title: Upgrading from 2.x to 3.x
permalink: /docs/upgrading/2-to-3/
---
Upgrading from an older version of Jekyll? A few things have changed in Jekyll 3
that you'll want to know about.
Before we dive in, go ahead and fetch the latest version of Jekyll:
```sh
gem update jekyll
```
Since v3.2 Jekyll requires Ruby version >= 2.1
{: .note .warning }
<div class="note feature">
<h5>Diving in</h5>
<p>Want to get a new Jekyll site up and running quickly? Simply
run <code>jekyll new SITENAME</code> to create a new folder with a bare bones
Jekyll site.</p>
</div>
### site.collections has changed
In 2.x, your iterations over `site.collections` yielded an array with the collection
label and the collection object as the first and second items, respectively. In 3.x,
this complication has been removed and iterations now yield simply the collection object.
A simple conversion must be made in your templates:
- `collection[0]` becomes `collection.label`
- `collection[1]` becomes `collection`
When iterating over `site.collections`, ensure the above conversions are made.
For `site.collections.myCollection` in Jekyll 2, you now do:
```liquid
{% raw %}
{% assign myCollection = site.collections | where: "label", "myCollection" | first %}
{% endraw %}
```
This is a bit cumbersome at first, but is easier than a big `for` loop.
### Dropped dependencies
We dropped a number of dependencies the Core Team felt were optional. As such, in 3.0, they must be explicitly installed and included if you use any of the features. They are:
- jekyll-paginate Jekyll's pagination solution from days past
- jekyll-coffeescript processing of CoffeeScript
- jekyll-gist the `gist` Liquid tag
- pygments.rb the Pygments highlighter
- redcarpet the Markdown processor
- toml an alternative to YAML for configuration files
- classifier-reborn for `site.related_posts`
### Future posts
A seeming feature regression in 2.x, the `--future` flag was automatically _enabled_.
The future flag allows post authors to give the post a date in the future and to have
it excluded from the build until the system time is equal or after the post time.
In Jekyll 3, this has been corrected. **Now, `--future` is disabled by default.**
This means you will need to include `--future` if you want your future-dated posts to
generate when running `jekyll build` or `jekyll serve`.
<div class="note info">
<h5>Future Posts on GitHub Pages</h5>
<p>
An exception to the above rule are GitHub Pages sites, where the <code>--future</code> flag remains <em>enabled</em>
by default to maintain historical consistency for those sites.
</p>
</div>
### Layout metadata
Introducing: `layout`. In Jekyll 2 and below, any metadata in the layout was merged onto
the `page` variable in Liquid. This caused a lot of confusion in the way the data was
merged and some unexpected behaviour. In Jekyll 3, all layout data is accessible via `layout`
in Liquid. For example, if your layout has `class: my-layout` in its YAML front matter,
then the layout can access that via `{% raw %}{{ layout.class }}{% endraw %}`.
### Syntax highlighter changed
For the first time, the default syntax highlighter has changed for the
`highlight` tag and for backtick code blocks. Instead of [Pygments.rb](https://github.com/tmm1/pygments.rb),
it's now [Rouge](http://rouge.jneen.net/). If you were using the `highlight` tag with certain
options, such as `hl_lines`, they may not be available when using Rouge. To
go back to using Pygments, set `highlighter: pygments` in your
`_config.yml` file and run `gem install pygments.rb` or add
`gem 'pygments.rb'` to your project's `Gemfile`.
### Relative Permalink support removed
In Jekyll 3 and above, relative permalinks have been deprecated. If you
created your site using Jekyll 2 and below, you may receive the following
error when trying to **serve** or **build**:
```text
Since v3.0, permalinks for pages in subfolders must be relative to the site
source directory, not the parent directory. Check
https://jekyllrb.com/docs/upgrading/ for more info.
```
This can be fixed by removing the following line from your `_config.yml` file:
```yaml
relative_permalinks: true
```
### Permalinks no longer automatically add a trailing slash
In Jekyll 2, any URL constructed from the `permalink:` field had a trailing slash (`/`) added to it automatically. Jekyll 3 no longer adds a trailing slash automatically to `permalink:` URLs. This can potentially result in old links to pages returning a 404 error. For example, suppose a page previously contained the YAML `permalink: /:year-:month-:day-:title` that resulted in the URL `example.com/2016-02-01-test/` (notice the trailing slash), Jekyll internally generates a folder named `2016-02-01-test`. In Jekyll 3, the same `permalink:` generate the file `2016-02-01-test.html` and the URL for the same page will be `example.com/2016-02-01-test`, and consequently any links to the old URL will result in a 404 error. In order to maintain the same URLs and avoid this problem, a trailing slash should be added to the `permalink:` field, for example `permalink: /:year-:month-:day-:title/`.
### All my posts are gone! Where'd they go!
Try adding `future: true` to your `_config.yml` file. Are they showing up now? If they are, then you were ensnared by an issue with the way Ruby parses times. Each of your posts is being read in a different timezone than you might expect and, when compared to the computer's current time, is "in the future." The fix for this is to add [a timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_time_offsets) to each post (and make sure you remove `future: true` from your `_config.yml` file). If you're writing from California, for example, you would change this:
```yaml
---
date: 2016-02-06 19:32:10
---
```
to this (note the offset):
```yaml
---
date: 2016-02-06 19:32:10 -0800
---
```
### My categories have stopped working!
If you organized your categories as `/_posts/code/2008-12-24-closures.md`, you will need to restructure your directories to put the categories _above_ the `_posts` directories, as follows: `/code/_posts/2008-12-24-closures.md`.
_Did we miss something? Please click "Improve this page" above and add a section. Thanks!_

View File

@@ -1,115 +0,0 @@
---
title: Basic Usage
permalink: /docs/usage/
---
The Jekyll gem makes a `jekyll` executable available to you in your Terminal
window. You can use this command in a number of ways:
```sh
jekyll build
# => The current folder will be generated into ./_site
jekyll build --destination <destination>
# => The current folder will be generated into <destination>
jekyll build --source <source> --destination <destination>
# => The <source> folder will be generated into <destination>
jekyll build --watch
# => The current folder will be generated into ./_site,
# watched for changes, and regenerated automatically.
```
## Override default development settings
Default URL is set to `http://localhost:4000` in development environment. {% include docs_version_badge.html version="3.3.0" %}
If you want to build for your production environment:
- Set your production URL in `_config.yml` e.g. `url: https://example.com`.
- Run `JEKYLL_ENV=production bundle exec jekyll build`.
<div class="note info">
<h5>Changes to <code>_config.yml</code> are not included during automatic regeneration.</h5>
<p>
The <code>_config.yml</code> master configuration file contains global configurations
and variable definitions that are read once at execution time. Changes made to <code>_config.yml</code>
during automatic regeneration are not loaded until the next execution.
</p>
<p>
Note <a href="../datafiles">Data Files</a> are included and reloaded during automatic regeneration.
</p>
</div>
<div class="note warning">
<h5>Destination folders are cleaned on site builds</h5>
<p>
The contents of <code>&lt;destination&gt;</code> are automatically
cleaned, by default, when the site is built. Files or folders that are not
created by your site will be removed. Files and folders you wish to retain
in <code>&lt;destination&gt;</code> may be specified within the <code>&lt;keep_files&gt;</code>
configuration directive.
</p>
<p>
Do not use an important location for <code>&lt;destination&gt;</code>;
instead, use it as a staging area and copy files from there to your web server.
</p>
</div>
Jekyll also comes with a built-in development server that will allow you to
preview what the generated site will look like in your browser locally.
```sh
jekyll serve
# => 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.
```
```sh
jekyll serve --no-watch
# => Same as `jekyll serve` but will not watch for changes.
```
These are just a few of the available [configuration options](../configuration/).
Many configuration options can either be specified as flags on the command line,
or alternatively (and more commonly) they can be specified in a `_config.yml`
file at the root of the source directory. Jekyll will automatically use the
options from this file when run. For example, if you place the following lines
in your `_config.yml` file:
```yaml
source: _source
destination: _deploy
```
Then the following two commands will be equivalent:
```sh
jekyll build
jekyll build --source _source --destination _deploy
```
For more about the possible configuration options, see the
[configuration](../configuration/) page.
<div class="note info">
<h5>Call for help</h5>
<p>
The <code>help</code> command is always here to remind you of all available options and usage, and also works with the <code>build</code>, <code>serve</code> and <code>new</code> subcommands, e.g <code>jekyll help new</code> or <code>jekyll help build</code>.
</p>
</div>
If you're interested in browsing these docs on-the-go, install the
`jekyll-docs` gem and run `jekyll docs` in your terminal.

View File

@@ -1,422 +0,0 @@
---
title: Variables
permalink: /docs/variables/
---
Jekyll traverses your site looking for files to process. Any files with [YAML
front matter](../frontmatter/) are subject to processing. For each of these
files, Jekyll makes a variety of data available via the [Liquid templating
system](https://github.com/Shopify/liquid/wiki). The
following is a reference of the available data.
## Global Variables
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><p><code>site</code></p></td>
<td><p>
Sitewide information + configuration settings from
<code>_config.yml</code>. See below for details.
</p></td>
</tr>
<tr>
<td><p><code>page</code></p></td>
<td><p>
Page specific information + the <a href="../frontmatter/">YAML front
matter</a>. Custom variables set via the YAML Front Matter will be
available here. See below for details.
</p></td>
</tr>
<tr>
<td><p><code>layout</code></p></td>
<td><p>
Layout specific information + the <a href="../frontmatter/">YAML front
matter</a>. Custom variables set via the YAML Front Matter in
layouts will be available here.
</p></td>
</tr>
<tr>
<td><p><code>content</code></p></td>
<td><p>
In layout files, the rendered content of the Post or Page being wrapped.
Not defined in Post or Page files.
</p></td>
</tr>
<tr>
<td><p><code>paginator</code></p></td>
<td><p>
When the <code>paginate</code> configuration option is set, this
variable becomes available for use. See <a
href="../pagination/">Pagination</a> for details.
</p></td>
</tr>
</tbody>
</table>
</div>
## Site Variables
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><p><code>site.time</code></p></td>
<td><p>
The current time (when you run the <code>jekyll</code> command).
</p></td>
</tr>
<tr>
<td><p><code>site.pages</code></p></td>
<td><p>
A list of all Pages.
</p></td>
</tr>
<tr>
<td><p><code>site.posts</code></p></td>
<td><p>
A reverse chronological list of all Posts.
</p></td>
</tr>
<tr>
<td><p><code>site.related_posts</code></p></td>
<td><p>
If the page being processed is a Post, this contains a list of up to ten
related Posts. By default, these are the ten most recent posts.
For high quality but slow to compute results, run the
<code>jekyll</code> command with the <code>--lsi</code> (<a href="https://en.wikipedia.org/wiki/Latent_semantic_analysis#Latent_semantic_indexing">latent semantic indexing</a>) option. Also note GitHub Pages does not support the <code>lsi</code> option when generating sites.
</p></td>
</tr>
<tr>
<td><p><code>site.static_files</code></p></td>
<td><p>
A list of all <a href="/docs/static-files/">static files</a> (i.e.
files not processed by Jekyll's converters or the Liquid renderer).
Each file has three properties: <code>path</code>,
<code>modified_time</code> and <code>extname</code>.
</p></td>
</tr>
<tr>
<td><p><code>site.html_pages</code></p></td>
<td><p>
A subset of `site.pages` listing those which end in `.html`.
</p></td>
</tr>
<tr>
<td><p><code>site.html_files</code></p></td>
<td><p>
A subset of `site.static_files` listing those which end in `.html`.
</p></td>
</tr>
<tr>
<td><p><code>site.collections</code></p></td>
<td><p>
A list of all the collections.
</p></td>
</tr>
<tr>
<td><p><code>site.data</code></p></td>
<td><p>
A list containing the data loaded from the YAML files located in the <code>_data</code> directory.
</p></td>
</tr>
<tr>
<td><p><code>site.documents</code></p></td>
<td><p>
A list of all the documents in every collection.
</p></td>
</tr>
<tr>
<td><p><code>site.categories.CATEGORY</code></p></td>
<td><p>
The list of all Posts in category <code>CATEGORY</code>.
</p></td>
</tr>
<tr>
<td><p><code>site.tags.TAG</code></p></td>
<td><p>
The list of all Posts with tag <code>TAG</code>.
</p></td>
</tr>
<tr>
<td><p><code>site.url</code></p></td>
<td><p>
Contains the url of your site as it is configured in the <code>_config.yml</code>.
For example, if you have <code>url: http://mysite.com</code>
in your configuration file, then it will be accessible in Liquid as
<code>site.url</code>. For the development environment there is
<a href="/news/#3-siteurl-is-set-by-the-development-server">an exception</a>,
if you are running <code>jekyll serve</code> in a development environment
<code>site.url</code> will be set to the value of <code>host</code>,
<code>port</code>, and SSL-related options. This defaults to
<code>url: http://localhost:4000</code>.
</p></td>
</tr>
<tr>
<td><p><code>site.[CONFIGURATION_DATA]</code></p></td>
<td><p>
All the variables set via the command line and your
<code>_config.yml</code> are available through the <code>site</code>
variable. For example, if you have <code>foo: bar</code>
in your configuration file, then it will be accessible in Liquid as <code>site.foo</code>.
Jekyll does not parse changes to <code>_config.yml</code> in
<code>watch</code> mode, you must restart Jekyll to see changes to variables.
</p></td>
</tr>
</tbody>
</table>
</div>
## Page Variables
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><p><code>page.content</code></p></td>
<td><p>
The content of the Page, rendered or un-rendered depending upon
what Liquid is being processed and what <code>page</code> is.
</p></td>
</tr>
<tr>
<td><p><code>page.title</code></p></td>
<td><p>
The title of the Page.
</p></td>
</tr>
<tr>
<td><p><code>page.excerpt</code></p></td>
<td><p>
The un-rendered excerpt of a document.
</p></td>
</tr>
<tr>
<td><p><code>page.url</code></p></td>
<td><p>
The URL of the Post without the domain, but
with a leading slash, e.g.
<code>/2008/12/14/my-post.html</code>
</p></td>
</tr>
<tr>
<td><p><code>page.date</code></p></td>
<td><p>
The Date assigned to the Post. This can be overridden in a Posts front
matter by specifying a new date/time in the format
<code>YYYY-MM-DD HH:MM:SS</code> (assuming UTC), or
<code>YYYY-MM-DD HH:MM:SS +/-TTTT</code> (to specify a time zone using
an offset from UTC. e.g. <code>2008-12-14 10:30:00 +0900</code>).
</p></td>
</tr>
<tr>
<td><p><code>page.id</code></p></td>
<td><p>
An identifier unique to a document in a Collection or a Post (useful in RSS feeds). e.g.
<code>/2008/12/14/my-post</code>
<code>/my-collection/my-document</code>
</p></td>
</tr>
<tr>
<td><p><code>page.categories</code></p></td>
<td><p>
The list of categories to which this post belongs. Categories are
derived from the directory structure above the <code>_posts</code>
directory. For example, a post at
<code>/work/code/_posts/2008-12-24-closures.md</code> would have this
field set to <code>['work', 'code']</code>. These can also be specified
in the <a href="../frontmatter/">YAML Front Matter</a>.
</p></td>
</tr>
<tr>
<td><p><code>page.tags</code></p></td>
<td><p>
The list of tags to which this post belongs. These can be specified in
the <a href="../frontmatter/">YAML Front Matter</a>.
</p></td>
</tr>
<tr>
<td><p><code>page.path</code></p></td>
<td><p>
The path to the raw post or page. Example usage: Linking back to the
page or posts source on GitHub. This can be overridden in the
<a href="../frontmatter/">YAML Front Matter</a>.
</p></td>
</tr>
<tr>
<td><p><code>page.next</code></p></td>
<td><p>
The next post relative to the position of the current post in
<code>site.posts</code>. Returns <code>nil</code> for the last entry.
</p></td>
</tr>
<tr>
<td><p><code>page.previous</code></p></td>
<td><p>
The previous post relative to the position of the current post in
<code>site.posts</code>. Returns <code>nil</code> for the first entry.
</p></td>
</tr>
</tbody>
</table>
</div>
<div class="note">
<h5>ProTip™: Use Custom Front Matter</h5>
<p>
Any custom front matter that you specify will be available under
<code>page</code>. For example, if you specify <code>custom_css: true</code>
in a pages front matter, that value will be available as
<code>page.custom_css</code>.
</p>
<p>
If you specify front matter in a layout, access that via <code>layout</code>.
For example, if you specify <code>class: full_page</code>
in a layouts front matter, that value will be available as
<code>layout.class</code> in the layout and its parents.
</p>
</div>
## Paginator
<div class="mobile-side-scroller">
<table>
<thead>
<tr>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><p><code>paginator.per_page</code></p></td>
<td><p>Number of Posts per page.</p></td>
</tr>
<tr>
<td><p><code>paginator.posts</code></p></td>
<td><p>Posts available for that page.</p></td>
</tr>
<tr>
<td><p><code>paginator.total_posts</code></p></td>
<td><p>Total number of Posts.</p></td>
</tr>
<tr>
<td><p><code>paginator.total_pages</code></p></td>
<td><p>Total number of pages.</p></td>
</tr>
<tr>
<td><p><code>paginator.page</code></p></td>
<td><p>The number of the current page.</p></td>
</tr>
<tr>
<td><p><code>paginator.previous_page</code></p></td>
<td><p>The number of the previous page.</p></td>
</tr>
<tr>
<td><p><code>paginator.previous_page_path</code></p></td>
<td><p>The path to the previous page.</p></td>
</tr>
<tr>
<td><p><code>paginator.next_page</code></p></td>
<td><p>The number of the next page.</p></td>
</tr>
<tr>
<td><p><code>paginator.next_page_path</code></p></td>
<td><p>The path to the next page.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="note info">
<h5>Paginator variable availability</h5>
<p>
These are only available in index files, however they can be located in a
subdirectory, such as <code>/blog/index.html</code>.
</p>
</div>

View File

@@ -1,138 +0,0 @@
---
title: Jekyll on Windows
permalink: /docs/windows/
---
While Windows is not an officially-supported platform, it can be used to run Jekyll with the proper tweaks. This page aims to collect some of the general knowledge and lessons that have been unearthed by Windows users.
## 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
### 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 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.
First let's make sure all our packages / repositories are up to date. Open a new Command Prompt instance, and type the following:
```sh
bash
```
Your Command Prompt instance should now be a Bash instance. Now we must update our repo lists and packages.
```sh
sudo apt-get update -y && sudo apt-get upgrade -y
```
Now we can install Ruby. To do this we will use a repository from [BrightBox](https://www.brightbox.com/docs/ruby/ubuntu/), which hosts optimized versions of Ruby for Ubuntu.
```sh
sudo apt-add-repository ppa:brightbox/ruby-ng
sudo apt-get update
sudo apt-get install ruby2.3 ruby2.3-dev build-essential dh-autoreconf
```
Next let's update our Ruby gems:
```sh
sudo gem update
```
Now all that is left to do is install Jekyll.
```sh
sudo gem install jekyll bundler
```
Check if Jekyll installed properly by running:
```sh
jekyll -v
```
Configure the bundler/gem path so bundle doesn't prompt for sudo
```sh
bundle config path vendor/bundle
```
**And that's it!**
To start a new project named `my_blog`, just run:
```sh
jekyll new my_blog
```
You can make sure time management is working properly by inspecting your `_posts` folder. You should see a markdown file with the current date in the filename.
<div class="note info">
<h5>Non-superuser account issues</h5>
<p>If the `jekyll new` command prints the error "Your user account isn't allowed to install to the system RubyGems", see the "Running Jekyll as Non-Superuser" instructions in <a href="/docs/troubleshooting/#no-sudo">Troubleshooting</a>.</p>
</div>
**Note:** Bash on Ubuntu on Windows is still under development, so you may run into issues.
[WSL-Guide]: https://msdn.microsoft.com/en-us/commandline/wsl/install_guide
[BASH-WSL]: https://msdn.microsoft.com/en-us/commandline/wsl/about

View File

@@ -1,13 +0,0 @@
{% 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.parentNode.insertBefore(l,L)}(window,document,'script','ga');
ga('create', '{{ site.google_analytics_id }}', 'jekyllrb.com');
ga('send', 'pageview');
</script>
{% endif %}

View File

@@ -1,33 +0,0 @@
<script>
var anchorForId = function (id) {
var anchor = document.createElement("a");
anchor.className = "header-link";
anchor.href = "#" + id;
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
anchor.title = "Permalink";
return anchor;
};
var linkifyAnchors = function (level, containingElement) {
var headers = containingElement.getElementsByTagName("h" + level);
for (var h = 0; h < headers.length; h++) {
var header = headers[h];
if (typeof header.id !== "undefined" && header.id !== "") {
header.appendChild(anchorForId(header.id));
}
}
};
document.onreadystatechange = function () {
if (this.readyState === "complete") {
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
if (!contentBlock) {
return;
}
for (var level = 1; level <= 6; level++) {
linkifyAnchors(level, contentBlock);
}
}
};
</script>

Some files were not shown because too many files have changed in this diff Show More