Compare commits

..

687 Commits

Author SHA1 Message Date
mariuslp
202df57131 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 09:49:27 -05:00
iBug
d68f76e160 fix: Run release-please workflow only in jekyll/jekyll repo (#9969)
This is a 🐛 bug fix.

## Summary

The `release-please.yml` workflow doesn't make sense in forked
repositories. Let's restrict its execution to jekyll/jekyll only.

I did not expect a "workflow failed" notification soon after catching up
with the upstream in my forked repo:

<img width="1542" height="961" alt="image"
src="https://github.com/user-attachments/assets/5049f2ca-1b1b-42b8-b6ea-4c91ce66a6c3"
/>
2026-04-22 08:50:23 -05:00
Matt Rogers
5cf05d7d09 feat!: Streamline the release process for Jekyll (#9760)
This is a 🙋 feature or enhancement. 
This is a 🔨 code refactoring. 

## Summary

Improve and streamline our release processes with some extra automation
and a bit more rigor around PRs/commits.

## Context

With Jekyll 4.4 released, and under the assumption that the next release
will indeed be 5.0, I think it makes a lot of sense to take some time
and evaluate our development practices and streamline the process of
shipping. We generally go a long time (four months between 4.3.4 and
4.4.0, two years between 4.3.0 and 4.4.0) between releases and this is
my attempt at trying to improve that. While this PR is currently
incomplete, if there's interest in going this direction, I'll make time
over the next few days to clean it up and get it ready to actually ship.

In order to do this, I'm relying on the
[`release-please`](https://github.com/googleapis/release-please-action)
action from Google to do the majority of the heavy lifting. Please read
the release-please README in order to learn how release-please works and
what it does. In order to make it easier to adopt release-please, I've
made two additional changes. ~~The first is to rename `History.markdown`
to `CHANGELOG.md` since that's what `release-please` works with out of
the box.~~ The other is to add two new github actions workflows to run
release-please and to enforce conventional commit conventions on PR
titles. Because we squash merge, the PR title becomes the commit message
and `release-please` uses the commit messages to know when to bump the
version number.

One potential caveat with this is that it may become harder to maintain
stable branches. My point of view on this is that we've done a
relatively poor job of maintaining them regardless and I think it's more
important to release often, even if we end up bumping major or minor
version numbers more frequently than before. My stance on this is that
version bumps have no inherent goodness or badness. They are a
communication mechanism. We should let go of having to wait a certain
amount of time to do major version bumps or avoid work because it would
cause a major version bump, for example.

### Process changes

The use of release-please means that we can stop using jekyllbot to do
the merges and update History.markdown for us, as release-please will
take care of that when we cut the release. We will also no longer need
labels on PRs as the use of conventional commits will explain exactly
what is changing.

The process for releasing becomes:
 - Merge the docs PR
 - Merge the automatically generated release-please PR, which will
trigger the workflows to do the tagging, releasing, gem publishing, etc.

### Remaining work to do:

- [x] Change the pull request settings to only allow squash merges, as
jekyllbot enforces this for us today.
- [x] ~Update the site publishing process to pull from `CHANGELOG.md`
instead of `History.markdown`~ No longer needed.
- [x] Integrate jekyllbot into release-please (the release-please PRs
will be made by jekyllbot). This allows actions to be triggered on the
release-please PRs.
 - [x] Test the workflows to make sure they generate a PR correctly.
 - [x] ~Integrate the release publishing workflow into release-please
when it creates a release.~ Happens automatically with the existing
workflows.
2026-04-17 13:38:58 -05:00
jekyllbot
08c22eefb3 Update history to reflect merge of #9960 [ci skip] 2026-04-14 10:56:52 -07:00
Waishnav
3ed83f6450 Add GitCMS to resources docs (#9960)
Merge pull request 9960
2026-04-14 10:56:50 -07:00
jekyllbot
ff0d4dd78d Update history to reflect merge of #9954 [ci skip] 2026-03-29 20:53:03 -07:00
Matt Rogers
65d534a701 build: fix broken CI on newer rubies (#9954)
Merge pull request 9954
2026-03-29 20:53:01 -07:00
jekyllbot
baab7bf785 Update history to reflect merge of #9925 [ci skip] 2026-03-11 08:39:49 -07:00
Mike Dalton
f07d4f77bc Allow configuring future metadata for individual collections (#9925)
Merge pull request 9925
2026-03-11 08:39:47 -07:00
jekyllbot
d0cf1791f6 Update history to reflect merge of #9914 [ci skip] 2026-02-13 09:06:16 -08:00
Andrew Nesbitt
3c45d9e377 Add .ruby-lsp to default excludes (#9914)
Merge pull request 9914
2026-02-13 09:06:14 -08:00
jekyllbot
26ec089058 Update history to reflect merge of #9920 [ci skip] 2026-02-13 08:48:18 -08:00
Jimmy Bourassa
7e79e461f4 Add logger to Gemfile for Ruby 4.0 (#9920)
Merge pull request 9920
2026-02-13 08:48:17 -08:00
jekyllbot
b49aa9b707 Update history to reflect merge of #9923 [ci skip] 2026-01-05 09:11:47 -08:00
Nemo
ebe567c1d2 Bump supported versions (#9923)
Merge pull request 9923
2026-01-05 09:11:46 -08:00
jekyllbot
4d3db3a83d Update history to reflect merge of #9897 [ci skip] 2025-12-21 12:48:21 -08:00
Y.D.X.
6da6739952 Update WDM (0.1.1 → 0.2.0) in the Windows docs (#9897)
Merge pull request 9897
2025-12-21 12:48:19 -08:00
jekyllbot
161f654409 Update history to reflect merge of #9912 [ci skip] 2025-12-21 12:46:35 -08:00
Chanmi Lee | Kate
e1b5fd6a15 docs: Update contributor badge in README to include avatar height and limit parameters (#9912)
Merge pull request 9912
2025-12-21 12:46:33 -08:00
jekyllbot
2fe6977e8d Update history to reflect merge of #9889 [ci skip] 2025-11-07 14:30:00 -08:00
Álvaro Mondéjar Rubio
e91ed76d97 Fix flaky test that depends on current minute (#9889)
Merge pull request 9889
2025-11-07 14:29:59 -08:00
jekyllbot
a1a42bdb5c Update history to reflect merge of #9882 [ci skip] 2025-10-14 07:57:08 -07:00
Ian
a2c27b70ec Add jekyllup.com to themes documentation (#9882)
Merge pull request 9882
2025-10-14 07:57:06 -07:00
jekyllbot
0760420670 Update history to reflect merge of #9867 [ci skip] 2025-08-27 12:59:07 -07:00
Florian Weingarten
3934fc3184 Fix servlet do_GET header logic (#9867)
Merge pull request 9867
2025-08-27 12:59:05 -07:00
jekyllbot
40ac06ed3e Update history to reflect merge of #9850 [ci skip] 2025-07-11 05:07:19 -07:00
fauno
76982c73c0 Do not treat colons in url_placeholders as URI delimiters (#9850)
Merge pull request 9850
2025-07-11 05:07:17 -07:00
jekyllbot
55024b37ae Update history to reflect merge of #9832 [ci skip] 2025-06-05 08:30:47 -07:00
Sam Cole
59d5d9ae62 Add ruby-erb prerequisite for Arch Linux installations (#9832)
Merge pull request 9832
2025-06-05 08:30:45 -07:00
jekyllbot
a2330bb3b3 Update history to reflect merge of #9776 [ci skip] 2025-06-05 07:51:06 -07:00
Jefferson Quesado
79a8e16f22 feat: Allowing post_url tag to receive liquid variables (#9776)
Merge pull request 9776
2025-06-05 07:51:04 -07:00
jekyllbot
e2e1ee8eaa Update history to reflect merge of #9829 [ci skip] 2025-06-02 08:07:04 -07:00
Ashwin Maroli
2a37caac83 Improve readability of post_url tag (#9829)
Merge pull request 9829
2025-06-02 08:07:02 -07:00
jekyllbot
84437a5052 Update history to reflect merge of #9813 [ci skip] 2025-04-24 05:08:01 -07:00
printfn
01781355ef Fix logs containing IPv6 URLs (#9813)
Merge pull request 9813
2025-04-24 05:08:00 -07:00
Ashwin Maroli
fa5575c806 Configure spell-check to allow azion 2025-04-23 19:02:11 +05:30
jekyllbot
cc583c218c Update history to reflect merge of #9811 [ci skip] 2025-04-22 07:32:19 -07:00
Bruno Germano
5f877c347b Add Azion to the 3rd party deployment docs (#9811)
Merge pull request 9811
2025-04-22 07:32:17 -07:00
Ashwin Maroli
dfbd86db50 Edit History doc to reflect updated pull request titles [skip ci] 2025-04-09 18:04:48 +05:30
Molly Exten
1b617d7281 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 11:15:23 -05:00
Matt Rogers
f6d9f86e04 Update spelling allow list after merging 9786 [ci skip] 2025-04-08 10:58:01 -05:00
jekyllbot
148c1d395c Update history to reflect merge of #9784 [ci skip] 2025-04-08 08:09:47 -07:00
Ashwin Maroli
07a01b0bc9 Avoid caching resource when called via include_relative tag (#9784)
Merge pull request 9784
2025-04-08 08:09:45 -07:00
jekyllbot
82efcc4c51 Update history to reflect merge of #9786 [ci skip] 2025-04-08 08:08:28 -07:00
Fernando Tapia Rico
1e4696457d Add Supranode to third-party deployment guide (#9786)
Merge pull request 9786
2025-04-08 08:08:26 -07:00
jekyllbot
f320d0d5d7 Update history to reflect merge of #9802 [ci skip] 2025-04-08 08:07:48 -07:00
Reinhard Söllradl
193d2eca7f Update resources.md (#9802)
Merge pull request 9802
2025-04-08 08:07:46 -07:00
jekyllbot
0db8443b41 Update history to reflect merge of #9803 [ci skip] 2025-04-08 08:06:47 -07:00
Molly Exten
e4f0c58395 Small documentation update for 09-collections.md (#9803)
Merge pull request 9803
2025-04-08 08:06:45 -07:00
Ashwin Maroli
1f319fb273 Release 💎 v4.4.1 2025-01-29 18:16:50 +05:30
Ashwin Maroli
c5cd1fb04f Restore globbed path behavior in front matter defaults (#9762)
Restore existing behavior in v4.3.x wherein a scope with path
`_*/**/index.md` matches `_label/index.md` as well instead of just
`_label/dir/index.md`.
2025-01-29 18:01:40 +05:30
Ashwin Maroli
33e8a84a00 Add unrecognized words to expected spelling data [skip ci] 2025-01-29 17:39:01 +05:30
Ashwin Maroli
cda8c3a402 Release 💎 v4.4.0 2025-01-27 20:57:32 +05:30
jekyllbot
5431c0945b Update history to reflect merge of #9759 [ci skip] 2025-01-27 07:17:15 -08:00
Ashwin Maroli
e68b3e3e16 Add release post for v4.4.0 (#9759)
Merge pull request 9759
2025-01-27 07:17:13 -08:00
jekyllbot
0cc09f93ca Update history to reflect merge of #9758 [ci skip] 2025-01-24 03:33:13 -08:00
Ashwin Maroli
448b8b5540 Remove unnecessary constraint on gem mercenary (#9758)
Merge pull request 9758
2025-01-24 03:33:11 -08:00
jekyllbot
2cf2665d31 Update history to reflect merge of #9756 [ci skip] 2025-01-23 23:03:09 -08:00
Ashwin Maroli
efc2a7433c Bump check-spelling/check-spelling action (#9756)
Merge pull request 9756
2025-01-23 23:03:07 -08:00
jekyllbot
021f58506f Update history to reflect merge of #9671 [ci skip] 2025-01-23 09:46:41 -08:00
Ashwin Maroli
d5e62d0ca5 Add json as runtime_dependency (#9671)
Merge pull request 9671
2025-01-23 09:46:39 -08:00
jekyllbot
6ea69cae2a Update history to reflect merge of #9753 [ci skip] 2025-01-16 06:15:41 -08:00
Ashwin Maroli
8b759b9c71 Remove unnecessary runtime dependency (#9753)
Merge pull request 9753
2025-01-16 06:15:39 -08:00
jekyllbot
32c90c5eee Update history to reflect merge of #9740 [ci skip] 2025-01-15 23:17:58 -08:00
Ashwin Maroli
76572b421a Add Ruby 3.4 to CI matrix (#9740)
Merge pull request 9740
2025-01-15 23:17:56 -08:00
jekyllbot
409034449b Update history to reflect merge of #9747 [ci skip] 2025-01-15 22:19:22 -08:00
Ashwin Maroli
2db7db7c44 Bump cucumber to v9 (#9747)
Merge pull request 9747
2025-01-15 22:19:20 -08:00
Ashwin Maroli
dfa5f036f7 Improve rendering of site footer 2025-01-02 22:28:17 +05:30
jekyllbot
d20aef3c1c Update history to reflect merge of #9745 [ci skip] 2025-01-01 05:55:25 -08:00
naoki kodama
61c9708264 remove: inaccessible links and their descriptions (#9745)
Merge pull request 9745
2025-01-01 05:55:23 -08:00
jekyllbot
964a2689a1 Update history to reflect merge of #9743 [ci skip] 2024-12-30 08:15:49 -08:00
Ashwin Maroli
98c14c0f2f Test inspect filter with custom object (#9743)
Merge pull request 9743
2024-12-30 08:15:47 -08:00
jekyllbot
74f0c4d079 Update history to reflect merge of #9742 [ci skip] 2024-12-30 06:18:14 -08:00
Ashwin Maroli
3689b5bd97 Add an optional :rdoc group of gems (#9742)
Merge pull request 9742
2024-12-30 06:18:12 -08:00
Ashwin Maroli
092010703f Trigger memprof workflow manually [skip ci] 2024-12-29 19:02:52 +05:30
jekyllbot
1ffce1ed6b Update history to reflect merge of #9737 [ci skip] 2024-12-27 06:45:59 -08:00
Ashwin Maroli
7072c65f6e Fix expected markup per WAI-ARIA requirements (#9737)
Merge pull request 9737
2024-12-27 06:45:57 -08:00
jekyllbot
094fc89d70 Update history to reflect merge of #9704 [ci skip] 2024-12-16 06:26:51 -08:00
Khalila
70e4e87945 Fix broken link on third-party.md (#9704)
Merge pull request 9704
2024-12-16 06:26:49 -08:00
jekyllbot
0e4182aefa Update history to reflect merge of #9715 [ci skip] 2024-11-20 07:05:44 -08:00
Silent
6a4a630bdf Link to GitHub Pages Dependency versions page instead of explicitly specifying Jekyll version (#9715)
Merge pull request 9715
2024-11-20 07:05:43 -08:00
jekyllbot
8e378c0615 Update history to reflect merge of #9699 [ci skip] 2024-10-20 08:42:00 -07:00
林博仁 Buo-ren Lin
6b0af7144d Fix missing url configuration option documentation (#9699)
Merge pull request 9699
2024-10-20 08:41:58 -07:00
jekyllbot
f93928ab2c Update history to reflect merge of #9697 [ci skip] 2024-10-20 07:22:49 -07:00
林博仁 Buo-ren Lin
0c4a453e2c 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 07:22:47 -07:00
jekyllbot
44fc6803d2 Update history to reflect merge of #9688 [ci skip] 2024-10-17 06:10:17 -07:00
Ashwin Maroli
5e1b6d3fae Configure some new cops (#9688)
Merge pull request 9688
2024-10-17 06:10:15 -07:00
jekyllbot
fce1966b3a Update history to reflect merge of #9695 [ci skip] 2024-10-10 08:09:12 -07:00
林博仁 Buo-ren Lin
8ba078f95d 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 08:09:11 -07:00
jekyllbot
94192a3ab4 Update history to reflect merge of #9666 [ci skip] 2024-09-22 11:22:01 -07:00
Ashwin Maroli
f8a456d16e Render HTML tables at /docs/permalinks/ using a data file (#9666)
Merge pull request 9666
2024-09-22 11:21:59 -07:00
jekyllbot
0f03b31b85 Update history to reflect merge of #9689 [ci skip] 2024-09-22 11:01:38 -07:00
Seth Louis
27805c97ec Fix grammar in the description of page.excerpt variable (#9689)
Merge pull request 9689
2024-09-22 11:01:36 -07:00
jekyllbot
e223b9e1e3 Update history to reflect merge of #9682 [ci skip] 2024-09-22 05:25:42 -07:00
nisbet-hubbard
860c5d6394 Improve docs around using GitHub Actions to build and deploy Jekyll sites (#9682)
Merge pull request 9682
2024-09-22 05:25:40 -07:00
jekyllbot
ca57a45b17 Update history to reflect merge of #9687 [ci skip] 2024-09-20 04:25:04 -07:00
Ashwin Maroli
94831d572d Format .rubocop.yml via a rake task (#9687)
Merge pull request 9687
2024-09-20 04:25:02 -07:00
Ashwin Maroli
ef6ae0305e Publish Release Post for v4.3.4 2024-09-16 21:50:13 +05:30
jekyllbot
4ad5419d55 Update history to reflect merge of #9680 [ci skip] 2024-09-16 08:40:57 -07:00
Ashwin Maroli
32074ef944 Render theme-gem root only in development (#9680)
Merge pull request 9680
2024-09-16 08:40:55 -07:00
Ashwin Maroli
eba4dbcc72 Update history to reflect merge of #9614 [ci skip] 2024-09-16 20:24:11 +05:30
Moncef Belyamani
5861d3ab28 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 20:08:42 +05:30
jekyllbot
17d1d9422b Update history to reflect merge of #8890 [ci skip] 2024-09-15 07:10:34 -07:00
Simon Wagar
34e35284aa Fix of a bug in the pagination section (#8890)
Merge pull request 8890
2024-09-15 07:10:33 -07:00
jekyllbot
0629bba297 Update history to reflect merge of #9629 [ci skip] 2024-09-15 06:27:45 -07:00
KenHV
192360dd6a docs: Fix incorrect parentheses (#9629)
Merge pull request 9629
2024-09-15 06:27:44 -07:00
jekyllbot
96a5c80b59 Update history to reflect merge of #9675 [ci skip] 2024-09-11 23:47:00 -07:00
Ashwin Maroli
75d70a0ba8 Extract markup for Improve this page into an inclusion (#9675)
Merge pull request 9675
2024-09-11 23:46:58 -07:00
jekyllbot
bc443c2e66 Update history to reflect merge of #9570 [ci skip] 2024-09-11 06:55:30 -07:00
Mike Slinn
0fde781f2b Fix --livereload-ignore option (#9570)
Merge pull request 9570
2024-09-11 06:55:28 -07:00
Ashwin Maroli
aa8c2466ca [Docs] Mention introduced version for config key 2024-09-08 23:39:42 +05:30
jekyllbot
a5cf2f9a42 Update history to reflect merge of #9606 [ci skip] 2024-09-08 10:17:07 -07:00
Gourav Khunger
f63a68bedd fix: acknowledge livereload_port from site config too (#9606)
Merge pull request 9606
2024-09-08 10:17:06 -07:00
jekyllbot
753b8aaa09 Update history to reflect merge of #9609 [ci skip] 2024-09-08 06:30:11 -07:00
QuinnG8
c59e59091d Add note about VSCode warning for SCSS files (#9609)
Merge pull request 9609
2024-09-08 06:30:10 -07:00
jekyllbot
f2980230e5 Update history to reflect merge of #9667 [ci skip] 2024-09-06 11:21:08 -07:00
Ashwin Maroli
c458e1413a Fix lapses in documentation of page variables (#9667)
Merge pull request 9667
2024-09-06 11:21:06 -07:00
Ashwin Maroli
760eaf0274 Clean up History.markdown [skip ci]
* Remove duplicate entries pertaining to changes to `3.9-stable` and `3.10-stable` under HEAD.
* Re-arrange headings to follow documented order of priority:
  Minor Enhancements > Bug Fixes > Development Fixes > Documentation Changes
2024-09-06 20:32:14 +05:30
jekyllbot
0913d65793 Update history to reflect merge of #9591 [ci skip] 2024-09-06 02:24:45 -07:00
iulianOnofrei (U-lee-aan)
a6739dcfd2 Fix incorrect and inconsistent variables in the permalinks page (#9591)
Merge pull request 9591
2024-09-06 02:24:43 -07:00
jekyllbot
05ce2b2ab2 Update history to reflect merge of #9664 [ci skip] 2024-09-06 02:20:56 -07:00
Ashwin Maroli
f95c5e45bb Run GitHub Actions only if needed (#9664)
Merge pull request 9664
2024-09-06 02:20:55 -07:00
jekyllbot
cd5b71ec88 Update history to reflect merge of #9659 [ci skip] 2024-09-05 23:10:04 -07:00
Ashwin Maroli
e300964879 Windows CI on GitHub Actions (#9659)
Merge pull request 9659
2024-09-05 23:10:02 -07:00
jekyllbot
37b4a4bd89 Update history to reflect merge of #9662 [ci skip] 2024-09-05 07:22:37 -07:00
Ashwin Maroli
3a8b2822f1 Relax version constraint on wdm in new Gemfile (#9662)
Merge pull request 9662
2024-09-05 07:22:34 -07:00
jekyllbot
995c7c8d65 Update history to reflect merge of #9661 [ci skip] 2024-09-05 05:51:29 -07:00
Ashwin Maroli
cde2de69a7 Stop testing with Cucumber on JRuby (#9661)
Merge pull request 9661
2024-09-05 05:51:27 -07:00
jekyllbot
425ad79ff2 Update history to reflect merge of #9653 [ci skip] 2024-08-29 08:16:09 -07:00
Ashwin Maroli
3283e679bc Document keys of global variable {{ jekyll }} (#9653)
Merge pull request 9653
2024-08-29 08:16:07 -07:00
jekyllbot
5947231337 Update history to reflect merge of #9654 [ci skip] 2024-08-29 08:09:21 -07:00
Olle Jonsson
2445bd946e CI: Use JRuby 9.4.8.0 (#9654)
Merge pull request 9654
2024-08-29 08:09:19 -07:00
jekyllbot
a5460320c5 Update history to reflect merge of #9644 [ci skip] 2024-08-04 11:25:55 -07:00
Krisztian Zsolt Sallai
e55274d8f8 Update windows.md (#9644)
Merge pull request 9644
2024-08-04 11:25:54 -07:00
jekyllbot
3d5e86eb08 Update history to reflect merge of #9641 [ci skip] 2024-07-26 00:04:04 -07:00
Virgil Ierubino
885c98a32b Fix error (#9641)
Merge pull request 9641
2024-07-26 00:04:03 -07:00
jekyllbot
60a9cd7356 Update history to reflect merge of #9625 [ci skip] 2024-06-24 15:27:06 -07:00
Parker Moore
822ac4fa47 Add Jekyll 3.10.0 release post & history (#9625)
Merge pull request 9625
2024-06-24 15:27:04 -07:00
jekyllbot
e44b52d9f9 Update history to reflect merge of #9620 [ci skip] 2024-06-17 18:53:57 -07:00
jekyllbot
ed79646d7d Update history to reflect merge of #9616 [ci skip] 2024-06-13 09:56:39 -07:00
jekyllbot
1484c6d6a4 Update history to reflect merge of #9593 [ci skip] 2024-05-23 10:53:19 -07:00
Joel Coffman
38a18af96a Add redirect for step-by-step tutorial (#9593)
Merge pull request 9593
2024-05-23 10:53:17 -07:00
jekyllbot
b6bbe1b469 Update history to reflect merge of #9589 [ci skip] 2024-05-23 09:22:10 -07:00
iulianOnofrei (U-lee-aan)
ed30c864f2 Fix inexistent layout warning for the default 404 page (#9589)
Merge pull request 9589
2024-05-23 09:22:08 -07:00
jekyllbot
1ad8c8dc04 Update history to reflect merge of #9597 [ci skip] 2024-05-22 11:02:13 -07:00
Koichi ITO
28e10da266 Make custom cop inherit RuboCop::Cop::Base (#9597)
Merge pull request 9597
2024-05-22 11:02:11 -07:00
jekyllbot
c52149824d Update history to reflect merge of #9600 [ci skip] 2024-05-22 11:01:20 -07:00
Matt Rogers
1f3c0dc0d4 fix(rubocop): correct lint errors (#9600)
Merge pull request 9600
2024-05-22 11:01:18 -07:00
jekyllbot
96a4198c27 Update history to reflect merge of #9586 [ci skip] 2024-04-23 11:59:01 -07:00
a story
c85bd15340 Fixed: Wrong navigation style on the right side of news and docs pages (#9586)
Merge pull request 9586
2024-04-23 11:58:59 -07:00
jekyllbot
dbbfc5d48c Update history to reflect merge of #9550 [ci skip] 2024-02-12 20:19:22 -08:00
jekyllbot
c7e9061da3 Update history to reflect merge of #9548 [ci skip] 2024-02-12 19:01:18 -08:00
velle
22c756a2e0 Jekyll docs template typo - All pages show "Deployment" (#9548)
Merge pull request 9548
2024-02-12 19:01:16 -08:00
jekyllbot
12ab35011f Update history to reflect merge of #9535 [ci skip] 2024-01-23 10:53:22 -08:00
Parker Moore
84a29bd142 Add a few more emeritus team members (#9535)
Merge pull request 9535
2024-01-23 10:53:21 -08:00
jekyllbot
860d730ff3 Update history to reflect merge of #9530 [ci skip] 2024-01-16 22:58:30 -08:00
Matt Rogers
8f2b53172f fix: make search work again (#9530)
Merge pull request 9530
2024-01-16 22:58:28 -08:00
jekyllbot
b38b7a1479 Update history to reflect merge of #9525 [ci skip] 2024-01-12 18:48:58 -08:00
Matt Rogers
db3437a34f chore: Bump the required ruby version to 2.7 (#9525)
Merge pull request 9525
2024-01-12 18:48:56 -08:00
jekyllbot
42dd477f8a Update history to reflect merge of #9517 [ci skip] 2024-01-12 09:05:01 -08:00
Akira Taguchi
01da87c5f9 Fix gem quote consistency on docs (#9517)
Merge pull request 9517
2024-01-12 09:05:00 -08:00
jekyllbot
839007fa15 Update history to reflect merge of #9338 [ci skip] 2024-01-12 08:57:17 -08:00
Daniel Haim
55e993be25 Improve accessibility of the docs (#9338)
Merge pull request 9338
2024-01-12 08:57:15 -08:00
jekyllbot
108c8419e3 Update history to reflect merge of #9522 [ci skip] 2024-01-10 09:00:10 -08:00
halorrr
25fd87c3e2 add csv to runtime dependency list (#9522)
Merge pull request 9522
2024-01-10 09:00:07 -08:00
jekyllbot
5ae029f9cd Update history to reflect merge of #9520 [ci skip] 2024-01-05 13:57:54 -08:00
Michael Nordmeyer
2ed5f33da6 Add docs version to pages_excerpts feature (#9520)
Merge pull request 9520
2024-01-05 13:57:53 -08:00
jekyllbot
3234c1a38a Update history to reflect merge of #9512 [ci skip] 2023-12-28 16:34:51 -08:00
Parker Moore
901256a42c Fix Performance/StringIdentifierArgument violation in site.rb and allow activesupport 6 for windows tests (#9512)
Merge pull request 9512
2023-12-28 16:34:50 -08:00
Parker Moore
b2e99a0e12 Merge pull request #9515 from jekyll/jekyll-3-9-4-docs 2023-12-28 15:24:55 -08:00
Parker Moore
6c9611d90a Add Jekyll 3.9.4 release post and changelog 2023-12-28 14:58:26 -08:00
jekyllbot
6d2d29220c Update history to reflect merge of #9511 [ci skip] 2023-12-27 12:52:14 -08:00
Matt Rogers
f9c2395a86 Add release post for v4.3.3 (#9511)
Merge pull request 9511
2023-12-27 12:52:12 -08:00
jekyllbot
646b424166 Update history to reflect merge of #9496 [ci skip] 2023-12-01 08:51:37 -08:00
Jonas Jared Jacek
432d0e3e7d Update resources.md (#9496)
Merge pull request 9496
2023-12-01 08:51:35 -08:00
jekyllbot
0753e56ec7 Update history to reflect merge of #9497 [ci skip] 2023-12-01 08:48:51 -08:00
Jonas Jared Jacek
52aab1bc10 Update security.md (#9497)
Merge pull request 9497
2023-12-01 08:48:49 -08:00
jekyllbot
3f3a283018 Update history to reflect merge of #9481 [ci skip] 2023-11-03 15:22:00 -07:00
Gaelan Lloyd
b427a17315 Add FreeBSD installation instructions (#9481)
Merge pull request 9481
2023-11-03 15:21:58 -07:00
jekyllbot
7a79d0ba0c Update history to reflect merge of #9473 [ci skip] 2023-10-31 09:48:06 -07:00
Seth Falco
537032c49d chore: update showcases (#9473)
Merge pull request 9473
2023-10-31 09:48:04 -07:00
jekyllbot
644a704ad5 Update history to reflect merge of #9476 [ci skip] 2023-10-31 09:47:20 -07:00
David Silveira
4bfb4edc40 Update rubocop gem (#9476)
Merge pull request 9476
2023-10-31 09:47:18 -07:00
jekyllbot
2be8e6ce4f Update history to reflect merge of #9445 [ci skip] 2023-10-31 08:59:14 -07:00
Matt Rogers
cd4d84a44f Configure dependabot to handle rubygems dependencies (#9445)
Merge pull request 9445
2023-10-31 08:59:12 -07:00
jekyllbot
77bea6951b Update history to reflect merge of #9477 [ci skip] 2023-10-31 08:48:49 -07:00
Gabriel B. Nunes
d0afea2b03 Clarify which version of Jekyll needs 'jekyll-paginate' (#9477)
Merge pull request 9477
2023-10-31 08:48:45 -07:00
jekyllbot
e57890a290 Update history to reflect merge of #9235 [ci skip] 2023-10-22 10:49:08 -07:00
William Entriken
c52bbde5ec Add GitHub Pages helpful notes (#9235)
Merge pull request 9235
2023-10-22 10:49:06 -07:00
jekyllbot
e0c4640a7a Update history to reflect merge of #9459 [ci skip] 2023-10-22 09:49:14 -07:00
Juan Vásquez
d9df973d2c Bump Rubocop to 1.56.4 (#9459)
Merge pull request 9459
2023-10-22 09:49:12 -07:00
jekyllbot
99f1a235ea Update history to reflect merge of #9469 [ci skip] 2023-10-22 09:47:32 -07:00
Matt Rogers
a70f5cba65 Keep activesupport at version 7.0.x (#9469)
Merge pull request 9469
2023-10-22 09:47:29 -07:00
jekyllbot
8e4ccfc4ff Update history to reflect merge of #9449 [ci skip] 2023-09-23 19:47:29 -07:00
José Romero
3ba746c979 Update resources.md (#9449)
Merge pull request 9449
2023-09-23 19:47:27 -07:00
jekyllbot
1d7236f2c2 Update history to reflect merge of #9441 [ci skip] 2023-09-15 08:47:59 -07:00
Vít Ondruch
d865905d66 Test suite uses shoulda-context only. (#9441)
Merge pull request 9441
2023-09-15 08:47:57 -07:00
jekyllbot
65d7a09174 Update history to reflect merge of #9442 [ci skip] 2023-09-14 17:48:53 -07:00
dependabot[bot]
895a5033c0 Bump actions/checkout from 3 to 4 (#9442)
Merge pull request 9442
2023-09-14 17:48:51 -07:00
jekyllbot
96a640a8c9 Update history to reflect merge of #9426 [ci skip] 2023-09-14 02:05:47 -07:00
なつき
0417baf058 Update github-actions documentation (#9426)
Merge pull request 9426
2023-09-14 02:05:44 -07:00
jekyllbot
d86ba153fe Update history to reflect merge of #9348 [ci skip] 2023-08-14 11:21:25 -07:00
Jonas Jared Jacek
1fbd42ceeb Update convert-site-to-jekyll.md (#9348)
Merge pull request 9348
2023-08-14 11:21:22 -07:00
jekyllbot
0b1aaf5dc1 Update history to reflect merge of #9397 [ci skip] 2023-08-13 17:52:24 -07:00
Jorge
a385117f2c Add CodeQL workflow (#9397)
Merge pull request 9397
2023-08-13 17:52:22 -07:00
jekyllbot
1e18bef7c0 Update history to reflect merge of #9290 [ci skip] 2023-08-13 17:33:18 -07:00
James Hoctor
4c882541d7 Update Fedora prerequisites to include g++ (#9290)
Merge pull request 9290
2023-08-13 17:33:16 -07:00
jekyllbot
f8a3f9bb6a Update history to reflect merge of #9331 [ci skip] 2023-08-13 17:33:11 -07:00
Maciek Palmowski
2277999f39 Adds Kinsta to 3rd party deployments (#9331)
Merge pull request 9331
2023-08-13 17:33:08 -07:00
jekyllbot
3198f2e922 Update history to reflect merge of #9356 [ci skip] 2023-08-13 17:33:02 -07:00
Robert Austin
71fe6aaa0a Add new theme directory to themes resources (#9356)
Merge pull request 9356
2023-08-13 17:33:00 -07:00
jekyllbot
e90053e489 Update history to reflect merge of #9362 [ci skip] 2023-08-13 17:32:44 -07:00
Joe Mahoney
dafa28d40c Point to the Rouge GitHub repo rather than broken website (#9362)
Merge pull request 9362
2023-08-13 17:32:43 -07:00
jekyllbot
e5c4948de6 Update history to reflect merge of #9364 [ci skip] 2023-08-13 17:32:30 -07:00
Ram Vasuthevan
8c4bed5e4f Fix typo in devcontainer.json (#9364)
Merge pull request 9364
2023-08-13 17:32:28 -07:00
jekyllbot
16fb63a326 Update history to reflect merge of #9423 [ci skip] 2023-08-13 17:31:51 -07:00
IFcoltransG
0ab743204a Note the front matter requirement in pages.md (#9423)
Merge pull request 9423
2023-08-13 17:31:49 -07:00
jekyllbot
21847cf798 Update history to reflect merge of #9393 [ci skip] 2023-08-13 13:18:00 -07:00
Shruti Dalvi
76a9a194cf Update 07-assets.md (#9393)
Merge pull request 9393
2023-08-13 13:17:58 -07:00
jekyllbot
6ee39423cd Update history to reflect merge of #9392 [ci skip] 2023-08-11 19:49:16 -07:00
Sutou Kouhei
e57c755c6f Add support for upcoming logger 1.4.3 (#9392)
Merge pull request 9392
2023-08-11 19:49:14 -07:00
jekyllbot
cb6676ba13 Update history to reflect merge of #9411 [ci skip] 2023-08-11 19:47:04 -07:00
Muhab Abdelreheem
d99471332d Typo fix - update to hooks and 3rd party deployment and one other article (#9411)
Merge pull request 9411
2023-08-11 19:47:03 -07:00
jekyllbot
a6b861cd95 Update history to reflect merge of #9406 [ci skip] 2023-07-10 12:00:13 -07:00
William Entriken
dd4312270c Update macos.md (#9406)
Merge pull request 9406
2023-07-10 12:00:11 -07:00
jekyllbot
aef05280c8 Update history to reflect merge of #9405 [ci skip] 2023-07-10 08:14:08 -07:00
William Entriken
d04f1afc81 Update macos.md (#9405)
Merge pull request 9405
2023-07-10 08:14:06 -07:00
jekyllbot
e2527eb872 Update history to reflect merge of #9401 [ci skip] 2023-07-08 15:24:38 -07:00
Joe Mahoney
fdb4c623ba #9398 upgrade RuboCop to 1.54 (#9401)
Merge pull request 9401
2023-07-08 15:24:36 -07:00
jekyllbot
0be06e5eb1 Update history to reflect merge of #9361 [ci skip] 2023-06-05 05:48:58 -07:00
Joe Mahoney
acae1e1ce8 Bump rubocop version to 1.52.x (#9361)
Merge pull request 9361
2023-06-05 05:48:56 -07:00
jekyllbot
07c8d98e88 Update history to reflect merge of #9376 [ci skip] 2023-06-05 05:45:33 -07:00
Tomáš Hübelbauer
11987c65e0 Document Exclude behavior, Include overrides and the default exclusion list (#9376)
Merge pull request 9376
2023-06-05 05:45:31 -07:00
jekyllbot
58a1f62b23 Update history to reflect merge of #9360 [ci skip] 2023-05-08 06:25:46 -07:00
Joe Mahoney
c6dfae56d0 Bump versions of ruby & nodejs in devcontainer (#9360)
Merge pull request 9360
2023-05-08 06:25:44 -07:00
Ashwin Maroli
bb954ff16e Prefer using assert_instance_of
To appease RuboCop `Minitest/AssertInstanceOf`
2023-04-09 19:48:28 +05:30
jekyllbot
7785ef670f Update history to reflect merge of #9326 [ci skip] 2023-03-26 02:05:13 -07:00
waqarnazir
6bedc7e069 Bump Rubocop to version 1.48.x (#9326)
Merge pull request 9326
2023-03-26 02:05:10 -07:00
jekyllbot
8c8c88eec0 Update history to reflect merge of #9292 [ci skip] 2023-03-24 01:59:21 -07:00
Ashwin Maroli
d03742e994 Handle TypeError from where filter gracefully (#9292)
Merge pull request 9292
2023-03-24 01:59:18 -07:00
Ashwin Maroli
052f1bd412 Revert "Normalize line-endings in test plugins"
This reverts commit 73fcc42353.
2023-03-02 12:54:09 +05:30
Ashwin Maroli
73fcc42353 Normalize line-endings in test plugins 2023-03-02 12:48:53 +05:30
jekyllbot
ee2d299370 Update history to reflect merge of #9304 [ci skip] 2023-02-21 14:57:05 -08:00
なつき
16a1e5cac4 Fix jekyll serve --detach with jekyll-sass-converter 3.x (#9304)
Merge pull request 9304
2023-02-21 14:57:03 -08:00
Ashwin Maroli
ecf098580d [Docs]: Adjust line-length in Markdown code-blocks [skip appveyor] 2023-02-16 20:10:15 +05:30
Ashwin Maroli
0cbcf93779 [Docs]: Define :path url-placeholder in sample plugin [skip ci] 2023-02-16 18:51:24 +05:30
jekyllbot
56bbf58911 Update history to reflect merge of #9305 [ci skip] 2023-02-16 04:26:23 -08:00
Ashwin Maroli
4ecbeb4063 Bump RuboCop to v1.45.x (#9305)
Merge pull request 9305
2023-02-16 04:26:21 -08:00
Ashwin Maroli
66e6b2f2d3 Strip extra newlines in History document [ci skip] 2023-02-01 19:36:22 +05:30
Ashwin Maroli
7b6dc1f287 Update History doc to reflect spelling corrections [ci skip] 2023-02-01 19:20:49 +05:30
jekyllbot
80f799b0b6 Update history to reflect merge of #9199 [ci skip] 2023-02-01 05:37:07 -08:00
Josh Soref
7047e7dfb4 Use check-spelling/check-spelling@v0.0.21 (#9199)
Merge pull request 9199
2023-02-01 05:37:05 -08:00
jekyllbot
c0ad3ac41e Update history to reflect merge of #9221 [ci skip] 2023-02-01 05:30:10 -08:00
Sean M. Collins
4cc1905ae3 Update S3 deployment to remove s3_website (#9221)
Merge pull request 9221
2023-02-01 05:30:07 -08:00
jekyllbot
c4af6efca9 Update history to reflect merge of #9205 [ci skip] 2023-01-30 09:49:57 -08:00
dependabot[bot]
e0cd941c09 Bump check-spelling/check-spelling from 0.0.20 to 0.0.21 (#9205)
Merge pull request 9205
2023-01-30 09:49:55 -08:00
jekyllbot
e90fa179d4 Update history to reflect merge of #9284 [ci skip] 2023-01-30 01:41:30 -08:00
Parker Moore
ac4abbd14d Add v3.9.3 release history & post to master branch (#9284)
Merge pull request 9284
2023-01-30 01:41:28 -08:00
Ashwin Maroli
2b590254a1 Test with Ruby 3.2 2023-01-29 21:01:59 +05:30
jekyllbot
87dd43e654 Update history to reflect merge of #9184 [ci skip] 2023-01-27 07:24:29 -08:00
Andy Coates
ef62f7455c Mark highlight mark_lines feature as 4.4 in docs (#9184)
Merge pull request 9184
2023-01-27 07:24:26 -08:00
Ashwin Maroli
e793a96bda Clean up AppVeyor config
[skip ci]
2023-01-27 20:05:37 +05:30
jekyllbot
583da3491f Update history to reflect merge of #9264 [ci skip] 2023-01-26 02:55:37 -08:00
William Underwood
2bd91fdd8c fixed grammatical mistake on "showcase" page (#9264)
Merge pull request 9264
2023-01-26 02:55:35 -08:00
jekyllbot
bf13d8dfbc Update history to reflect merge of #9245 [ci skip] 2023-01-26 02:54:11 -08:00
plgagne
0da02acdf8 grammatical reordering (#9245)
Merge pull request 9245
2023-01-26 02:54:09 -08:00
Ashwin Maroli
67ab1be220 Fix History entry for v4.3.2 2023-01-25 19:24:20 +05:30
Ashwin Maroli
ff60d51c9b Release 💎 v4.3.2 2023-01-20 23:53:30 +05:30
jekyllbot
03db5267a3 Update history to reflect merge of #9263 [ci skip] 2023-01-20 10:13:06 -08:00
Ashwin Maroli
c7e3e689e7 Add release post for v4.3.2 (#9263)
Merge pull request 9263
2023-01-20 10:13:04 -08:00
jekyllbot
99a1b72493 Update history to reflect merge of #9259 [ci skip] 2023-01-18 23:05:42 -08:00
Parker Moore
bf8d50ee08 script/default-site: accept flags for jekyll new (#9259)
Merge pull request 9259
2023-01-18 23:05:39 -08:00
jekyllbot
2aa2861a5d Update history to reflect merge of #9257 [ci skip] 2023-01-18 23:00:25 -08:00
Ashwin Maroli
3a1848066b Rename sass partial created for new blank site (#9257)
Merge pull request 9257
2023-01-18 23:00:21 -08:00
jekyllbot
a891118af4 Update history to reflect merge of #9195 [ci skip] 2023-01-04 03:09:07 -08:00
masaki
bfa7c94899 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 03:09:05 -08:00
jekyllbot
39ee3317f4 Update history to reflect merge of #9237 [ci skip] 2022-12-28 23:23:38 -08:00
Mamoru TASAKA
249101aea6 test: use hash explicitly for Struct initializer for ruby 3.2 (#9237)
Merge pull request 9237
2022-12-28 23:23:36 -08:00
jekyllbot
0951a4653d Update history to reflect merge of #9230 [ci skip] 2022-12-26 06:16:41 -08:00
Ashwin Maroli
ee3576e2cb Split test/test_tags.rb into multiple files (#9230)
Merge pull request 9230
2022-12-26 06:16:39 -08:00
jekyllbot
dbaca2c107 Update history to reflect merge of #9225 [ci skip] 2022-12-22 22:20:09 -08:00
Ashwin Maroli
69839ba6dc Publish post on major release of sass-converter (#9225)
Merge pull request 9225
2022-12-22 22:20:07 -08:00
jekyllbot
548b9e9372 Update history to reflect merge of #9223 [ci skip] 2022-12-22 06:51:04 -08:00
なつき
572c86ec13 Update sass related tests for jekyll-sass-converter 3.x (#9223)
Merge pull request 9223
2022-12-22 06:51:02 -08:00
Ashwin Maroli
fc75f5360d Stop testing with Rubies older than 2.7 on Windows 2022-12-18 22:03:51 +05:30
Ashwin Maroli
300668ed7f 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 19:15:34 +05:30
Ashwin Maroli
f1a20d0e22 Reword there're to there are 2022-12-18 18:59:35 +05:30
jekyllbot
4c1ab7f182 Update history to reflect merge of #9187 [ci skip] 2022-12-18 05:20:28 -08:00
Ashwin Maroli
b2891a476e Optimize Site#each_site_file (#9187)
Merge pull request 9187
2022-12-18 05:20:27 -08:00
jekyllbot
80fc7729ad Update history to reflect merge of #9186 [ci skip] 2022-12-18 05:14:04 -08:00
Ashwin Maroli
82bb2714df Remove totals in profile table properly (#9186)
Merge pull request 9186
2022-12-18 05:14:02 -08:00
jekyllbot
d78c65f2c7 Update history to reflect merge of #9203 [ci skip] 2022-12-04 02:48:43 -08:00
Valeriy Van
072808d953 Fix typo (#9203)
Merge pull request 9203
2022-12-04 02:48:41 -08:00
jekyllbot
bf67f086c4 Update history to reflect merge of #9185 [ci skip] 2022-11-27 09:29:36 -08:00
Ashwin Maroli
0cf8533f61 Optimize default front matter using File.fnmatch? (#9185)
Merge pull request 9185
2022-11-27 09:29:34 -08:00
jekyllbot
ee29b05e80 Update history to reflect merge of #9196 [ci skip] 2022-11-27 08:21:31 -08:00
Ashwin Maroli
3fded46fa9 Lock Ruby in CI to v3.1.2 and bump JRuby to v9.4.0.0 (#9196)
Merge pull request 9196
2022-11-27 08:21:30 -08:00
Ashwin Maroli
581717cc41 Fix ordered-list style in articles on mobiles 2022-11-07 18:45:33 +05:30
jekyllbot
66fe8b5f21 Update history to reflect merge of #9168 [ci skip] 2022-11-06 23:19:12 -08:00
Otto Liljalaakso
28a475a660 Run tests in UTC timezone (#9168)
Merge pull request 9168
2022-11-06 23:19:10 -08:00
jekyllbot
9301d53ca9 Update history to reflect merge of #9177 [ci skip] 2022-11-06 22:54:21 -08:00
Ashwin Maroli
f40e5cff5f Cleanup highlight tag (#9177)
Merge pull request 9177
2022-11-06 22:54:19 -08:00
jekyllbot
4c42559a51 Update history to reflect merge of #9174 [ci skip] 2022-11-03 07:51:36 -07:00
Robert Love
645584824f Fix Nested tree navigation with recursion example (#9174)
Merge pull request 9174
2022-11-03 07:51:34 -07:00
jekyllbot
48977ec304 Update history to reflect merge of #9138 [ci skip] 2022-11-03 07:40:56 -07:00
Olly Headey
7558ecb1f7 Allow marking specific highlighted lines via Liquid (#9138)
Merge pull request 9138
2022-11-03 07:40:54 -07:00
Ashwin Maroli
99cfe52cd8 Bump RuboCop to v1.38.x
Closes #9173
2022-11-02 14:45:10 +05:30
Ashwin Maroli
94028e7f4c Remove noise in features/highlighting.feature 2022-10-27 20:22:52 +05:30
Ashwin Maroli
91e00b2082 Release 💎 v4.3.1 2022-10-26 23:25:48 +05:30
jekyllbot
8cc0640a68 Update history to reflect merge of #9171 [ci skip] 2022-10-26 10:49:17 -07:00
Ashwin Maroli
28d4eacdcb Release post for v4.3.1 (#9171)
Merge pull request 9171
2022-10-26 10:49:15 -07:00
jekyllbot
eef8030950 Update history to reflect merge of #9170 [ci skip] 2022-10-26 09:38:16 -07:00
Ashwin Maroli
5367a0261d Revert "Incrementally rebuild when a data file is changed (#8771)" (#9170)
Merge pull request 9170
2022-10-26 09:38:14 -07:00
jekyllbot
04123c0cad Update history to reflect merge of #9167 [ci skip] 2022-10-26 09:36:34 -07:00
Ashwin Maroli
7206b7f9ef Respect user-defined name attribute in documents (#9167)
Merge pull request 9167
2022-10-26 09:36:32 -07:00
Ashwin Maroli
390b1f006b Revert back to developing 4.3.x
This reverts commit 556febb436.
This reverts commit a613eb2d82.
2022-10-21 23:22:47 +05:30
Ashwin Maroli
556febb436 Mark initiation of v5.0 development
To prevent users from pointing their Gemfile to the repository and breaking their site.
2022-10-20 22:46:28 +05:30
Ashwin Maroli
a613eb2d82 Disable critical GH Actions on master
To mark `master` as in v5 development mode
2022-10-20 22:21:44 +05:30
Ashwin Maroli
2b56ad4f6d Fix spelling errors in History document 2022-10-20 21:57:37 +05:30
Ashwin Maroli
9c2c01bb7a Release 💎 v4.3.0 2022-10-20 21:32:59 +05:30
jekyllbot
a81cd42768 Update history to reflect merge of #9157 [ci skip] 2022-10-20 08:57:37 -07:00
Ashwin Maroli
b32293cf67 Release post for v4.3.0 (#9157)
Merge pull request 9157
2022-10-20 08:57:35 -07:00
Ashwin Maroli
e27605e380 Clean up HEAD section in History document 2022-10-20 18:58:29 +05:30
Giuseppe Bertone
520326406c Document xz dependency on macOS (#9098)
Signed-off-by: Giuseppe Bertone <giuseppe.bertone@swirldslabs.com>
2022-10-20 15:52:08 +05:30
Kaben
f030e55f70 Fix URL to Liquid documentation (#9158) 2022-10-20 15:45:40 +05:30
Ashwin Maroli
6d3dc74c7d Bump RuboCop to v1.37.x 2022-10-20 14:47:52 +05:30
jekyllbot
35e08eb9db Update history to reflect merge of #9132 [ci skip] 2022-10-16 07:37:06 -07:00
なつき
03f7ddc801 Support jekyll-sass-converter 3.x (#9132)
Merge pull request 9132
2022-10-16 07:37:05 -07:00
jekyllbot
3554b73b7f Update history to reflect merge of #9141 [ci skip] 2022-10-16 04:48:26 -07:00
Youssef Boulkaid
6903f0b0f4 Fix false positive conflicts for static files in a collection (#9141)
Merge pull request 9141
2022-10-16 04:48:24 -07:00
jekyllbot
bb851e235d Update history to reflect merge of #9151 [ci skip] 2022-10-06 23:04:42 -07:00
Kaben
5d5d975672 Update posts.md (#9151)
Merge pull request 9151
2022-10-06 23:04:40 -07:00
jekyllbot
fe45439b6c Update history to reflect merge of #9142 [ci skip] 2022-10-02 03:16:54 -07:00
Youssef Boulkaid
823c8f94d2 Relax RDoc version dependency (#9142)
Merge pull request 9142
2022-10-02 03:16:53 -07:00
jekyllbot
2cc51e6aba Update history to reflect merge of #8771 [ci skip] 2022-09-29 05:46:26 -07:00
Ashwin Maroli
160a6816af Incrementally rebuild when a data file is changed (#8771)
Merge pull request 8771
2022-09-29 05:46:24 -07:00
jekyllbot
d45fb96477 Update history to reflect merge of #9136 [ci skip] 2022-09-29 03:37:44 -07:00
Youssef Boulkaid
daca7e53a1 Disable pending cops when running rubocop (#9136)
Merge pull request 9136
2022-09-29 03:37:42 -07:00
jekyllbot
e05a25a668 Update history to reflect merge of #9135 [ci skip] 2022-09-29 00:16:34 -07:00
Youssef Boulkaid
7a70a3ae5e Unlock Psych dependency (#9135)
Merge pull request 9135
2022-09-29 00:16:32 -07:00
jekyllbot
1baded9acd Update history to reflect merge of #9134 [ci skip] 2022-09-28 03:54:48 -07:00
Ashwin Maroli
1a3d85a8a5 Relax version constraint to allow Rouge 4.x (#9134)
Merge pull request 9134
2022-09-28 03:54:46 -07:00
Ashwin Maroli
b632afd2db Add version badge to documentation header 2022-09-25 20:42:58 +05:30
Ashwin Maroli
d09c5105d7 Document keys of the theme drop
Follow-up to #9129
2022-09-25 20:23:04 +05:30
jekyllbot
6633fd2335 Update history to reflect merge of #9129 [ci skip] 2022-09-24 06:54:57 -07:00
Ashwin Maroli
b8cf7cf96d Introduce theme drop to expose theme details (#9129)
Merge pull request 9129
2022-09-24 06:54:56 -07:00
jekyllbot
5b64b27b2c Update history to reflect merge of #9111 [ci skip] 2022-09-23 10:27:23 -07:00
Josh Soref
d1e392f301 Use check-spelling/check-spelling@v0.0.20 (#9111)
Merge pull request 9111
2022-09-23 10:27:21 -07:00
jekyllbot
7d9b6403c0 Update history to reflect merge of #9125 [ci skip] 2022-09-21 10:25:51 -07:00
Ashwin Maroli
911e249d72 Bump RuboCop to 1.36.x (#9125)
Merge pull request 9125
2022-09-21 10:25:50 -07:00
jekyllbot
d2c7c43c3f Update history to reflect merge of #9093 [ci skip] 2022-08-01 07:21:36 -07:00
Nemo
7a698d4d14 Bump rubocop to 1.32 (#9093)
Merge pull request 9093
2022-08-01 07:21:34 -07:00
jekyllbot
a03e972378 Update history to reflect merge of #9086 [ci skip] 2022-07-13 16:45:38 -07:00
Andrii Abramov
18e5e5223b Update ruby version for macos guide (#9086)
Merge pull request 9086
2022-07-13 16:45:36 -07:00
jekyllbot
3d23171d22 Update history to reflect merge of #9064 [ci skip] 2022-06-20 20:35:43 -07:00
Andreas Deininger
a0c6b4c595 Improve links (http -> https) (#9064)
Merge pull request 9064
2022-06-20 20:35:42 -07:00
jekyllbot
66dd820648 Update history to reflect merge of #9049 [ci skip] 2022-06-20 12:19:38 -07:00
Kirstin Heidler
25369429a7 Windows: describe which option to choose (#9049)
Merge pull request 9049
2022-06-20 12:19:37 -07:00
Ashwin Maroli
8896e125ef Bump RuboCop to v1.30.x 2022-05-26 15:11:58 +05:30
jekyllbot
4537ccac41 Update history to reflect merge of #9057 [ci skip] 2022-05-16 06:51:32 -07:00
Takuya N
674bcfb37e Remove Ionic Framework site from showcase (#9057)
Merge pull request 9057
2022-05-16 06:51:30 -07:00
Ashwin Maroli
0f5f5ba8d1 Bump RuboCop to v1.29.x
Closes #9053
2022-05-09 11:30:27 +05:30
Ashwin Maroli
796ae15c31 Fix alignment of home page section-units on mobile 2022-05-05 16:46:09 +05:30
Ashwin Maroli
d70ffd2a20 Fix news-archive list renders on small-devices
Resolves #8839
2022-05-05 12:49:26 +05:30
jekyllbot
2c0e51330b Update history to reflect merge of #9045 [ci skip] 2022-04-28 05:14:23 -07:00
Andrew Gutekanst
ac93d22df1 Remove git.io shortlinks from repo (#9045)
Merge pull request 9045
2022-04-28 05:14:22 -07:00
jekyllbot
124ce72be8 Update history to reflect merge of #9039 [ci skip] 2022-04-27 23:57:35 -07:00
Ashwin Maroli
6077ed6a01 Remove misleading total row from --profile table (#9039)
Merge pull request 9039
2022-04-27 23:57:33 -07:00
Ashwin Maroli
7c28eb5f7e Bump RuboCop to v1.28.x 2022-04-21 20:20:49 +05:30
jekyllbot
c254533c3b Update history to reflect merge of #8995 [ci skip] 2022-04-08 07:22:30 -07:00
Emily Grace Seville
64dbf46a3b Add clarity to docs on permalinks placeholders and builtins (#8995)
Merge pull request 8995
2022-04-08 07:22:29 -07:00
Ashwin Maroli
1cde234d41 Bump RuboCop to v1.27.x 2022-04-08 18:59:55 +05:30
jekyllbot
b02b070d86 Update history to reflect merge of #8988 [ci skip] 2022-04-08 02:13:22 -07:00
Ashwin Maroli
3b3f845846 Ensure theme config is a Jekyll::Configuration object (#8988)
Merge pull request 8988
2022-04-08 02:13:21 -07:00
jekyllbot
0d0fd3f41b Update history to reflect merge of #8986 [ci skip] 2022-04-07 03:53:40 -07:00
dependabot[bot]
23a2451459 Bump actions/checkout from 2 to 3 (#8986)
Merge pull request 8986
2022-04-07 03:53:38 -07:00
jekyllbot
d1ecbcbff4 Update history to reflect merge of #8955 [ci skip] 2022-04-07 01:56:44 -07:00
Ashwin Maroli
e052d2090c Stop testing with Rubies older than 2.7 on non-Windows (#8955)
Merge pull request 8955
2022-04-07 01:56:42 -07:00
jekyllbot
354110d393 Update history to reflect merge of #9015 [ci skip] 2022-04-03 09:58:58 -07:00
Ashwin Maroli
9c7972dc38 Check symlink outside site_source without Pathutil (#9015)
Merge pull request 9015
2022-04-03 09:58:57 -07:00
jekyllbot
19868d5602 Update history to reflect merge of #9017 [ci skip] 2022-04-02 08:25:56 -07:00
Daryl Hepting
1d5bae583b Update permalinks.md (#9017)
Merge pull request 9017
2022-04-02 08:25:55 -07:00
jekyllbot
e7cc390d2b Update history to reflect merge of #8853 [ci skip] 2022-04-02 08:25:17 -07:00
JT
6f31b362eb Improve document about Github Actions section (#8853)
Merge pull request 8853
2022-04-02 08:25:16 -07:00
jekyllbot
e7ce73d593 Update history to reflect merge of #8858 [ci skip] 2022-04-01 06:42:03 -07:00
MichaelCordingley
66e337984e Allow Configurable Converters on CSV (#8858)
Merge pull request 8858
2022-04-01 06:42:01 -07:00
jekyllbot
d4e10d5954 Update history to reflect merge of #8363 [ci skip] 2022-04-01 06:35:26 -07:00
lm
2a0272cc38 Only enable BOM encoding option on UTF encodings (#8363)
Merge pull request 8363
2022-04-01 06:35:24 -07:00
jekyllbot
3c46d844cf Update history to reflect merge of #8761 [ci skip] 2022-04-01 06:24:57 -07:00
JJ
776748e13f Expose basename from document.rb as name to Liquid templates (#8761)
Merge pull request 8761
2022-04-01 06:24:55 -07:00
jekyllbot
310459370a Update history to reflect merge of #8993 [ci skip] 2022-03-28 20:46:22 -07:00
Moncef Belyamani
65158c2368 Simplify macOS installation docs (#8993)
Merge pull request 8993
2022-03-28 20:46:20 -07:00
jekyllbot
e695c1e24b Update history to reflect merge of #9013 [ci skip] 2022-03-27 13:28:30 -07:00
Parker Moore
c4387f69fc Add Jekyll 3.9.2 release post to 'master' branch (#9013)
Merge pull request 9013
2022-03-27 13:28:29 -07:00
jekyllbot
75df28c27a Update history to reflect merge of #8961 [ci skip] 2022-03-24 09:06:00 -07:00
Ashwin Maroli
9d86974e1f Expose collection static files via site.static_files (#8961)
Merge pull request 8961
2022-03-24 09:05:58 -07:00
jekyllbot
79869e7225 Update history to reflect merge of #9007 [ci skip] 2022-03-24 09:03:55 -07:00
lucafrance
b98db02f36 Remove Aerobatic (#9007)
Merge pull request 9007
2022-03-24 09:03:54 -07:00
jekyllbot
4194f62dd7 Update history to reflect merge of #9005 [ci skip] 2022-03-23 06:39:49 -07:00
jaybe@jekyll
1096648473 Update README.markdown re IRC Pointer (#9005)
Merge pull request 9005
2022-03-23 06:39:47 -07:00
jekyllbot
dd0c5fc3bc Update history to reflect merge of #8337 [ci skip] 2022-03-21 08:00:43 -07:00
Ashwin Maroli
94dc98cb6b Trigger livereload in sites without pages (#8337)
Merge pull request 8337
2022-03-21 08:00:41 -07:00
jekyllbot
e6d3d90b52 Update history to reflect merge of #8996 [ci skip] 2022-03-17 12:25:32 -07:00
Emily Grace Seville
6984a64932 Add quiet/verbose options (#8996)
Merge pull request 8996
2022-03-17 12:25:31 -07:00
jekyllbot
62ef1580ec Update history to reflect merge of #8997 [ci skip] 2022-03-14 04:02:43 -07:00
Nicholas Paxford
88cbd7a783 Update manual.md (#8997)
Merge pull request 8997
2022-03-14 04:02:41 -07:00
jekyllbot
de7da5f6c3 Update history to reflect merge of #8992 [ci skip] 2022-03-11 02:00:28 -08:00
Emily Grace Seville
f48d500586 Enhace option's case for Jekyll configuration (#8992)
Merge pull request 8992
2022-03-11 02:00:27 -08:00
jekyllbot
62d9c8c30c Update history to reflect merge of #8991 [ci skip] 2022-03-09 09:06:00 -08:00
Gary
06abe7fd0c Update document by fix yaml syntax error (#8991)
Merge pull request 8991
2022-03-09 09:05:58 -08:00
Ashwin Maroli
380c3fe815 Bump RuboCop to v1.26.x 2022-03-09 22:33:28 +05:30
jekyllbot
b7056373af Update history to reflect merge of #8984 [ci skip] 2022-03-04 08:06:29 -08:00
Ashwin Maroli
36cbca0ece Document releasing off *-stable branches (#8984)
Merge pull request 8984
2022-03-04 08:06:27 -08:00
Ashwin Maroli
0faa2a4c12 Release 💎 v4.2.2 2022-03-03 16:31:14 +05:30
jekyllbot
3d5bed24e2 Update history to reflect merge of #8982 [ci skip] 2022-03-03 02:51:16 -08:00
Ashwin Maroli
493ed1571e Release post for v4.2.2 (#8982)
Merge pull request 8982
2022-03-03 02:51:14 -08:00
jekyllbot
e27088555d Update history to reflect merge of #8965 [ci skip] 2022-02-25 13:12:25 -08:00
Ashwin Maroli
034d3e9f4b Fix response header for content served via jekyll serve (#8965)
Merge pull request 8965
2022-02-25 13:12:23 -08:00
jekyllbot
86907653ca Update history to reflect merge of #8960 [ci skip] 2022-02-09 19:29:03 -08:00
Ashwin Maroli
88044a2ece Fix deprecation message for missing doc method (#8960)
Merge pull request 8960
2022-02-09 19:29:01 -08:00
jekyllbot
d46bef774a Update history to reflect merge of #8946 [ci skip] 2022-01-31 11:19:07 -05:00
Tyler887
c644d9a568 Hakiri sunsetting down (#8946)
Merge pull request 8946
2022-01-31 11:19:04 -05:00
jekyllbot
92c6dc6578 Update history to reflect merge of #8951 [ci skip] 2022-01-31 10:21:45 -05:00
Robert Martin
285f79306b Update bug_report.yml (#8951)
Merge pull request 8951
2022-01-31 10:21:44 -05:00
Ashwin Maroli
a3290166dc Improve note on use of actions/cache [skip ci] 2022-01-28 15:06:02 +05:30
jekyllbot
5dcfc22cba Update history to reflect merge of #8948 [ci skip] 2022-01-28 04:22:01 -05:00
Attaphong Rattanaveerachanon
e133183f6f Update document for github-actions workflow by adding cache step. (#8948)
Merge pull request 8948
2022-01-28 04:22:00 -05:00
jekyllbot
1306cd7be9 Update history to reflect merge of #8940 [ci skip] 2022-01-20 21:50:50 -05:00
Parker Moore
07cd645ce6 Run vendor-mimes to update mime.types (#8940)
Merge pull request 8940
2022-01-20 21:50:49 -05:00
Ashwin Maroli
4ec6902cdb Bump RuboCop to v1.25.x
Closes #8941
2022-01-19 15:39:09 +05:30
jekyllbot
9fac4c6ec7 Update history to reflect merge of #8934 [ci skip] 2022-01-14 10:30:06 -05:00
Korbs
8578d735bc Fix link for "CloudSh" (#8934)
Merge pull request 8934
2022-01-14 10:30:04 -05:00
jekyllbot
e3cbe584f2 Update history to reflect merge of #8928 [ci skip] 2022-01-08 10:42:33 -05:00
Ashwin Maroli
d4a4d951c5 Improve maintainers guide on releasing a new version (#8928)
Merge pull request 8928
2022-01-08 10:42:31 -05:00
Ashwin Maroli
7b7a286b4a Adjust line-length in doc on releasing versions [skip ci] 2022-01-07 11:26:29 +05:30
jekyllbot
ba07bb3648 Update history to reflect merge of #8921 [ci skip] 2022-01-06 10:16:02 -05:00
Ashwin Maroli
b0a68d56fc Rewrite documentation on installing plugins (#8921)
Merge pull request 8921
2022-01-06 10:16:00 -05:00
jekyllbot
1008f1b4e3 Update history to reflect merge of #8925 [ci skip] 2022-01-03 15:49:25 -05:00
Laurence Andrews
77282e45fd Update resources.md (#8925)
Merge pull request 8925
2022-01-03 15:49:23 -05:00
jekyllbot
df765950ba Update history to reflect merge of #8919 [ci skip] 2021-12-30 17:30:24 -05:00
Toshimaru
0107747606 Update REAMDE generated by jekyll new-theme (#8919)
Merge pull request 8919
2021-12-30 17:30:22 -05:00
jekyllbot
c34fa6181e Update history to reflect merge of #8918 [ci skip] 2021-12-30 11:02:00 -05:00
Ashwin Maroli
a7a7b7a815 Lock gem psych to v3.x (#8918)
Merge pull request 8918
2021-12-30 11:01:58 -05:00
Ashwin Maroli
d0eb07ba29 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 19:02:06 +05:30
Ashwin Maroli
07e510f964 Add Ruby 3.1 to CI Matrix 2021-12-29 18:02:53 +05:30
jekyllbot
0967c71097 Update history to reflect merge of #8915 [ci skip] 2021-12-27 13:06:35 -05:00
Rishi Raj Jain
5b0ea4b220 docs: add Layer0 deployment guide (#8915)
Merge pull request 8915
2021-12-27 13:06:34 -05:00
Ashwin Maroli
66b399c6d3 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 23:27:01 +05:30
Ashwin Maroli
659683dbb2 Bump RuboCop to v1.24.x 2021-12-23 17:27:06 +05:30
jekyllbot
1ac5386820 Update history to reflect merge of #8908 [ci skip] 2021-12-17 10:14:20 -05:00
Ashwin Maroli
e6928dab2e Manage repository meta documents consistently (#8908)
Merge pull request 8908
2021-12-17 10:14:19 -05:00
jekyllbot
30f795f5a7 Update history to reflect merge of #8823 [ci skip] 2021-12-16 09:17:38 -05:00
Parker Moore
5aeb2bfe4e Add Security Policy document (#8823)
Merge pull request 8823
2021-12-16 09:17:36 -05:00
jekyllbot
2abf1787ca Update history to reflect merge of #8907 [ci skip] 2021-12-16 08:54:56 -05:00
Maik Riechert
23af360ef0 Remove text on GITHUB_TOKEN which is now built-in (#8907)
Merge pull request 8907
2021-12-16 08:54:55 -05:00
Ashwin Maroli
23284eb6db Remove history entry for reverted unreleased change [skip ci] 2021-12-16 17:51:45 +05:30
jekyllbot
fafcc2ce4e Update history to reflect merge of #8880 [ci skip] 2021-12-08 06:35:44 -05:00
Phil Ross
9c9cf3e82b Support both tzinfo v1 and v2 alongwith non-half hour offsets. (#8880)
Merge pull request 8880
2021-12-08 06:35:42 -05:00
jekyllbot
956701f96c Update history to reflect merge of #8900 [ci skip] 2021-12-08 06:30:31 -05:00
Kantanat-Stamp
7fdae26c25 Linting README,markdown (#8900)
Merge pull request 8900
2021-12-08 06:30:29 -05:00
Ashwin Maroli
9fa340af65 Remove lock on Bundler version in CI
Bundler 2.2.33 has been released
2021-12-08 16:22:42 +05:30
Ashwin Maroli
1434644dcc 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-02 16:36:28 +05:30
Ashwin Maroli
a4a7e70fa1 Allow creating issues from a blank slate [skip ci] 2021-11-22 22:45:09 +05:30
jekyllbot
b8947f95b3 Update history to reflect merge of #8815 [ci skip] 2021-11-22 08:01:35 -05:00
Michael Gerzabek
a8ccdd6d2f Propagate _data folder from theme (#8815)
Merge pull request 8815
2021-11-22 08:01:33 -05:00
Ashwin Maroli
9a3122020e Upgrade Bug-report template to beta form template 2021-11-22 15:22:27 +05:30
Ashwin Maroli
bb49d93713 Stop assigning Frank to docs-related issues 2021-11-22 10:52:17 +05:30
Ashwin Maroli
f51ccbfad3 Bump RuboCop to v1.23.x 2021-11-17 19:52:51 +05:30
jekyllbot
44926fd14d Update history to reflect merge of #8884 [ci skip] 2021-11-17 04:48:05 -05:00
Phil Ross
3a688fe55a Fix random test failures in TestExcerpt #to_liquid. (#8884)
Merge pull request 8884
2021-11-17 04:48:03 -05:00
jekyllbot
d81cc40c9f Update history to reflect merge of #8877 [ci skip] 2021-11-12 11:16:14 -05:00
Ashwin Maroli
369c345107 Improve readability of CI logs (#8877)
Merge pull request 8877
2021-11-12 11:16:13 -05:00
jekyllbot
c90d083ef5 Update history to reflect merge of #8830 [ci skip] 2021-11-05 06:29:08 -04:00
Ashwin Maroli
db3f034f9e Add a workflow to build gems consistently (#8830)
Merge pull request 8830
2021-11-05 06:29:07 -04:00
Ashwin Maroli
10a73596d9 Add lang identifiers to shell based codeblocks 2021-10-28 12:29:31 +05:30
jekyllbot
7c619a7e2f Update history to reflect merge of #8857 [ci skip] 2021-10-28 01:04:29 -04:00
Ashwin Maroli
47b0abe1f0 Slightly update lang sh code-block styling (#8857)
Merge pull request 8857
2021-10-28 01:04:27 -04:00
jekyllbot
75b27ec328 Update history to reflect merge of #8852 [ci skip] 2021-10-23 14:15:33 -04:00
Meet Gor
868d9af3cb Added docs for running locally (#8852)
Merge pull request 8852
2021-10-23 14:15:32 -04:00
Ashwin Maroli
26a949df85 Add manual workflow to run benchmarks [skip ci] 2021-10-17 16:58:00 +05:30
Ashwin Maroli
e1838db156 Update spell-check workflow configuration 2021-10-10 12:55:55 +05:30
Ashwin Maroli
8af22d0852 Regenerate RuboCop TODO file 2021-10-06 17:58:22 +05:30
jekyllbot
d8b38f78b6 Update history to reflect merge of #8835 [ci skip] 2021-10-01 15:08:22 -04:00
Meg Gutshall
45fdf35cc3 Fix typo (#8835)
Merge pull request 8835
2021-10-01 15:08:21 -04:00
jekyllbot
ec8212ad74 Update history to reflect merge of #8831 [ci skip] 2021-09-30 11:22:54 -04:00
Matt Rogers
cfcc0c524e Relax Rubocop Dependency (#8831)
Merge pull request 8831
2021-09-30 11:22:51 -04:00
jekyllbot
8d324d9241 Update history to reflect merge of #8829 [ci skip] 2021-09-30 10:37:14 -04:00
Ricardo N Feliciano
32e97a7881 Update CircleCI example (#8829)
Merge pull request 8829
2021-09-30 10:37:13 -04:00
Ashwin Maroli
5687bf97d8 Release 💎 4.2.1 2021-09-27 16:52:08 +05:30
jekyllbot
0db36cec4b Update history to reflect merge of #8818 [ci skip] 2021-09-27 07:06:32 -04:00
Ashwin Maroli
5cc308825e Release post for v4.2.1 (#8818)
Merge pull request 8818
2021-09-27 07:06:30 -04:00
jekyllbot
1968e998a5 Update history to reflect merge of #8821 [ci skip] 2021-09-23 14:39:15 -04:00
Matt Rogers
a05b0d94cd Remove the warning about auto-regeneration on Windows (#8821)
Merge pull request 8821
2021-09-23 14:39:12 -04:00
jekyllbot
86d6b04a97 Update history to reflect merge of #8813 [ci skip] 2021-09-16 12:51:50 -04:00
Matt Rogers
70a6702a6a Move Frank to Emeritus Core Team Members (#8813)
Merge pull request 8813
2021-09-16 12:51:48 -04:00
jekyllbot
925442d91f Update history to reflect merge of #8812 [ci skip] 2021-09-16 12:48:55 -04:00
Matt Rogers
b27fb044e7 Remove AWS Amplify from the showcase (#8812)
Merge pull request 8812
2021-09-16 12:48:53 -04:00
jekyllbot
0ada71db18 Update history to reflect merge of #8798 [ci skip] 2021-09-16 12:24:44 -04:00
Ashwin Maroli
891a78685a Always hide cache-dir contents from Git (#8798)
Merge pull request 8798
2021-09-16 12:24:42 -04:00
jekyllbot
f0314eec56 Update history to reflect merge of #8797 [ci skip] 2021-09-16 11:19:56 -04:00
SaintMalik
00289460df Update feature_request.md (#8797)
Merge pull request 8797
2021-09-16 11:19:55 -04:00
jekyllbot
91c0e46a7b Update history to reflect merge of #8811 [ci skip] 2021-09-16 11:19:20 -04:00
Matt Rogers
9b2126a365 Prefer Libera. Remove Freenode (#8811)
Merge pull request 8811
2021-09-16 11:19:18 -04:00
jekyllbot
7fbd29496e Update history to reflect merge of #8803 [ci skip] 2021-09-16 11:09:23 -04:00
Atlas Cove
fe563b15bd Update index.html (#8803)
Merge pull request 8803
2021-09-16 11:09:22 -04:00
jekyllbot
60cb817c16 Update history to reflect merge of #8620 [ci skip] 2021-09-15 09:53:42 -04:00
Ben Keith
faef38b5db Revert #7253: "Don't reset site.url to localhost:4000 by default" (#8620)
Merge pull request 8620
2021-09-15 09:53:40 -04:00
jekyllbot
c238346ca2 Update history to reflect merge of #8807 [ci skip] 2021-09-14 15:32:00 -04:00
Matt Rogers
f831286557 Goodbye Frank. We'll miss you. 💔 (#8807)
Merge pull request 8807
2021-09-14 15:31:58 -04:00
Ashwin Maroli
1aea1580c1 Utilize previously allocated local variable
Follow-up to aa9a416
2021-08-30 14:33:21 +05:30
jekyllbot
e482574b84 Update history to reflect merge of #8777 [ci skip] 2021-08-29 07:15:13 -04:00
Qasim Qureshi
84c8252f11 Update troubleshooting.md (#8777)
Merge pull request 8777
2021-08-29 07:15:12 -04:00
jekyllbot
0b12fd26ae Update history to reflect merge of #8786 [ci skip] 2021-08-29 03:22:43 -04:00
Ashwin Maroli
eca450454f Fix regression in Convertible module from v4.2.0 (#8786)
Merge pull request 8786
2021-08-29 03:22:42 -04:00
Nahin Khan
493b800edb Remove trailing whitespace in _config.yml template (#8774) 2021-08-20 11:18:32 +05:30
Ashwin Maroli
2568aea6ea Fix RuboCop offenses in tests 2021-08-18 15:21:08 +05:30
jekyllbot
dc5e39fad9 Update history to reflect merge of #8623 [ci skip] 2021-08-09 08:31:11 -04:00
Sampath Sukesh Ravolaparthi
ddbc8263de Tags:Highlight: Decomposed HTMLLegacy formatter (#8623)
Merge pull request 8623
2021-08-09 08:31:09 -04:00
jekyllbot
ca2f106c8f Update history to reflect merge of #8756 [ci skip] 2021-08-05 11:10:03 -04:00
Ashwin Maroli
aa9a4164d0 Respect collections_dir config within include tag (#8756)
Merge pull request 8756
2021-08-05 11:10:01 -04:00
jekyllbot
55b6972ea7 Update history to reflect merge of #8693 [ci skip] 2021-07-23 10:47:06 -04:00
Jeff Wilcox
9c7015138b Fixing URL in MacOS install for rbenv-doctor (#8693)
Merge pull request 8693
2021-07-23 10:47:05 -04:00
jekyllbot
9587a73c53 Update history to reflect merge of #8293 [ci skip] 2021-07-23 10:45:35 -04:00
Alex Malaszkiewicz
94fcfdd787 Enable Rubocop accessor grouping, fix existing offenses (#8293)
Merge pull request 8293
2021-07-23 10:45:34 -04:00
jekyllbot
fcd56a5680 Update history to reflect merge of #8718 [ci skip] 2021-07-23 10:42:17 -04:00
Aram Akhavan
9bb98edb29 use location.protocol to inject the livereload script instead of forcing http (#8718)
Merge pull request 8718
2021-07-23 10:42:15 -04:00
jekyllbot
0ce9a7c179 Update history to reflect merge of #8741 [ci skip] 2021-07-22 13:58:42 -04:00
Andrew Davis
3f46f02108 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 13:58:40 -04:00
jekyllbot
beca094841 Update history to reflect merge of #8684 [ci skip] 2021-07-22 13:57:52 -04:00
Mike Kasberg
0eb9239151 Improve GitHub Flavored Markdown Docs (#8684)
Merge pull request 8684
2021-07-22 13:57:51 -04:00
jekyllbot
5a441c24e2 Update history to reflect merge of #8740 [ci skip] 2021-07-22 13:53:16 -04:00
dependabot[bot]
b31f933cd1 Bump check-spelling/check-spelling from 0.0.18 to 0.0.19 (#8740)
Merge pull request 8740
2021-07-22 13:53:15 -04:00
jekyllbot
a0ed9550cd Update history to reflect merge of #8706 [ci skip] 2021-07-22 13:52:25 -04:00
jaybe@jekyll
37612632c5 IRC networks - Libera, Freenode (#8706)
Merge pull request 8706
2021-07-22 13:52:24 -04:00
jekyllbot
8926ae1aac Update history to reflect merge of #8701 [ci skip] 2021-07-22 13:49:56 -04:00
Parikshit87
8a6dd9e494 Update windows.md (#8701)
Merge pull request 8701
2021-07-22 13:49:55 -04:00
jekyllbot
915248ff18 Update history to reflect merge of #8727 [ci skip] 2021-07-22 13:46:13 -04:00
Miguel Brandão
bcaf878b65 Add 'webrick' warning note to "Quickstart" Docs (#8727)
Merge pull request 8727
2021-07-22 13:46:12 -04:00
jekyllbot
ea535a9ab7 Update history to reflect merge of #8425 [ci skip] 2021-07-22 13:43:49 -04:00
fauno
0dee66260f Optimize Jekyll::Utils.parse_date (#8425)
Merge pull request 8425
2021-07-22 13:43:47 -04:00
jekyllbot
76517175e7 Update history to reflect merge of #8681 [ci skip] 2021-05-18 03:34:15 -04:00
Mike Kasberg
b5e910acfb Improve the "Markdown Options" Docs (#8681)
Merge pull request 8681
2021-05-18 03:34:13 -04:00
jekyllbot
6ff7d680e0 Update history to reflect merge of #8680 [ci skip] 2021-05-18 02:31:36 -04:00
Frank Taillandier
42dacc1091 fix(security): CVE-2021-28834 (#8680)
Merge pull request 8680
2021-05-18 02:31:34 -04:00
Frank Taillandier
e5dd889750 Update expect.txt 2021-05-17 23:55:11 +02:00
Frank Taillandier
889fe4130b Update expect.txt 2021-05-16 22:13:21 +02:00
Frank Taillandier
7605b0a474 Update History.markdown 2021-05-16 22:12:49 +02:00
jekyllbot
e724b587e3 Update history to reflect merge of #8478 [ci skip] 2021-05-16 16:10:46 -04:00
Edson Jiménez
1ffda285d6 Add step to set SDKROOT (#8478)
Merge pull request 8478
2021-05-16 16:10:45 -04:00
jekyllbot
f267dafc0c Update history to reflect merge of #8471 [ci skip] 2021-05-16 16:09:24 -04:00
nusu
49a00ebbec Add formcarry to forms section (#8471)
Merge pull request 8471
2021-05-16 16:09:23 -04:00
jekyllbot
30b397c046 Update history to reflect merge of #8585 [ci skip] 2021-05-16 16:06:06 -04:00
Liam Bigelow
93ef9389ba Load Jekyll plugins from BUNDLE_GEMFILE location (#8585)
Merge pull request 8585
2021-05-16 16:06:05 -04:00
jekyllbot
6a6d735db2 Update history to reflect merge of #8676 [ci skip] 2021-05-16 16:00:55 -04:00
Kelvin M. Klann
7e350ac031 Revert "style: run rubocop -a" (#8676)
Merge pull request 8676
2021-05-16 16:00:53 -04:00
jekyllbot
0274943bcd Update history to reflect merge of #8677 [ci skip] 2021-05-16 15:58:45 -04:00
Josh Soref
92633c6996 Update expect to cover docs/_posts (#8677)
Merge pull request 8677
2021-05-16 15:58:44 -04:00
jekyllbot
02b12e5dfc Update history to reflect merge of #8675 [ci skip] 2021-05-16 08:14:48 -04:00
Josh Soref
bdad4f2b09 Spell check action for markdown documentation (#8675)
Merge pull request 8675
2021-05-16 08:14:47 -04:00
jekyllbot
f027b6e547 Update history to reflect merge of #7834 [ci skip] 2021-05-16 04:50:10 -04:00
Daniel Haim
e23b85f837 Improvements to CSS (#7834)
Merge pull request 7834
2021-05-16 04:50:09 -04:00
jekyllbot
8a0f7f2908 Update history to reflect merge of #8614 [ci skip] 2021-05-16 04:43:24 -04:00
Sesh Sadasivam
56ef270e27 Use official Ruby setup GH action (#8614)
Merge pull request 8614
2021-05-16 04:43:23 -04:00
Alaz Tetik
43d0ef3fa0 Correct a typo for word (#8674) 2021-05-16 10:41:41 +02:00
jekyllbot
fa0e0eba3e Update history to reflect merge of #8587 [ci skip] 2021-05-14 16:39:14 -04:00
Sesh Sadasivam
9ed85a028a Add documentation for Sass configuration options (#8587)
Merge pull request 8587
2021-05-14 16:39:12 -04:00
jekyllbot
2a4d9dfedf Update history to reflect merge of #8652 [ci skip] 2021-05-14 16:33:43 -04:00
alena-ko
3259064723 Update third-party.md (#8652)
Merge pull request 8652
2021-05-14 16:33:41 -04:00
jekyllbot
f32b8bedff Update history to reflect merge of #8624 [ci skip] 2021-05-14 16:31:08 -04:00
Ben Keith
579d0d9ffc Specify default port and host for serve commands (#8624)
Merge pull request 8624
2021-05-14 16:31:07 -04:00
jekyllbot
e91e9a3576 Update history to reflect merge of #8656 [ci skip] 2021-05-14 16:30:18 -04:00
Shyam Mohan K
d5a46fcd31 razorops cicd added (#8656)
Merge pull request 8656
2021-05-14 16:30:15 -04:00
jekyllbot
e2b1bc678e Update history to reflect merge of #8654 [ci skip] 2021-05-14 15:54:31 -04:00
Kelvin M. Klann
5d35cf217b style: run rubocop -a (#8654)
Merge pull request 8654
2021-05-14 15:54:30 -04:00
Frank Taillandier
827bfcff58 chore(styles): align hash 2021-05-14 21:52:16 +02:00
jekyllbot
b9b4d85fb1 Update history to reflect merge of #8646 [ci skip] 2021-05-14 15:37:45 -04:00
Kelvin M. Klann
d85c89e8b4 docs: clarify where .jekyll-metadata comes from (#8646)
Merge pull request 8646
2021-05-14 15:37:43 -04:00
Jonathan Darrer
813da60a53 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 21:27:47 +02:00
jekyllbot
f9e14a5704 Update history to reflect merge of #8648 [ci skip] 2021-05-14 15:24:57 -04:00
Kelvin M. Klann
2e65d6d3a9 docs: add overview of .jekyll-cache dir (#8648)
Merge pull request 8648
2021-05-14 15:24:55 -04:00
jekyllbot
60e01d3671 Update history to reflect merge of #8651 [ci skip] 2021-05-14 15:19:19 -04:00
Kelvin M. Klann
15ad8f4bdd fix: pin rubocop to 1.12 due to error with ruby 2.4 (#8651)
Merge pull request 8651
2021-05-14 15:19:17 -04:00
Josh Soref
4fbbefeb7e 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 21:18:13 +02:00
Vinhas Kevin
3fea30c862 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 21:16:57 +02:00
shorty
da68570406 Update filters.md (#8655)
Provide people an on-ramp to creating custom Liquid template filters in the docs.
2021-05-14 21:12:12 +02:00
Nick Coish
8940ad65b1 Fix typo in 02-liquid.md (#8637) 2021-05-14 21:11:29 +02:00
Chris Keefe
47a17e2cab ruby-devel required for OpenSuse (#8640)
Initially raised in https://github.com/jekyll/jekyll/issues/8118, this patches the installation requirements
2021-05-14 21:10:20 +02:00
Jesse van der Pluijm
c523f041fc 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 21:05:40 +02:00
Daniel Kehoe
62ba3c03b7 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 20:58:42 +02:00
Ikko Ashimine
e53fd19bc3 Fix typo in contributing.md (#8666)
specfic -> specific
2021-05-14 20:57:55 +02:00
jaybe@jekyll
af5bb813aa Update community.md and fix up IRC reference link (#8672) 2021-05-14 20:57:21 +02:00
dependabot[bot]
73637a41b1 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 20:53:30 +02:00
Parker Moore
6855200ebd Merge pull request #8635 from jekyll/add-3-9-1-stuff 2021-04-08 11:53:04 -04:00
Parker Moore
eb88a791e1 Add Jekyll 3.9.1 info to the docs website 2021-04-08 10:56:11 -04:00
jekyllbot
c7ccec20c4 Update history to reflect merge of #8560 [ci skip] 2021-03-29 08:56:08 -04:00
David Zhang
63ce7d66bf docs: troubleshoot macOS with ARM64 architecture (#8560)
Merge pull request 8560
2021-03-29 08:56:06 -04:00
jekyllbot
f5a137d3c6 Update history to reflect merge of #8579 [ci skip] 2021-03-27 12:27:00 -04:00
Jonathan Darrer
91c0f2a08d Use latest Jekyll-action configuration (#8579)
Merge pull request 8579
2021-03-27 12:26:59 -04:00
jekyllbot
dfc65090ea Update history to reflect merge of #8496 [ci skip] 2021-03-27 12:25:31 -04:00
Moncef Belyamani
b828ffd559 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 12:25:29 -04:00
Eric Cousineau
2aa33c8043 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 17:08:47 +01:00
jekyllbot
fdbb03b258 Update history to reflect merge of #8618 [ci skip] 2021-03-27 11:36:13 -04:00
Parker Moore
5d01099e22 Update include tag to be more permissive (#8618)
Merge pull request 8618
2021-03-27 11:36:12 -04:00
Frank Taillandier
6c170f11af styles: Rubocop 1.12 2021-03-27 16:29:18 +01:00
Otto Urpelainen
734cf2324e 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 15:12:50 +01:00
Robert Martin
5e7172c9ab Update macOS install docs for Big Sur (#8595)
Co-authored-by: Frank Taillandier <frank.taillandier@gmail.com>
2021-03-26 15:11:17 +01:00
Robert Martin
d25db24065 Update current Ruby version to 3.0.0 (#8596) 2021-03-26 15:09:17 +01:00
David Bruant
17beafeca7 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 15:07:15 +01:00
jekyllbot
69e9705512 Update history to reflect merge of #8610 [ci skip] 2021-03-25 20:47:15 -04:00
Adam Bell
df24131349 Cross Version Testing Locally and Faster CI (#8610)
Merge pull request 8610
2021-03-25 20:47:13 -04:00
Frank Taillandier
c9c9dc7dac chore(deps): rubocop 1.10
fix #8583
2021-02-19 09:26:10 +01:00
jekyllbot
a988f9da14 Update history to reflect merge of #8572 [ci skip] 2021-02-05 00:24:03 -05:00
SNVMK
32d9320d34 Update 3-to-4.md (#8572)
Merge pull request 8572
2021-02-05 00:24:01 -05:00
jekyllbot
f1bfbf7d19 Update history to reflect merge of #8567 [ci skip] 2021-02-01 05:54:53 -05:00
Frank Taillandier
fe64d9841b style: add rubocop 1.9 cops (#8567)
Merge pull request 8567
2021-02-01 05:54:51 -05:00
jekyllbot
5a64aefcea Update history to reflect merge of #8564 [ci skip] 2021-01-31 11:21:19 -05:00
Tejas Bubane
d460fae31a Pin rubocop version (#8564)
Merge pull request 8564
2021-01-31 11:21:17 -05:00
Frank Taillandier
e0e856f216 chore: check-html-links 2021-01-30 23:23:54 +01:00
jekyllbot
872132e725 Update history to reflect merge of #8399 [ci skip] 2021-01-19 03:56:12 -05:00
Shannon Kularathna
d46897fabf Step By Step Instructions Review (#8399)
Merge pull request 8399
2021-01-19 03:56:09 -05:00
jekyllbot
4f0dbdb9e8 Update history to reflect merge of #8543 [ci skip] 2021-01-13 02:31:34 -05:00
dependabot[bot]
6dcd470f3d Update actions/cache requirement to v2.1.3 (#8543)
Merge pull request 8543
2021-01-13 02:31:32 -05:00
jekyllbot
2313c4d748 Update history to reflect merge of #8542 [ci skip] 2021-01-13 02:30:51 -05:00
Alex Saveau
cbf656877e Regenerate supported mime types (#8542)
Merge pull request 8542
2021-01-13 02:30:49 -05:00
jekyllbot
50a47e34c2 Update history to reflect merge of #8540 [ci skip] 2021-01-12 18:50:22 -05:00
John Losito
c4055cd3d6 Allow dependabot to keep github actions up-to-date (#8540)
Merge pull request 8540
2021-01-12 18:50:20 -05:00
jekyllbot
a80b131819 Update history to reflect merge of #8533 [ci skip] 2021-01-12 18:44:30 -05:00
Ben Whetton
13152e1247 Remove GitHub Pages content which is in GitHub docs (#8533)
Merge pull request 8533
2021-01-12 18:44:28 -05:00
jekyllbot
e9d7934156 Update history to reflect merge of #8538 [ci skip] 2021-01-12 18:39:43 -05:00
Frank Taillandier
8c8326e9ab style: enable new cops (#8538)
Merge pull request 8538
2021-01-12 18:39:41 -05:00
jekyllbot
1e34cbaee6 Update history to reflect merge of #8524 [ci skip] 2021-01-10 16:25:31 -05:00
Clayton Smith
5c797ba136 Add webrick as a dependency (#8524)
Merge pull request 8524
2021-01-10 16:25:28 -05:00
Frank Taillandier
31e152b0d0 docs: update guide
- use latest versions
- link to https://github.com/limjh16/jekyll-action-ts
2021-01-07 16:17:23 +01:00
jekyllbot
03712b0188 Update history to reflect merge of #8529 [ci skip] 2021-01-03 04:53:02 -05:00
Phil Kirlin
d78fc653a6 Fix i.e. typos in collections.md (#8529)
Merge pull request 8529
2021-01-03 04:53:00 -05:00
jekyllbot
5e141b1e5e Update history to reflect merge of #8532 [ci skip] 2021-01-03 04:51:33 -05:00
Jeffrey Veen
e4031b21c9 Fixes typo in layouts_dir documentation (#8532)
Merge pull request 8532
2021-01-03 04:51:31 -05:00
jekyllbot
ed952e1ca0 Update history to reflect merge of #8527 [ci skip] 2021-01-01 11:29:28 -05:00
Ashwin Maroli
319cc95254 Improve documentation on developing generators (#8527)
Merge pull request 8527
2021-01-01 11:29:26 -05:00
jekyllbot
fc76919c69 Update history to reflect merge of #8525 [ci skip] 2021-01-01 11:19:10 -05:00
Ashwin Maroli
75a895c95d Add a disclaimer to tutorials involving Ruby code (#8525)
Merge pull request 8525
2021-01-01 11:19:08 -05:00
Ashwin Maroli
92e50227bd 2020/12/31 is no longer a future date 2020-12-31 23:40:23 +05:30
jekyllbot
17a9efa376 Update history to reflect merge of #8488 [ci skip] 2020-12-31 12:34:47 -05:00
Craig H Maynard
d1173c9d06 Document support for TSV files consistently (#8488)
Merge pull request 8488
2020-12-31 12:34:45 -05:00
jekyllbot
deb1a712b4 Update history to reflect merge of #8518 [ci skip] 2020-12-31 12:32:41 -05:00
Curious Cat
52fd9451b6 typo - do instead of don't (#8518)
Merge pull request 8518
2020-12-31 12:32:39 -05:00
Ashwin Maroli
ca03e7ab8f Jekyll 4 can be run on Ruby 2.4 2020-12-16 20:06:13 +05:30
Frank Taillandier
871a05a9a4 Release 💎 4.2.0 2020-12-14 13:31:52 +01:00
Frank Taillandier
98d06862ee Release: Jekyll 4.2.0 (#8466)
* chore(release): 4.2.0 💎

Co-authored-by: Ashwin Maroli <ashmaroli@gmail.com>
2020-12-14 13:30:45 +01:00
Ashwin Maroli
1e2d72a574 Remove redundant quotes around YAML value 2020-12-11 19:53:44 +05:30
Frank Taillandier
0d7665c517 docs: new homebrew script [skip ci] 2020-12-11 00:27:54 +01:00
Ashwin Maroli
3ca9d6e891 Format History entries for changes on HEAD 2020-12-10 20:25:16 +05:30
jekyllbot
c571b3bd5a Update history to reflect merge of #8497 [ci skip] 2020-12-10 09:00:26 -05:00
Ashwin Maroli
01825f51db Stash attribute hash for Liquid computed for pages (#8497)
Merge pull request 8497
2020-12-10 09:00:23 -05:00
Ashwin Maroli
c70437e2de Correct offenses reported by RuboCop 1.6.0 2020-12-09 23:07:40 +05:30
Ashwin Maroli
84deb286ed Improve maintainability of showcase data and page 2020-12-09 22:25:46 +05:30
jekyllbot
d268e356f8 Update history to reflect merge of #8504 [ci skip] 2020-12-06 17:55:14 -05:00
Frank Taillandier
46cb37f479 fix: showcase (#8504)
Merge pull request 8504
2020-12-06 17:55:12 -05:00
jekyllbot
716fc3627c Update history to reflect merge of #8492 [ci skip] 2020-12-04 13:38:48 -05:00
Ashwin Maroli
91aed9ff8b Migrate TravisCI jobs to GitHub Actions (#8492)
Merge pull request 8492
2020-12-04 13:38:46 -05:00
Toby Glei
c4d493072d 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 11:47:26 +01:00
Frank Taillandier
f4a7eee57a docs: shell-based instructions
Fix #8483
2020-12-04 11:17:01 +01:00
Frank Taillandier
2f1ba8e7be docs: Shell-based instructions
Fix #8483
2020-12-04 11:07:07 +01:00
jekyllbot
9a6d3ea51e Update history to reflect merge of #8489 [ci skip] 2020-12-02 12:27:35 -05:00
Ashwin Maroli
c80ccbebf7 Optimize Page#dir with a private method (#8489)
Merge pull request 8489
2020-12-02 12:27:33 -05:00
Jacobo Vidal
686165af12 Add Arengu to form services list documentation (#8414)
* Add Arengu to form services list
2020-12-02 14:12:52 +01:00
Ashwin Maroli
371298f69b Compute hash of Gemfile.lock in workflow 2020-12-02 12:10:27 +05:30
jekyllbot
df09c414d8 Update history to reflect merge of #8485 [ci skip] 2020-12-02 00:56:54 -05:00
Ashwin Maroli
573b431abb Reduce allocations from computing item property (#8485)
Merge pull request 8485
2020-12-02 00:56:51 -05:00
Dan Nemenyi
68497a4d4b 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 14:57:05 +01:00
Frank Taillandier
6132653d5a docs: Homebrew bash script
Fix ##8490
2020-12-01 14:55:11 +01:00
Ashwin Maroli
9084f9f752 Configure new cops 2020-11-30 22:30:48 +05:30
jekyllbot
1ebde7c4cb Update history to reflect merge of #8486 [ci skip] 2020-11-29 14:21:11 -05:00
Adam Alton
568f4c5b76 structure.md: add link to Assets page from _sass section (#8486)
Merge pull request 8486
2020-11-29 14:21:09 -05:00
Ashwin Maroli
97db005336 Remove version constraint on gem tomlrb
This gem is required by the test-suite
2020-11-27 14:13:02 +05:30
jekyllbot
74c3055952 Update history to reflect merge of #8481 [ci skip] 2020-11-26 13:21:52 -05:00
Ashwin Maroli
58368cdacc Debug reading data files in a site (#8481)
Merge pull request 8481
2020-11-26 13:21:50 -05:00
Frank Taillandier
d8d1feec71 style: auo-gen-exclude 2020-11-23 16:58:18 +01:00
Frank Taillandier
8559fbfbe8 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 16:53:10 +01:00
Frank Taillandier
d560d53266 style: fix rubocop 1.40 offense 2020-11-23 16:46:50 +01:00
jekyllbot
3e3d9bce64 Update history to reflect merge of #8473 [ci skip] 2020-11-18 05:43:41 -05:00
Ashwin Maroli
a7e1ec901b Add custom debug strings for Jekyll objects (#8473)
Merge pull request 8473
2020-11-18 05:43:38 -05:00
jekyllbot
8a01e6aed9 Update history to reflect merge of #8472 [ci skip] 2020-11-18 05:42:10 -05:00
Ashwin Maroli
37df92dd29 Explicitly return nil after site process phase (#8472)
Merge pull request 8472
2020-11-18 05:42:08 -05:00
Ashwin Maroli
430167b9b9 Do not exclude CNAME from site build 2020-11-12 12:32:11 +05:30
Ashwin Maroli
ed7a4857a5 chore: rake site:generate 2020-11-12 12:18:43 +05:30
Frank Taillandier
6f8ca8c764 chore: cleanup 4.1.1 changelog 2020-11-11 21:24:44 +01:00
1049 changed files with 65244 additions and 101581 deletions

53
.codeclimate.yml Normal file
View File

@@ -0,0 +1,53 @@
version: "2"
checks:
argument-count:
enabled: true
config:
threshold: 5
file-lines:
enabled: true
config:
threshold: 300
method-complexity:
enabled: true
config:
threshold: 15
method-count:
enabled: true
config:
threshold: 50
method-lines:
enabled: true
config:
threshold: 30
plugins:
fixme:
enabled: false
rubocop:
enabled: true
channel: rubocop-0-60
exclude_patterns:
- "*.*"
- ".*"
- Gemfile
- LICENSE
- Rakefile
- benchmark/
- docs/
- exe/
- features/
- rake/
- rubocop/
- script/
- spec/
- test/
- vendor/
- lib/blank_template/
- lib/site_template/
- lib/theme_template/
- lib/jekyll/mime.types
- lib/jekyll/commands/serve/livereload_assets/livereload.js

55
.devcontainer/Dockerfile Normal file
View File

@@ -0,0 +1,55 @@
#-------------------------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
#-------------------------------------------------------------------------------------------------------------
FROM ruby:3.0
# Avoid warnings by switching to noninteractive
ENV DEBIAN_FRONTEND=noninteractive
# This Dockerfile adds a non-root user with sudo access. Use the "remoteUser"
# property in devcontainer.json to use it. On Linux, the container user's GID/UIDs
# will be updated to match your local UID/GID (when using the dockerFile property).
# See https://aka.ms/vscode-remote/containers/non-root-user for details.
ARG USERNAME=vscode
ARG USER_UID=1000
ARG USER_GID=$USER_UID
# Configure apt and install packages
RUN apt-get update \
&& apt-get -y install --no-install-recommends apt-utils dialog locales 2>&1 \
# Verify git, process tools installed
&& apt-get -y install git openssh-client iproute2 procps lsb-release \
#
# Install ruby-debug-ide and debase
&& gem install ruby-debug-ide \
&& gem install debase \
#
# Install node.js
&& apt-get -y install curl software-properties-common \
&& curl -sL https://deb.nodesource.com/setup_18.x | bash - \
&& apt-get -y install nodejs \
#
# Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user.
&& groupadd --gid $USER_GID $USERNAME \
&& useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \
# [Optional] Add sudo support for the non-root user
&& apt-get install -y sudo \
&& echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\
&& chmod 0440 /etc/sudoers.d/$USERNAME \
#
# Clean up
&& apt-get autoremove -y \
&& apt-get clean -y \
&& rm -rf /var/lib/apt/lists/*
# Set the locale
RUN sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
dpkg-reconfigure --frontend=noninteractive locales && \
update-locale LANG=en_US.UTF-8
ENV LANG en_US.UTF-8
# Switch back to dialog for any ad-hoc use of apt-get
ENV DEBIAN_FRONTEND=dialog

View File

@@ -0,0 +1,26 @@
// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.101.1/containers/ruby-2
{
"name": "Ruby 3",
"dockerFile": "Dockerfile",
// Set *default* container specific settings.json values on container create.
"settings": {
"terminal.integrated.shell.linux": "/bin/bash"
},
// Add the IDs of extensions you want installed when the container is created.
"extensions": [
"rebornix.Ruby"
],
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "bundle install"
// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
// "remoteUser": "vscode"
}

14
.editorconfig Normal file
View File

@@ -0,0 +1,14 @@
# 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

1
.gitattributes vendored Normal file
View File

@@ -0,0 +1 @@
* text=auto

84
.github/CODEOWNERS vendored Normal file
View File

@@ -0,0 +1,84 @@
# 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
/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

76
.github/CODE_OF_CONDUCT.markdown vendored Normal file
View File

@@ -0,0 +1,76 @@
# Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [olivia@jekyllrb.com](mailto:olivia@jekyllrb.com). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

158
.github/CONTRIBUTING.markdown vendored Normal file
View File

@@ -0,0 +1,158 @@
# 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 workaround? 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.
- 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
Interested 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)
- Previously, we've used the WIP Probot app to help contributors determine whether their pull request is ready for review. Please use a [draft pull request](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests) instead. When you're ready, [mark the pull request as ready for review](https://help.github.com/en/articles/changing-the-stage-of-a-pull-request)
## 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.
## Visual Studio Code Development Container
If you've got [Visual Studio Code](https://code.visualstudio.com/) with the [Remote Development Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) installed then simply opening this repository in Visual Studio Code and following the prompts to "Re-open In A Development Container" will get you setup and ready to go with a fresh environment with all the requirements installed.
## 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!

5
.github/FUNDING.yml vendored Normal file
View File

@@ -0,0 +1,5 @@
# These are supported funding model platforms
# github: jekyll
open_collective: jekyll
tidelift: rubygems/jekyll

104
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,104 @@
name: Bug Report
description: "Is something not working as expected?"
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Hi! Thank you for taking the time to report a bug with Jekyll.
Please consider asking your question at https://talk.jekyllrb.com if one or more of the following is applicable to your situation:
- You are not sure if the issue is a bug in Jekyll.
- The issue is caused by a third-party plugin.
- This is just a generic usage question.
Additionally, please note that this platform is meant for bugs in Jekyll core only.
Issues regarding dependencies and plugins should be reported in their respective repositories.
- type: input
id: os
attributes:
label: Operating System
description: The operating system of your computer.
placeholder: "Ubuntu 21.10"
validations:
required: true
- type: input
id: ruby-version
attributes:
label: Ruby Version
description: |
The Ruby version you were using at the time.
Run `ruby -v` in your terminal and paste the output in the input field.
placeholder: "ruby 2.7.3p183 (2021-04-05 revision 6847ee089d) [x64-mingw32]"
validations:
required: true
- type: input
id: jekyll-version
attributes:
label: Jekyll Version
description: |
The version of Jekyll used in your project.
Run `bundle exec jekyll -v` and paste the output in the input field.
*If you are not using a Gemfile, run `jekyll -v` instead.*
placeholder: "jekyll 4.2.1"
validations:
required: true
- type: input
id: ghp-version
attributes:
label: GitHub Pages Version
description: |
Are you deploying your site using GitHub Pages?
If yes, then we need to know the `github-pages` version used by your project. Proceed ahead otherwise.
If you're using the `github-pages` gem in your Gemfile, paste the output from running the following:
```
bundle exec github-pages -v
```
Otherwise, enter `Latest` in the input field and proceed ahead.
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: Briefly describe what you expected to see or get with a certain functionality.
placeholder: |
I expected my site to be built successfully when I run the following:
```
bundle exec jekyll build
```
validations:
required: true
- type: textarea
id: actual
attributes:
label: Current Behavior
description: >
Describe the details of the bug.
Be sure to include any steps you took for the problem to exist, such as the directories
you created and the full command you ran.
Include any plugins you have configured for use in the site.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: |
Please copy and paste any relevant log output from your terminal.
*Note: This will be automatically formatted into code, so no need for backticks.*
render: shell
- type: textarea
id: sample
attributes:
label: Code Sample
description: >
The easiest way for someone to understand an issue is if they could reproduce your issue
in their environment. Therefore, please provide a link to your project repository alongwith
instructions to reproduce your issue. If your project is not publicly accessible, please
consider setting up a minimal test repository complete with necessary instructions.
placeholder: |
### Steps to reproduce issue
- Clone [my repo](https://github.com/owner/repo)
- Install site dependencies
- Run `bundle exec jekyll build -s src -d src/dist`

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Jekyll Community Forum
url: https://talk.jekyllrb.com/
about: Please ask and answer questions here.

24
.github/ISSUE_TEMPLATE/documentation.md vendored Normal file
View File

@@ -0,0 +1,24 @@
---
name: Documentation
about: Found a typo or something that isn't crystal clear in our docs?
title: '[Docs]: '
labels: documentation
assignees: ''
---
<!-- Thanks for taking the time to open an issue and help us make Jekyll better! -->
## Motivation
<!-- Why should we update our docs? -->
## Suggestion
<!-- What should we do instead? -->
<!-- Thanks for taking the time to open an issue and help us make Jekyll better! -->

View File

@@ -0,0 +1,73 @@
---
name: Feature Request
about: Want us to add any features to Jekyll?
title: 'feat: '
labels: feature
assignees: ''
---
<!--
Hi! Thanks for considering to file a feature request with Jekyll. Please take the time to
answer the basic questions. Please try to be as detailed as possible.
Thanks!
-->
## Summary
<!--
A one-paragraph explanation of the feature.
-->
## Motivation
<!--
Why do you want to see this feature in Jekyll? What makes you sure that it should not be
implemented at the plugin level, but in Jekyll core? What use cases does it support?
NOTE: Please be mindful of the Jekyll philosophy (https://jekyllrb.com/philosophy/),
particularly Section 5. Think about if 90% of the users would benefit from your
feature request, and whether your feature would be better off in a plugin.
-->
## Guide-level explanation
<!--
Explain the proposal as if it was already included in the project and you
were teaching it to another programmer. That generally means:
- Introducing new named concepts.
- Explaining the feature largely in terms of examples.
- If applicable, provide sample error messages, deprecation warnings, or
migration guidance.
If this is a small feature, you may omit this section.
-->
## Reference-level explanation
<!--
This is the technical portion of the feature request. Explain the design in
sufficient detail that:
- Its interaction with other features is clear.
- It is reasonably clear how the feature would be implemented.
- Corner cases are dissected by example.
If you do not know how to answer this, you can omit it. No worries!
-->
## Drawbacks
<!--
Why should we *not* do this?
-->
## Unresolved Questions
<!--
What related issues do you consider out of scope for this feature that could be
addressed in the future independently of the solution that comes out of this
feature?
-->

46
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,46 @@
<!--
Thanks for creating a Pull Request! Before you submit, please make sure
you've done the following:
- I read the contributing document at https://jekyllrb.com/docs/contributing/
-->
<!--
Make our lives easier! Choose one of the following by uncommenting it:
-->
<!-- This is a 🐛 bug fix. -->
<!-- This is a 🙋 feature or enhancement. -->
<!-- This is a 🔦 documentation change. -->
<!-- This is a 🔨 code refactoring. -->
<!--
Before you submit this pull request, make sure to have a look at the following
checklist. If you don't know how to do some of these, that's fine! Submit
your pull request and we will help you out on the way.
- I've added tests (if it's a bug, feature or enhancement)
- I've adjusted the documentation (if it's a feature or enhancement)
- The test suite passes locally (run `script/cibuild` to verify this)
-->
## Summary
<!--
Provide a description of what your pull request changes.
-->
## Context
<!--
Is this related to any GitHub issue(s)?
You can use keywords to automatically close the related issue.
For example, (all of) the following will close issue #4567 when your PR is merged.
Closes #4567
Fixes #4567
Resolves #4567
Use any one of the above as applicable.
-->

32
.github/SECURITY.markdown vendored Normal file
View File

@@ -0,0 +1,32 @@
# Security Policy
## Supported Versions
Security updates are applied to the latest MINOR version of Jekyll, and the version used by GitHub Pages, v3.10.x.
| Version | Supported |
| ------- | ------------------ |
| 4.4.x | :white_check_mark: |
| 3.10.x | :white_check_mark: |
| < 3.10.x | :x: |
## Reporting a Vulnerability
Please report vulnerabilities by sending an email to security@jekyllrb.com with the following information:
1. A description of the vulnerability
2. Reproduction steps and/or a sample site (share a private repo to the [Jekyll Security Team](docs/pages/team.md))
3. Your contact information
The Jekyll security team will respond to your submission and notify you whether it has been confirmed by the team.
Your confidentiality is kindly requested as we work on a fix. We will provide our patch to you to test and verify that the vulnerability has
been closed.
If you have created a patch and would like to submit that to us as well, we will happily consider it though we cannot guarantee that we will
use it. If we use your patch, we will attribute authorship to you either as the commit author, or as a co-author.
Once a fix is verified, we will release PATCH versions of the supported MINOR versions and assign a CVE to the vulnerability. You will receive
credit in our release post.
Once the patched version has been released, we will no longer request you to maintain confidentiality and you may choose to share details on
how you found the vulnerability with the community.

20
.github/SUPPORT.markdown vendored Normal file
View File

@@ -0,0 +1,20 @@
# 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'!

17
.github/actions/spelling/README.md vendored Normal file
View File

@@ -0,0 +1,17 @@
# check-spelling/check-spelling configuration
File | Purpose | Format | Info
-|-|-|-
[dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary)
[allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)
[reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)
[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
[only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only)
[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns)
[line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
[expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)
[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
Note: you can replace any of these files with a directory by the same name (minus the suffix)
and then include multiple files inside that directory (with that suffix) to merge multiple files together.

25
.github/actions/spelling/advice.md vendored Normal file
View File

@@ -0,0 +1,25 @@
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
<details><summary>If the flagged items are :exploding_head: false positives</summary>
If items relate to a ...
* binary file (or some other file you wouldn't want to check at all).
Please add a file path to the `excludes.txt` file matching the containing file.
File paths are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
../tree/HEAD/README.md) (on whichever branch you're using).
* well-formed pattern.
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
try adding it to the `patterns.txt` file.
Patterns are Perl 5 Regular Expressions - you can [test](
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
Note that patterns can't match multiline strings.
</details>

19
.github/actions/spelling/allow.txt vendored Normal file
View File

@@ -0,0 +1,19 @@
azion
builtins
github
hakiri
https
Linting
Microsoft
ssh
Statictastic
statictastic
supranode
ubuntu
Wikipedia
workaround
workaround
workarounds
WSL
decapcms
tina

View File

@@ -0,0 +1,520 @@
# marker to ignore all code on line
^.*/\* #no-spell-check-line \*/.*$
# marker for ignoring a comment to the end of the line
// #no-spell-check.*$
# patch hunk comments
^\@\@ -\d+(?:,\d+|) \+\d+(?:,\d+|) \@\@ .*
# git index header
index [0-9a-z]{7,40}\.\.[0-9a-z]{7,40}
# cid urls
(['"])cid:.*?\g{-1}
# data url in parens
\(data:[^)]*?(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})[^)]*\)
# data url in quotes
([`'"])data:.*?(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,}).*\g{-1}
# data url
data:[-a-zA-Z=;:/0-9+]*,\S*
# mailto urls
mailto:[-a-zA-Z=;:/?%&0-9+@.]{3,}
# magnet urls
magnet:[?=:\w]+
# magnet urls
"magnet:[^"]+"
# obs:
"obs:[^"]*"
# The `\b` here means a break, it's the fancy way to handle urls, but it makes things harder to read
# In this examples content, I'm using a number of different ways to match things to show various approaches
# asciinema
\basciinema\.org/a/[0-9a-zA-Z]+
# apple
\bdeveloper\.apple\.com/[-\w?=/]+
# Apple music
\bembed\.music\.apple\.com/fr/playlist/usr-share/[-\w.]+
# appveyor api
\bci\.appveyor\.com/api/projects/status/[0-9a-z]+
# appveyor project
\bci\.appveyor\.com/project/(?:[^/\s"]*/){2}builds?/\d+/job/[0-9a-z]+
# Amazon
# Amazon
\bamazon\.com/[-\w]+/(?:dp/[0-9A-Z]+|)
# AWS S3
\b\w*\.s3[^.]*\.amazonaws\.com/[-\w/&#%_?:=]*
# AWS execute-api
\b[0-9a-z]{10}\.execute-api\.[-0-9a-z]+\.amazonaws\.com\b
# AWS ELB
\b\w+\.[-0-9a-z]+\.elb\.amazonaws\.com\b
# AWS SNS
\bsns\.[-0-9a-z]+.amazonaws\.com/[-\w/&#%_?:=]*
# AWS VPC
vpc-\w+
# While you could try to match `http://` and `https://` by using `s?` in `https?://`, sometimes there
# YouTube url
\b(?:(?:www\.|)youtube\.com|youtu.be)/(?:channel/|embed/|user/|playlist\?list=|watch\?v=|v/|)[-a-zA-Z0-9?&=_%]*
# YouTube music
\bmusic\.youtube\.com/youtubei/v1/browse(?:[?&]\w+=[-a-zA-Z0-9?&=_]*)
# YouTube tag
<\s*youtube\s+id=['"][-a-zA-Z0-9?_]*['"]
# YouTube image
\bimg\.youtube\.com/vi/[-a-zA-Z0-9?&=_]*
# Google Accounts
\baccounts.google.com/[-_/?=.:;+%&0-9a-zA-Z]*
# Google Analytics
\bgoogle-analytics\.com/collect.[-0-9a-zA-Z?%=&_.~]*
# Google APIs
\bgoogleapis\.(?:com|dev)/[a-z]+/(?:v\d+/|)[a-z]+/[-@:./?=\w+|&]+
# Google Storage
\b[-a-zA-Z0-9.]*\bstorage\d*\.googleapis\.com(?:/\S*|)
# Google Calendar
\bcalendar\.google\.com/calendar(?:/u/\d+|)/embed\?src=[@./?=\w&%]+
\w+\@group\.calendar\.google\.com\b
# Google DataStudio
\bdatastudio\.google\.com/(?:(?:c/|)u/\d+/|)(?:embed/|)(?:open|reporting|datasources|s)/[-0-9a-zA-Z]+(?:/page/[-0-9a-zA-Z]+|)
# The leading `/` here is as opposed to the `\b` above
# ... a short way to match `https://` or `http://` since most urls have one of those prefixes
# Google Docs
/docs\.google\.com/[a-z]+/(?:ccc\?key=\w+|(?:u/\d+|d/(?:e/|)[0-9a-zA-Z_-]+/)?(?:edit\?[-\w=#.]*|/\?[\w=&]*|))
# Google Drive
\bdrive\.google\.com/(?:file/d/|open)[-0-9a-zA-Z_?=]*
# Google Groups
\bgroups\.google\.com/(?:(?:forum/#!|d/)(?:msg|topics?|searchin)|a)/[^/\s"]+/[-a-zA-Z0-9$]+(?:/[-a-zA-Z0-9]+)*
# Google Maps
\bmaps\.google\.com/maps\?[\w&;=]*
# Google themes
themes\.googleusercontent\.com/static/fonts/[^/\s"]+/v\d+/[^.]+.
# Google CDN
\bclients2\.google(?:usercontent|)\.com[-0-9a-zA-Z/.]*
# Goo.gl
/goo\.gl/[a-zA-Z0-9]+
# Google Chrome Store
\bchrome\.google\.com/webstore/detail/[-\w]*(?:/\w*|)
# Google Books
\bgoogle\.(?:\w{2,4})/books(?:/\w+)*\?[-\w\d=&#.]*
# Google Fonts
\bfonts\.(?:googleapis|gstatic)\.com/[-/?=:;+&0-9a-zA-Z]*
# Google Forms
\bforms\.gle/\w+
# Google Scholar
\bscholar\.google\.com/citations\?user=[A-Za-z0-9_]+
# Google Colab Research Drive
\bcolab\.research\.google\.com/drive/[-0-9a-zA-Z_?=]*
# GitHub SHAs (api)
\bapi.github\.com/repos(?:/[^/\s"]+){3}/[0-9a-f]+\b
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)
# GitHub SHAs
\bgithub\.com(?:/[^/\s"]+){2}[@#][0-9a-f]+\b
# GitHub wiki
\bgithub\.com/(?:[^/]+/){2}wiki/(?:(?:[^/]+/|)_history|[^/]+(?:/_compare|)/[0-9a-f.]{40,})\b
# githubusercontent
/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*
# githubassets
\bgithubassets.com/[0-9a-f]+(?:[-/\w.]+)
# gist github
\bgist\.github\.com/[^/\s"]+/[0-9a-f]+
# git.io
\bgit\.io/[0-9a-zA-Z]+
# GitHub JSON
"node_id": "[-a-zA-Z=;:/0-9+]*"
# Contributor
\[[^\]]+\]\(https://github\.com/[^/\s"]+\)
# GHSA
GHSA(?:-[0-9a-z]{4}){3}
# GitLab commit
\bgitlab\.[^/\s"]*/\S+/\S+/commit/[0-9a-f]{7,16}#[0-9a-f]{40}\b
# GitLab merge requests
\bgitlab\.[^/\s"]*/\S+/\S+/-/merge_requests/\d+/diffs#[0-9a-f]{40}\b
# GitLab uploads
\bgitlab\.[^/\s"]*/uploads/[-a-zA-Z=;:/0-9+]*
# GitLab commits
\bgitlab\.[^/\s"]*/(?:[^/\s"]+/){2}commits?/[0-9a-f]+\b
# binanace
accounts.binance.com/[a-z/]*oauth/authorize\?[-0-9a-zA-Z&%]*
# bitbucket diff
\bapi\.bitbucket\.org/\d+\.\d+/repositories/(?:[^/\s"]+/){2}diff(?:stat|)(?:/[^/\s"]+){2}:[0-9a-f]+
# bitbucket repositories commits
\bapi\.bitbucket\.org/\d+\.\d+/repositories/(?:[^/\s"]+/){2}commits?/[0-9a-f]+
# bitbucket commits
\bbitbucket\.org/(?:[^/\s"]+/){2}commits?/[0-9a-f]+
# bit.ly
\bbit\.ly/\w+
# bitrise
\bapp\.bitrise\.io/app/[0-9a-f]*/[\w.?=&]*
# bootstrapcdn.com
\bbootstrapcdn\.com/[-./\w]+
# cdn.cloudflare.com
\bcdnjs\.cloudflare\.com/[./\w]+
# circleci
\bcircleci\.com/gh(?:/[^/\s"]+){1,5}.[a-z]+\?[-0-9a-zA-Z=&]+
# gitter
\bgitter\.im(?:/[^/\s"]+){2}\?at=[0-9a-f]+
# gravatar
\bgravatar\.com/avatar/[0-9a-f]+
# ibm
[a-z.]*ibm\.com/[-_#=:%!?~.\\/\d\w]*
# imgur
\bimgur\.com/[^.]+
# Internet Archive
\barchive\.org/web/\d+/(?:[-\w.?,'/\\+&%$#_:]*)
# discord
/discord(?:app\.com|\.gg)/(?:invite/)?[a-zA-Z0-9]{7,}
# Disqus
\bdisqus\.com/[-\w/%.()!?&=_]*
# medium link
\blink\.medium\.com/[a-zA-Z0-9]+
# medium
\bmedium\.com/\@?[^/\s"]+/[-\w]+
# microsoft
\b(?:https?://|)(?:(?:download\.visualstudio|docs|msdn2?|research)\.microsoft|blogs\.msdn)\.com/[-_a-zA-Z0-9()=./%]*
# powerbi
\bapp\.powerbi\.com/reportEmbed/[^"' ]*
# vs devops
\bvisualstudio.com(?::443|)/[-\w/?=%&.]*
# microsoft store
\bmicrosoft\.com/store/apps/\w+
# mvnrepository.com
\bmvnrepository\.com/[-0-9a-z./]+
# now.sh
/[0-9a-z-.]+\.now\.sh\b
# oracle
\bdocs\.oracle\.com/[-0-9a-zA-Z./_?#&=]*
# chromatic.com
/\S+.chromatic.com\S*[")]
# codacy
\bapi\.codacy\.com/project/badge/Grade/[0-9a-f]+
# compai
\bcompai\.pub/v1/png/[0-9a-f]+
# mailgun api
\.api\.mailgun\.net/v3/domains/[0-9a-z]+\.mailgun.org/messages/[0-9a-zA-Z=@]*
# mailgun
\b[0-9a-z]+.mailgun.org
# /message-id/
/message-id/[-\w@./%]+
# Reddit
\breddit\.com/r/[/\w_]*
# requestb.in
\brequestb\.in/[0-9a-z]+
# sched
\b[a-z0-9]+\.sched\.com\b
# Slack url
slack://[a-zA-Z0-9?&=]+
# Slack
\bslack\.com/[-0-9a-zA-Z/_~?&=.]*
# Slack edge
\bslack-edge\.com/[-a-zA-Z0-9?&=%./]+
# Slack images
\bslack-imgs\.com/[-a-zA-Z0-9?&=%.]+
# shields.io
\bshields\.io/[-\w/%?=&.:+;,]*
# stackexchange -- https://stackexchange.com/feeds/sites
\b(?:askubuntu|serverfault|stack(?:exchange|overflow)|superuser).com/(?:questions/\w+/[-\w]+|a/)
# Sentry
[0-9a-f]{32}\@o\d+\.ingest\.sentry\.io\b
# Twitter markdown
\[\@[^[/\]:]*?\]\(https://twitter.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|)\)
# Twitter hashtag
\btwitter\.com/hashtag/[\w?_=&]*
# Twitter status
\btwitter\.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|)
# Twitter profile images
\btwimg\.com/profile_images/[_\w./]*
# Twitter media
\btwimg\.com/media/[-_\w./?=]*
# Twitter link shortened
\bt\.co/\w+
# facebook
\bfburl\.com/[0-9a-z_]+
# facebook CDN
\bfbcdn\.net/[\w/.,]*
# facebook watch
\bfb\.watch/[0-9A-Za-z]+
# dropbox
\bdropbox\.com/sh?/[^/\s"]+/[-0-9A-Za-z_.%?=&;]+
# ipfs protocol
ipfs://[0-9a-z]*
# ipfs url
/ipfs/[0-9a-z]*
# w3
\bw3\.org/[-0-9a-zA-Z/#.]+
# loom
\bloom\.com/embed/[0-9a-f]+
# regex101
\bregex101\.com/r/[^/\s"]+/\d+
# figma
\bfigma\.com/file(?:/[0-9a-zA-Z]+/)+
# freecodecamp.org
\bfreecodecamp\.org/[-\w/.]+
# image.tmdb.org
\bimage\.tmdb\.org/[/\w.]+
# mermaid
\bmermaid\.ink/img/[-\w]+|\bmermaid-js\.github\.io/mermaid-live-editor/#/edit/[-\w]+
# Wikipedia
\ben\.wikipedia\.org/wiki/[-\w%.#]+
# gitweb
[^"\s]+/gitweb/\S+;h=[0-9a-f]+
# HyperKitty lists
/archives/list/[^@/]+\@[^/\s"]*/message/[^/\s"]*/
# lists
/thread\.html/[^"\s]+
# list-management
\blist-manage\.com/subscribe(?:[?&](?:u|id)=[0-9a-f]+)+
# kubectl.kubernetes.io/last-applied-configuration
"kubectl.kubernetes.io/last-applied-configuration": ".*"
# pgp
\bgnupg\.net/pks/lookup[?&=0-9a-zA-Z]*
# Spotify
\bopen\.spotify\.com/embed/playlist/\w+
# Mastodon
\bmastodon\.[-a-z.]*/(?:media/|\@)[?&=0-9a-zA-Z_]*
# scastie
\bscastie\.scala-lang\.org/[^/]+/\w+
# images.unsplash.com
\bimages\.unsplash\.com/(?:(?:flagged|reserve)/|)[-\w./%?=%&.;]+
# pastebin
\bpastebin\.com/[\w/]+
# heroku
\b\w+\.heroku\.com/source/archive/\w+
# quip
\b\w+\.quip\.com/\w+(?:(?:#|/issues/)\w+)?
# badgen.net
\bbadgen\.net/badge/[^")\]'\s]+
# statuspage.io
\w+\.statuspage\.io\b
# media.giphy.com
\bmedia\.giphy\.com/media/[^/]+/[\w.?&=]+
# tinyurl
\btinyurl\.com/\w+
# getopts
\bgetopts\s+(?:"[^"]+"|'[^']+')
# ANSI color codes
(?:\\(?:u00|x)1b|\x1b)\[\d+(?:;\d+|)m
# URL escaped characters
\%[0-9A-F][A-F]
# IPv6
\b(?:[0-9a-fA-F]{0,4}:){3,7}[0-9a-fA-F]{0,4}\b
# c99 hex digits (not the full format, just one I've seen)
0x[0-9a-fA-F](?:\.[0-9a-fA-F]*|)[pP]
# Punycode
\bxn--[-0-9a-z]+
# sha
sha\d+:[0-9]*[a-f]{3,}[0-9a-f]*
# sha-... -- uses a fancy capture
(['"]|&quot;)[0-9a-f]{40,}\g{-1}
# hex runs
\b[0-9a-fA-F]{16,}\b
# hex in url queries
=[0-9a-fA-F]*?(?:[A-F]{3,}|[a-f]{3,})[0-9a-fA-F]*?&
# ssh
(?:ssh-\S+|-nistp256) [-a-zA-Z=;:/0-9+]{12,}
# PGP
\b(?:[0-9A-F]{4} ){9}[0-9A-F]{4}\b
# GPG keys
\b(?:[0-9A-F]{4} ){5}(?: [0-9A-F]{4}){5}\b
# Well known gpg keys
.well-known/openpgpkey/[\w./]+
# uuid:
\b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b
# hex digits including css/html color classes:
(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|u\d+)\b
# integrity
integrity="sha\d+-[-a-zA-Z=;:/0-9+]{40,}"
# https://www.gnu.org/software/groff/manual/groff.html
# man troff content
\\f[BCIPR]
# '
\\\(aq
# .desktop mime types
^MimeTypes?=.*$
# .desktop localized entries
^[A-Z][a-z]+\[[a-z]+\]=.*$
# Localized .desktop content
Name\[[^\]]+\]=.*
# IServiceProvider
\bI(?=(?:[A-Z][a-z]{2,})+\b)
# crypt
"\$2[ayb]\$.{56}"
# scrypt / argon
\$(?:scrypt|argon\d+[di]*)\$\S+
# Input to GitHub JSON
content: "[-a-zA-Z=;:/0-9+]*="
# Python stringprefix / binaryprefix
# Note that there's a high false positive rate, remove the `?=` and search for the regex to see if the matches seem like reasonable strings
(?<!')\b(?:B|BR|Br|F|FR|Fr|R|RB|RF|Rb|Rf|U|UR|Ur|b|bR|br|f|fR|fr|r|rB|rF|rb|rf|u|uR|ur)'(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})
# Regular expressions for (P|p)assword
\([A-Z]\|[a-z]\)[a-z]+
# JavaScript regular expressions
# javascript test regex
/.*/[gim]*\.test\(
# javascript match regex
\.match\(/[^/\s"]*/[gim]*\s*
# javascript match regex
\.match\(/\\[b].*?/[gim]*\s*\)(?:;|$)
# javascript regex
^\s*/\\[b].*/[gim]*\s*(?:\)(?:;|$)|,$)
# javascript replace regex
\.replace\(/[^/\s"]*/[gim]*\s*,
# Go regular expressions
regexp?\.MustCompile\(`[^`]*`\)
# sed regular expressions
sed 's/(?:[^/]*?[a-zA-Z]{3,}[^/]*?/){2}
# go install
go install(?:\s+[a-z]+\.[-@\w/.]+)+
# kubernetes pod status lists
# https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase
\w+(?:-\w+)+\s+\d+/\d+\s+(?:Running|Pending|Succeeded|Failed|Unknown)\s+
# kubectl - pods in CrashLoopBackOff
\w+-[0-9a-f]+-\w+\s+\d+/\d+\s+CrashLoopBackOff\s+
# kubernetes object suffix
-[0-9a-f]{10}-\w{5}\s
# posthog secrets
posthog\.init\((['"])phc_[^"',]+\g{-1},
# xcode
# xcodeproject scenes
(?:Controller|ID|id)="\w{3}-\w{2}-\w{3}"
# xcode api botches
customObjectInstantitationMethod
# font awesome classes
\.fa-[-a-z0-9]+
# Update Lorem based on your content (requires `ge` and `w` from https://github.com/jsoref/spelling; and `review` from https://github.com/check-spelling/check-spelling/wiki/Looking-for-items-locally )
# grep '^[^#].*lorem' .github/actions/spelling/patterns.txt|perl -pne 's/.*i..\?://;s/\).*//' |tr '|' "\n"|sort -f |xargs -n1 ge|perl -pne 's/^[^:]*://'|sort -u|w|sed -e 's/ .*//'|w|review -
# Warning, while `(?i)` is very neat and fancy, if you have some binary files that aren't proper unicode, you might run into:
## Operation "substitution (s///)" returns its argument for non-Unicode code point 0x1C19AE (the code point will vary).
## You could manually change `(?i)X...` to use `[Xx]...`
## or you could add the files to your `excludes` file (a version after 0.0.19 should identify the file path)
# Lorem
(?:\w|\s|[,.])*\b(?i)(?:amet|consectetur|cursus|dolor|eros|ipsum|lacus|libero|ligula|lorem|magna|neque|nulla|suscipit|tempus)\b(?:\w|\s|[,.])*
# Non-English
[a-zA-Z]*[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]*
# French
# This corpus only had capital letters, but you probably want lowercase ones as well.
\b[LN]'+[a-z]{2,}\b
# latex
\\(?:n(?:ew|ormal|osub)|r(?:enew)|t(?:able(?:of|)|he|itle))(?=[a-z]+)
# the negative lookahead here is to allow catching 'templatesz' as a misspelling
# but to otherwise recognize a Windows path with \templates\foo.template or similar:
\\(?:necessary|r(?:eport|esolve[dr]?|esult)|t(?:arget|emplates?))(?![a-z])
# ignore long runs of a single character:
\b([A-Za-z])\g{-1}{3,}\b
# version suffix <word>v#
(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))
# Compiler flags (Scala)
(?:^|[\t ,>"'`=(])-J-[DPWXY](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})
# Compiler flags
(?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})
# Compiler flags (linker)
,-B
# curl arguments
\b(?:\\n|)curl(?:\s+-[a-zA-Z]{1,2}\b)*(?:\s+-[a-zA-Z]{3,})(?:\s+-[a-zA-Z]+)*
# set arguments
\bset(?:\s+-[abefimouxE]{1,2})*\s+-[abefimouxE]{3,}(?:\s+-[abefimouxE]+)*
# tar arguments
\b(?:\\n|)g?tar(?:\.exe|)(?:(?:\s+--[-a-zA-Z]+|\s+-[a-zA-Z]+|\s[ABGJMOPRSUWZacdfh-pr-xz]+\b)(?:=[^ ]*|))+
# tput arguments -- https://man7.org/linux/man-pages/man5/terminfo.5.html -- technically they can be more than 5 chars long...
\btput\s+(?:(?:-[SV]|-T\s*\w+)\s+)*\w{3,5}\b
# macOS temp folders
/var/folders/\w\w/[+\w]+/(?:T|-Caches-)/

70
.github/actions/spelling/excludes.txt vendored Normal file
View File

@@ -0,0 +1,70 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes
(?:^|/)(?i)COPYRIGHT
(?:^|/)(?i)LICEN[CS]E
(?:^|/)3rdparty/
(?:^|/)go\.sum$
(?:^|/)package(?:-lock|)\.json$
(?:^|/)vendor/
/fonts/
ignore$
\.avi$
\.bmp$
\.bz2$
\.class$
\.crt$
\.dll$
\.docx?$
\.drawio$
\.DS_Store$
\.eot$
\.exe$
\.gif$
\.gitattributes$
\.graffle$
\.gz$
\.icns$
\.ico$
\.jar$
\.jks$
\.jpe?g$
\.key$
\.lib$
\.lock$
\.map$
\.min\..
\.mod$
\.mp[34]$
\.o$
\.ocf$
\.otf$
\.pdf$
\.pem$
\.png$
\.psd$
\.pyc$
\.s$
\.svgz?$
\.tar$
\.tiff?$
\.ttf$
\.wav$
\.webm$
\.webp$
\.woff$
\.woff2$
\.xlsx?$
\.zip$
^docs/pages/redirects/github\.html$
^lib/jekyll/mime\.types$
^lib/theme_template/example/index\.html$
^lib/theme_template/example/_post\.md$
^test/fixtures/empty_permalink\.erb$
^test/fixtures/webrick/bar/baz\.html$
^test/fixtures/webrick/bar/foo\.xhtml$
^test/source/_posts/2009-06-22-no-yaml\.markdown$
^\.github/
^\Q.github/workflows/spelling.yml\E$

479
.github/actions/spelling/expect.txt vendored Normal file
View File

@@ -0,0 +1,479 @@
adaoraul
AFile
afterall
Alexey
alfredxing
Anatoliy
andreyvit
Ankit
Anning
appveyor
arengu
ariejan
asciinema
asdf
ashmaroli
Autobuild
autoreconf
awood
awscli
backticks
barcamp
bbatsov
bdimcheff
bellvat
benbalter
Beney
binstubs
bitbucket
Blogger
blogging
blogs
bonafide
Bou
breadcrumbs
briandoll
bridgetown
bridgetownrb
brightbox
brighterplanet
buddyworks
builtatlightspeed
Burela
byparker
cachegrind
calavera
callgraphs
cartera
cavalle
CDNs
cgi
chango
Chayoung
Cheatsheet
Checkoway
Chrononaut
cibuild
cimg
circleci
CJK
classname
cloudcannon
Cloudinary
cloudsh
CLT
codeclimate
CODEOWNERS
coderay
codeslinger
colorator
commonmark
compatibilize
configyml
contentblocks
Cov
CRLFs
cruft
Currin
cygwin
daringfireball
Dassonville
datafiles
DCEU
Debian
defunkt
delegators
devcontainer
digitalocean
disqus
ditaa
dnf
doclist
doeorg
dommmel
dotfile
Dousse
duckduckgo
duritong
Dusseau
dysinger
ecf
eduardoboucas
Emacs
emojis
endcapture
endraw
endrender
endtablerow
Enumerables
erb
errordocument
Espinaco
eugenebolshakov
evaled
extnames
exts
Fengyun
ffi
Finazzo
firstimage
flakey
flickr
fontello
forloop
formcake
formcarry
formester
formingo
formkeep
formspark
formspree
formx
freenode
fsnotify
fullstory
Gaudino
gcc
gcnovus
gemfile
getform
getset
getsimpleform
gettalong
ghp
ghpages
giraffeacademy
githubcom
gitlab
gjtorikian
globbed
gotcha
Goulven
gridism
GSo
gsubbing
hashbang
henrik
heroku
hilighting
Hoizey
hostman
htmlproofer
Iaa
ial
iconset
ified
invokables
ivey
ize
jalali
jamstackthemes
jan
Jax
jcon
jdoe
jeffreytse
jeffrydegrande
Jekpack
jekyllbot
jekyllconf
Jekyllers
Jekyllin
jekyllized
jekylllayoutconcept
jekyllrb
jekyllthemes
jekyllup
jemoji
jmcglone
johnreilly
jqr
jsonify
juretta
jwarby
Kacper
Kasberg
Kentico
Kewin
keycdn
kickster
Kinnula
kinsta
kiwifruit
Kolesky
konklone
kontent
Kotvinsky
kramdown
Kulig
Kwokfu
Lamprecht
launchctl
launchy
laurilehmijoki
learnxinyminutes
lexers
linenos
linkify
liufengyun
localheinz
Locher
Losslessly
lovin
lsi
lstrip
lyche
macromates
mademistakes
Manmeet
markdownify
Maroli
Marsceill
maruku
mathjax
mathml
mattr
Maximiliano
mchung
memberspace
mentoring
mergable
Mertcan
mertkahyaoglu
metadatas
microdata
minibundle
Mittal
mkasberg
mkd
mkdn
mkdown
modernizr
mojombo
moncefbelyamani
moz
mreid
mswin
MSYS
Mvvm
myblog
mycontent
mydata
mydoc
myimage
mypage
myposts
myproject
myrepo
myvalue
myvar
Nadjib
nakanishi
navbars
nearlyfreespeech
nethack
netlify
Neue
nginx
ngx
nielsenramon
noifniof
notextile
onebox
oneclick
opensource
Optim
orderofinterpretation
OSVDB
osx
packagecontrol
pacman
pandoc
pantulis
parkr
parseable
paspagon
passthrough
pathawks
Pathutil
paywall
PDFs
Pelykh
pinboard
Piwigo
pjhyett
pkill
pkpass
planetjekyll
plantuml
podcasts
Porcel
Posterous
postfiles
postmodern
preinstalled
Prioritise
Probot
projectlist
pubstorm
pufuwozu
pygments
qrush
Quaid
rackup
razorops
rdiscount
realz
rebund
redcarpet
redcloth
redgreen
redhat
Refactors
Refheap
regen
remi
Responsify
revertable
rfelix
RHEL
ridk
rstrip
rtomayko
Rubo
rubychan
rubyinstaller
rubyprof
Ruparelia
Rusiczki
rvm
saas
samplelist
samrayner
Sassc
Schroers
Schwartzian
screenshot
scrollbars
SDKROOT
sectore
seo
shingo
shopify
shortlinks
shortlog
shoulda
sieversii
sigpipe
Singhaniya
siteleaf
SITENAME
Slicehost
slugified
smartforms
smartify
snipcart
socio
somedir
sonnym
Sonomy
sourced
spam
spotify
ssg
standalone
staticman
Stickyposts
styleguide
subdir
subdomain
subfolderitems
subpages
subpiece
subsubfolderitems
subthing
subvalues
subwidget
superdirectories
superdirs
SUSE
sverrirs
swfobject
swupd
tada
Taillandier
talkyard
technicalpickles
templating
Termux
textilize
textpattern
Theunissen
Thornquest
throughs
Tidelift
timeago
timezones
tmm
tomjoht
tomo
toshimaru
triaged
triaging
tsv
Tudou
Tumblr
Tweetsert
txtpen
Tyborska
tzinfo
ujh
ultron
undumpable
unencode
uppercasing
urlset
usernames
utm
vanpelt
Vasovi
vendored
versioned
versioning
vertycal
Veyor
vilcans
Vishesh
vnd
vohedge
vps
vwochnik
WAI
wdm
We'd
webfonts
webhosting
webmentions
website
wildcards
willcodeforfoo
wordpress
workflows
xcode
xdg
Xhmikos
Xiaoiver
XMinutes
xmlschema
Yarp
Yashu
Yastreb
Youku
youtube
yunbox
zeropadding
Zlatan
zoneinfo
zpinter
zypper
zzot

View File

@@ -0,0 +1,62 @@
# reject `m_data` as there's a certain OS which has evil defines that break things if it's used elsewhere
# \bm_data\b
# If you have a framework that uses `it()` for testing and `fit()` for debugging a specific test,
# you might not want to check in code where you were debugging w/ `fit()`, in which case, you might want
# to use this:
#\bfit\(
# s.b. GitHub
\bGithub\b
# s.b. GitLab
\bGitlab\b
# s.b. JavaScript
\bJavascript\b
# s.b. Microsoft
\bMicroSoft\b
# s.b. another
\ban[- ]other\b
# s.b. greater than
\bgreater then\b
# s.b. into
#\sin to\s
# s.b. opt-in
\sopt in\s
# s.b. less than
\bless then\b
# s.b. otherwise
\bother[- ]wise\b
# s.b. nonexistent
\bnon existing\b
\b[Nn]o[nt][- ]existent\b
# s.b. preexisting
[Pp]re[- ]existing
# s.b. preempt
[Pp]re[- ]empt\b
# s.b. preemptively
[Pp]re[- ]emptively
# s.b. reentrancy
[Rr]e[- ]entrancy
# s.b. reentrant
[Rr]e[- ]entrant
# s.b. workaround(s)
#\bwork[- ]arounds?\b
# Reject duplicate words
\s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s

1
.github/actions/spelling/only.txt vendored Normal file
View File

@@ -0,0 +1 @@
^docs/.*\.md$

164
.github/actions/spelling/patterns.txt vendored Normal file
View File

@@ -0,0 +1,164 @@
# See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns
# data urls
(['"])data:.*?\g{-1}
data:[-a-zA-Z=;:/0-9+]*,\S*
# YouTube
https?://(?:(?:www\.|)youtube\.com|youtu.be)/(?:channel/|embed/|playlist\?list=|watch\?v=|v/|)[-a-zA-Z0-9?&=_]*
<\s*youtube\s+id=['"][-a-zA-Z0-9?_]*['"]
\bimg\.youtube\.com/vi/[-a-zA-Z0-9?&=_]*
youtube_id:\s*[-a-zA-Z0-9?&=_]*
# Google Analytics
\bgoogle-analytics\.com/collect.[-0-9a-zA-Z?%=&_.~]*
# Google APIs
\bgoogleapis\.com/[a-z]+/v\d+/[a-z]+/[@./?=\w]+
\b[-a-zA-Z0-9.]*\bstorage\d*\.googleapis\.com(?:/\S*|)
# Google Calendar
\bcalendar\.google\.com/calendar(?:/u/\d+|)/embed\?src=[@./?=\w&%]+
\w+\@group\.calendar\.google\.com\b
# Google DataStudio
\bdatastudio\.google\.com/(?:(?:c/|)u/\d+/|)(?:embed/|)(?:open|reporting|datasources|s)/[-0-9a-zA-Z]+(?:/page/[-0-9a-zA-Z]+|)
# The leading `/` here is as opposed to the `\b` above
# ... a short way to match `https://` or `http://` since most urls have one of those prefixes
# Google Docs
/docs\.google\.com/[a-z]+/d/(?:e/|)[0-9a-zA-Z_-]+/?
# Google Groups
https://groups\.google\.com/d/topic/[^/]+/[a-zA-Z0-9]+/discussion
https://groups\.google\.com/d/msg/[^/]+/[a-zA-Z0-9]+/[a-zA-Z0-9]+
# Google themes
themes\.googleusercontent\.com/static/fonts/[^/]+/v\d+/[^.]+.
# Google CDN
\bclients2\.google(?:usercontent|)\.com[-0-9a-zA-Z/.]*
# Goo.gl
/goo\.gl/[a-zA-Z0-9]+
# Google Chrome Store
\bchrome\.google\.com/webstore/detail/\w*(?:/\w*|)
# google_site_verification:
google_site_verification: [-a-zA-Z=;:/0-9+]*
# Ruby-doc.org
https://ruby-doc\.org/.*
# Contributors
alphabetical order.*:.*
twitter_handle: .*
# apiKey
apiKey: '[a-f0-9]+'
# FontAwesome
/(?:(?i)FontAwesome\.\w+\?\w+)
# Lorem
(?:\w|\s|[,.])*\b(?i)(?:amet|consectetur|cursus|dolor|eros|ipsum|lacus|libero|ligula|lorem|magna|neque|nulla|suscipit|tempus|ultrices)\b(?:\w|\s|[,.])*
# URL escaped characters
\%[0-9A-F]{2}
# c99 hex digits (not the full format, just one I've seen)
# hex digits including css/html color classes:
(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9a-fA-FgGrR_]{2,}(?:[uU]?[lL]{0,2}|u\d+)\b
# Automatically suggested patterns
# hit-count: 23 file-count: 15
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)
# hit-count: 7 file-count: 4
# Wikipedia
\ben\.wikipedia\.org/wiki/[-\w%.#]+
# hit-count: 5 file-count: 3
# Non-English
[a-zA-Z]*[ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]*
# hit-count: 4 file-count: 4
# Twitter status
\btwitter\.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|)
# hit-count: 3 file-count: 3
# stackexchange -- https://stackexchange.com/feeds/sites
\b(?:askubuntu|serverfault|stack(?:exchange|overflow)|superuser).com/(?:questions/\w+/[-\w]+|a/)
# hit-count: 3 file-count: 2
# vs devops
\bvisualstudio.com(?::443|)/[-\w/?=%&.]*
# hit-count: 2 file-count: 2
# mailto urls
mailto:[-a-zA-Z=;:/?%&0-9+@.]{3,}
# hit-count: 2 file-count: 2
# githubusercontent
/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]*
# hit-count: 2 file-count: 2
# hex runs
\b[0-9a-fA-F]{16,}\b
# hit-count: 2 file-count: 2
# curl arguments
\b(?:\\n|)curl(?:\s+-[a-zA-Z]{1,2}\b)*(?:\s+-[a-zA-Z]{3,})(?:\s+-[a-zA-Z]+)*
# hit-count: 2 file-count: 1
# microsoft
\b(?:https?://|)(?:(?:download\.visualstudio|docs|msdn2?|research)\.microsoft|blogs\.msdn)\.com/[-_a-zA-Z0-9()=./%]*
# hit-count: 1 file-count: 1
# Amazon
\bamazon\.com/[-\w]+/(?:dp/[0-9A-Z]+|)
# hit-count: 1 file-count: 1
# gist github
\bgist\.github\.com/[^/\s"]+/[0-9a-f]+
# hit-count: 1 file-count: 1
# Contributor
\[[^\]]+\]\(https://github\.com/[^/\s"]+\)
# hit-count: 1 file-count: 1
# medium
\bmedium\.com/\@?[^/\s"]+/[-\w]+
# hit-count: 1 file-count: 1
# Twitter markdown
\[\@[^[/\]:]*?\]\(https://twitter.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|)\)
# Questionably acceptable forms of `in to`
# Personally, I prefer `log into`, but people object
# https://www.tprteaching.com/log-into-log-in-to-login/
\b[Ll]og in to\b
# acceptable duplicates
# ls directory listings
[-bcdlpsw](?:[-r][-w][-sx]){3}\s+\d+\s+(\S+)\s+\g{-1}\s+\d+\s+
# C types and repeated CSS values
\s(center|div|inherit|long|LONG|none|normal|solid|thin|transparent|very)(?: \g{-1})+\s
# go templates
\s(\w+)\s+\g{-1}\s+\`(?:graphql|json|yaml):
# javadoc / .net
(?:[\\@](?:groupname|param)|(?:public|private)(?:\s+static|\s+readonly)*)\s+(\w+)\s+\g{-1}\s
# Commit message -- Signed-off-by and friends
^\s*(?:(?:Based-on-patch|Co-authored|Helped|Mentored|Reported|Reviewed|Signed-off)-by|Thanks-to): (?:[^<]*<[^>]*>|[^<]*)\s*$
# Autogenerated revert commit message
^This reverts commit [0-9a-f]{40}\.$
# ignore long runs of a single character:
\b([A-Za-z])\g{-1}{3,}\b
# ignore inline code
`\w+`

10
.github/actions/spelling/reject.txt vendored Normal file
View File

@@ -0,0 +1,10 @@
^attache$
benefitting
occurences?
^dependan.*
^oer$
Sorce
^[Ss]pae.*
^untill$
^untilling$
^wether.*

15
.github/config.yml vendored Normal file
View File

@@ -0,0 +1,15 @@
updateDocsComment: >
Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would update some of our documentation based on your changes.
updateDocsWhiteList:
- bug
- fix
- Backport
- dev
- Update
- WIP
- chore
updateDocsTargetFiles:
- README
- docs/

12
.github/dependabot.yml vendored Normal file
View File

@@ -0,0 +1,12 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
- package-ecosystem: bundler
reviewers:
- "jekyll/core"
directory: /
schedule:
interval: weekly

44
.github/first-timers-issue-template.md vendored Normal file
View File

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

6
.github/first-timers.yml vendored Normal file
View File

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

17
.github/release-please-config.json vendored Normal file
View File

@@ -0,0 +1,17 @@
{
"pull-request-title-pattern": "chore: release 💎 ${version}",
"packages": {
".": {
"changelog-path": "History.markdown",
"release-type": "ruby",
"bump-minor-pre-major": false,
"bump-patch-for-minor-pre-major": false,
"draft": false,
"prerelease": false,
"include-component-in-tag": false,
"include-v-in-tag": true,
"version-file": "lib/jekyll/version.rb"
}
},
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json"
}

3
.github/release-please-manifest.json vendored Normal file
View File

@@ -0,0 +1,3 @@
{
".": "4.4.1"
}

14
.github/workflows/actions/memprof.rb vendored Normal file
View File

@@ -0,0 +1,14 @@
# frozen_string_literal: true
require 'jekyll'
require 'memory_profiler'
MemoryProfiler.report(allow_files: ['lib/jekyll/', 'lib/jekyll.rb']) do
Jekyll::PluginManager.require_from_bundler
Jekyll::Commands::Build.process({
"source" => File.expand_path(ARGV[0]),
"destination" => File.expand_path("#{ARGV[0]}/_site"),
"disable_disk_cache" => true,
})
puts ''
end.pretty_print(scale_bytes: true, normalize_paths: true)

30
.github/workflows/benchmark.yml vendored Normal file
View File

@@ -0,0 +1,30 @@
name: Micro Benchmark Runs
on:
workflow_dispatch:
inputs:
path:
description: "Path to benchmark script relative to 'benchmark' directory."
required: true
default: "capture-assign.rb"
ruby_version:
description: "Ruby version to use (via `ruby/setup-ruby@v1`) action."
required: false
default: "2.7"
jobs:
benchmark:
name: "Benchmark (${{ github.event.inputs.path }}) (Ruby ${{ github.event.inputs.ruby_version }})"
runs-on: "ubuntu-latest"
env:
BENCHMARK: true
steps:
- name: Checkout Jekyll
uses: actions/checkout@v4
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ github.event.inputs.ruby_version }}
bundler-cache: true
- name: Run Benchmark
run: "bundle exec ruby benchmark/${{ github.event.inputs.path }}"

87
.github/workflows/ci.yml vendored Normal file
View File

@@ -0,0 +1,87 @@
name: Continuous Integration
on:
push:
branches:
- master
- "*-stable"
paths-ignore:
- "docs/**"
pull_request:
branches:
- master
- "*-stable"
paths-ignore:
- "docs/**"
jobs:
ci:
name: "Run Tests (${{ matrix.ruby.label }} on ${{ matrix.os.label }})"
runs-on: ${{ matrix.os.image }}
strategy:
fail-fast: false
matrix:
ruby:
- label: Ruby 2.7
version: "2.7"
- label: Ruby 3.3
version: "3.3"
- label: Ruby 3.4
version: "3.4"
os:
- label: Linux
image: "ubuntu-latest"
- label: Windows
image: "windows-latest"
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: "Set up ${{ matrix.ruby.label }}"
uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ matrix.ruby.version }}
bundler-cache: true
- name: Run Minitest based tests
run: bash script/test
- name: Run Cucumber based tests
run: bash script/cucumber --color
- name: Generate and Build a new site
run: bash script/default-site
xtras:
name: "${{ matrix.job_name }} (${{ matrix.setup_label }})"
runs-on: "ubuntu-latest"
strategy:
fail-fast: false
matrix:
include:
- job_name: "Unit Test with JRuby"
setup_label: "JRuby 9.4.8.0"
step_name: "Run Minitest based tests"
script_file: "test"
ruby_version: "jruby-9.4.8.0"
- job_name: "Smoke Test with JRuby"
setup_label: "JRuby 9.4.8.0"
step_name: "Generate and Build a new site"
script_file: "default-site"
ruby_version: "jruby-9.4.8.0"
- job_name: "Profile Docs Site"
setup_label: "Ruby 2.7"
step_name: "Build and Profile docs site"
script_file: "profile-docs"
ruby_version: "2.7"
- job_name: "Style Check"
setup_label: "Ruby 2.7"
step_name: "Run RuboCop"
script_file: "fmt"
ruby_version: "2.7"
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: "Set up ${{ matrix.setup_label }}"
uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ matrix.ruby_version }}
bundler-cache: true
- name: ${{ matrix.step_name }}
run: bash script/${{ matrix.script_file }}

65
.github/workflows/codeql.yml vendored Normal file
View File

@@ -0,0 +1,65 @@
name: "CodeQL"
on:
# push:
# branches: [ 'master' ]
# pull_request:
# # The branches below must be a subset of the branches above
# branches: [ 'master' ]
schedule:
- cron: '56 11 * * 5'
jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write
strategy:
fail-fast: false
matrix:
language: [ 'ruby', 'javascript' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Use only 'java' to analyze code written in Java, Kotlin or both
# Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
steps:
- name: Checkout repository
uses: actions/checkout@v4
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2
# Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
# - run: |
# echo "Run, Build Application using script"
# ./location_of_script_within_repo/buildscript.sh
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{matrix.language}}"

View File

@@ -0,0 +1,50 @@
# This workflow checks to ensure that all PR titles conform to the conventional
# commit spec and use the correct type and scopes. The spec for conventional
# commits can be found at https://www.conventionalcommits.org and there is a
# nice cheatsheet in a github gist at
# https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13
#
# The types in this workflow match the spec. The scopes are custom to
# Jekyll and can be changed if desired.
name: Conventional Commit Check
permissions:
pull-requests: read
on:
pull_request_target:
types: [opened, edited, synchronize, reopened, ready_for_review]
branches:
- master
jobs:
commit_lint:
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v5.5.3
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
types: |
feat
fix
perf
refactor
docs
style
test
chore
scopes: |
core
cli
commands
plugins
site
helpers
converters
filters
tags
drops
tests
docs
requireScope: false

54
.github/workflows/docs.yml vendored Normal file
View File

@@ -0,0 +1,54 @@
name: Build and deploy Jekyll documentation site
on:
push:
branches:
- master
paths:
- "docs/**"
env:
RUBY_VERSION: 2.7
jobs:
deploy_docs:
if: "!contains(github.event.commits[0].message, '[ci skip]')"
runs-on: 'ubuntu-latest'
env:
BUNDLE_PATH: "vendor/bundle"
BUNDLE_JOBS: 4
BUNDLE_RETRY: 3
steps:
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ env.RUBY_VERSION }}
bundler-cache: true
- name: Clone target branch
run: |
REMOTE_BRANCH="${REMOTE_BRANCH:-gh-pages}"
REMOTE_REPO="https://${GITHUB_ACTOR}:${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git"
echo "Publishing to ${GITHUB_REPOSITORY} on branch ${REMOTE_BRANCH}"
rm -rf docs/_site/
git clone --depth=1 --branch="${REMOTE_BRANCH}" --single-branch --no-checkout \
"${REMOTE_REPO}" docs/_site/
- name: Build site
run: bundle exec jekyll build --source docs --destination docs/_site --verbose --trace
env:
# For jekyll-github-metadata
JEKYLL_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Deploy to GitHub Pages
run: |
SOURCE_COMMIT="$(git log -1 --pretty="%an: %B" "$GITHUB_SHA")"
pushd docs/_site &>/dev/null
: > .nojekyll
git add --all
git -c user.name="${GITHUB_ACTOR}" -c user.email="${GITHUB_ACTOR}@users.noreply.github.com" \
commit --quiet \
--message "Deploy docs from ${GITHUB_SHA}" \
--message "$SOURCE_COMMIT"
git push
popd &>/dev/null

44
.github/workflows/release-please.yml vendored Normal file
View File

@@ -0,0 +1,44 @@
name: "Release, please!"
on:
push:
branches:
- master
permissions:
contents: write
pull-requests: write
jobs:
release-please:
if: ${{ github.repository == 'jekyll/jekyll' }}
runs-on: ubuntu-latest
outputs:
release_created: ${{ steps.release.outputs.release_created }}
tag_name: ${{ steps.release.outputs.tag_name }}
steps:
- name: Run Release Please
id: release
uses: googleapis/release-please-action@v4
with:
config-file: .github/release-please-config.json
manifest-file: .github/release-please-manifest.json
token: ${{ secrets.JEKYLLBOT_TOKEN }}
publish-gem:
needs: release-please
if: ${{ needs.release-please.outputs.release_created == 'true' }}
runs-on: ubuntu-latest
permissions:
id-token: write
contents: write
steps:
- name: Checkout Repository
uses: actions/checkout@v6
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.3'
bundler-cache: true
- name: Build and Publish Gem
uses: rubygems/release-gem@v1

95
.github/workflows/spelling.yml vendored Normal file
View File

@@ -0,0 +1,95 @@
name: Spell Check
# Comment management is handled through a secondary job, for details see:
# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions
#
# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment
# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare)
# it needs `contents: write` in order to add a comment.
#
# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment
# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment)
# it needs `pull-requests: write` in order to manipulate those comments.
# Updating pull request branches is managed via comment handling.
# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list
#
# These elements work together to make it happen:
#
# `on.issue_comment`
# This event listens to comments by users asking to update the metadata.
#
# `jobs.update`
# This job runs in response to an issue_comment and will push a new commit
# to update the spelling metadata.
#
# `with.experimental_apply_changes_via_bot`
# Tells the action to support and generate messages that enable it
# to make a commit to update the spelling metadata.
#
# `with.ssh_key`
# In order to trigger workflows when the commit is made, you can provide a
# secret (typically, a write-enabled github deploy key).
#
# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key
on:
# Switch from `pull_request_target` event to reduce distraction from comments
# regarding errors reported in unmodified files.
pull_request:
branches:
- master
- "*-stable"
tags-ignore:
- "**"
types:
- 'opened'
- 'reopened'
- 'synchronize'
jobs:
spelling:
name: Spell Check
permissions:
contents: read
pull-requests: read
actions: read
outputs:
followup: ${{ steps.spelling.outputs.followup }}
runs-on: ubuntu-latest
if: "contains(github.event_name, 'pull_request') || github.event_name == 'push'"
concurrency:
group: spelling-${{ github.event.pull_request.number || github.ref }}
# note: If you use only_check_changed_files, you do not want cancel-in-progress
cancel-in-progress: true
steps:
- name: check-spelling
id: spelling
uses: check-spelling/check-spelling@v0.0.26
with:
# This workflow runs in response to both `push` and `pull_request`, if there's an open `pull_request` in the same repository
# for a given branch, there's no reason to spend resources checking both the `push` and the `pull_request`, so this flag tells
# the action while running for the `push` to find the `pull_request` and stop working early:
suppress_push_for_open_pull_request: 1
# The action will manage checking out the repository itself instead of requiring the workflow to use `actions/checkout...`:
checkout: true
# If running without `: write`, posting a comment won't work, and for security `: write` permissions are left to a distinct
# (optional) job, here we skip trying to post a comment:
post_comment: 0
use_magic_file: 1
extra_dictionary_limit: 10
extra_dictionaries:
cspell:software-terms/software-terms.txt
cspell:php/php.txt
cspell:node/node.txt
cspell:django/django.txt
cspell:html/html.txt
cspell:npm/npm.txt
cspell:ruby/ruby.txt
cspell:fullstack/fullstack.txt
cspell:filetypes/filetypes.txt
check_extra_dictionaries: ''
dictionary_source_prefixes: >-
{"cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20241114/dictionaries/"}
# This workflow has opted not to use comments (users can view the report in GitHub Step Summary)

36
.github/workflows/third-party.yml vendored Normal file
View File

@@ -0,0 +1,36 @@
name: Third-Party Repository Profiling
on:
workflow_dispatch:
jobs:
build_n_profile:
runs-on: "ubuntu-latest"
env:
BUNDLE_GEMFILE: "sandbox/Gemfile"
BUNDLE_PATH: "vendor/bundle"
BUNDLE_JOBS: 4
BUNDLE_RETRY: 3
steps:
- name: Checkout Jekyll
uses: actions/checkout@v4
with:
fetch-depth: 5
path: jekyll
- name: Checkout Third-Party Repository
uses: actions/checkout@v4
with:
repository: ashmaroli/tomjoht.github.io
path: sandbox
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.4
bundler-cache: true
- name: Run Jekyll Build 3 times
run: |
bundle exec jekyll build -s sandbox -d sandbox/_site --trace
bundle exec jekyll build -s sandbox -d sandbox/_site --trace
bundle exec jekyll build -s sandbox -d sandbox/_site --trace
- name: Memory Analysis of Jekyll Build
run: bundle exec ruby jekyll/.github/workflows/actions/memprof.rb sandbox

28
.gitignore vendored Normal file
View File

@@ -0,0 +1,28 @@
# Jekyll
_site/
*-cache/
.jekyll-metadata
# Ruby
.bundle/
.byebug_history
.ruby-gemset
.ruby-version
*.gem
Gemfile.lock
# Files
.analysis
.DS_Store
*.swp
*~
# Folders
/vendor
bbin/
bin/
coverage
gh-pages/
pkg/
test/dest
tmp/*

3
.jrubyrc Normal file
View File

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

605
.rubocop.yml Normal file
View File

@@ -0,0 +1,605 @@
# -----------------------------------------------------------------------------
# This file has been formatted via a Rake Task configuring cops from
# RuboCop v1.57.2.
#
# To add more cops, paste configurations at the end of the file and run
# the rake task via `bundle exec rake rubocop:format_config`.
# -----------------------------------------------------------------------------
inherit_from: ".rubocop_todo.yml"
require:
- "./rubocop/jekyll"
- rubocop-minitest
- rubocop-performance
- rubocop-rake
- rubocop-rspec
# Directive for all cops
AllCops:
TargetRubyVersion: 2.7
Include:
- lib/**/*.rb
- test/**/*.rb
Exclude:
- benchmark/**/*
- bin/**/*
- exe/**/*
- script/**/*
- tmp/**/*
- vendor/**/*
# Configure custom cop
Jekyll/NoPutsAllowed:
Exclude:
- rake/*.rake
# Configure built-in cops
# =======================
# Gemspec cops
# ----------------------------------------
Gemspec/DeprecatedAttributeAssignment:
Enabled: true
Gemspec/DevelopmentDependencies:
Enabled: false
Gemspec/RequireMFA:
Enabled: false
# Layout cops
# ----------------------------------------
Layout/BeginEndAlignment:
Enabled: true
Layout/EmptyComment:
Enabled: false
Layout/EmptyLinesAroundAttributeAccessor:
Enabled: true
Layout/EndAlignment:
Severity: error
Layout/EndOfLine:
Enabled: false
Layout/FirstArrayElementIndentation:
EnforcedStyle: consistent
Layout/FirstHashElementIndentation:
EnforcedStyle: consistent
Layout/HashAlignment:
EnforcedHashRocketStyle: table
Layout/IndentationWidth:
Severity: error
Layout/LineContinuationLeadingSpace:
Enabled: true
Layout/LineContinuationSpacing:
Enabled: true
Layout/LineEndStringConcatenationIndentation:
Enabled: true
Layout/LineLength:
Exclude:
- Gemfile
- Rakefile
- features/**/*.rb
- rake/**/*.rake
Max: 100
Severity: warning
Layout/MultilineMethodCallIndentation:
EnforcedStyle: indented
Layout/MultilineOperationIndentation:
EnforcedStyle: indented
Layout/SpaceAroundMethodCallOperator:
Enabled: true
Layout/SpaceBeforeBrackets:
Enabled: true
Layout/SpaceInsideHashLiteralBraces:
Enabled: true
Exclude:
- test/**/*.rb
# Lint cops
# ----------------------------------------
Lint/AmbiguousAssignment:
Enabled: true
Lint/AmbiguousOperatorPrecedence:
Enabled: true
Lint/AmbiguousRange:
Enabled: true
Lint/BinaryOperatorWithIdenticalOperands:
Enabled: true
Lint/ConstantDefinitionInBlock:
Enabled: true
Exclude:
- test/**/*.rb
Lint/ConstantOverwrittenInRescue:
Enabled: true
Lint/DeprecatedConstants:
Enabled: true
Lint/DeprecatedOpenSSLConstant:
Enabled: true
Lint/DuplicateBranch:
Enabled: true
Lint/DuplicateElsifCondition:
Enabled: true
Lint/DuplicateMagicComment:
Enabled: true
Lint/DuplicateMatchPattern:
Enabled: true
Lint/DuplicateRegexpCharacterClassElement:
Enabled: true
Lint/DuplicateRequire:
Enabled: true
Lint/DuplicateRescueException:
Enabled: true
Lint/EmptyBlock:
Enabled: true
Lint/EmptyClass:
Enabled: true
Lint/EmptyConditionalBody:
Enabled: true
Lint/EmptyFile:
Enabled: true
Lint/FloatComparison:
Enabled: true
Lint/HashCompareByIdentity:
Enabled: true
Lint/IdentityComparison:
Enabled: true
Lint/LambdaWithoutLiteralBlock:
Enabled: true
Lint/MissingSuper:
Enabled: false
Lint/MixedCaseRange:
Enabled: true
Lint/MixedRegexpCaptureTypes:
Enabled: false
Lint/NestedPercentLiteral:
Exclude:
- test/test_site.rb
Lint/NoReturnInBeginEndBlocks:
Enabled: true
Lint/NumberedParameterAssignment:
Enabled: true
Lint/OrAssignmentToConstant:
Enabled: true
Lint/OutOfRangeRegexpRef:
Enabled: true
Lint/RaiseException:
Enabled: true
Lint/RedundantDirGlobSort:
Enabled: true
Lint/RedundantRegexpQuantifiers:
Enabled: true
Lint/RedundantSafeNavigation:
Enabled: true
Lint/RefinementImportMethods:
Enabled: true
Lint/RequireRangeParentheses:
Enabled: true
Lint/RequireRelativeSelfPath:
Enabled: true
Lint/SelfAssignment:
Enabled: true
Lint/StructNewOverride:
Enabled: true
Lint/SymbolConversion:
Enabled: true
Lint/ToEnumArguments:
Enabled: false
Lint/TopLevelReturnWithArgument:
Enabled: true
Lint/TrailingCommaInAttributeDeclaration:
Enabled: true
Lint/TripleQuotes:
Enabled: true
Lint/UnexpectedBlockArity:
Enabled: true
Lint/UnmodifiedReduceAccumulator:
Enabled: true
Lint/UnreachableCode:
Severity: error
Lint/UnreachableLoop:
Enabled: true
Lint/UselessMethodDefinition:
Enabled: true
Lint/UselessRuby2Keywords:
Enabled: true
Lint/UselessTimes:
Enabled: true
Lint/Void:
Exclude:
- lib/jekyll/site.rb
# Metrics cops
# ----------------------------------------
Metrics/AbcSize:
Max: 23
Metrics/BlockLength:
Exclude:
- lib/jekyll/configuration.rb
- rake/**/*.rake
- test/**/*.rb
Metrics/ClassLength:
Exclude:
- features/**/*.rb
- lib/jekyll/commands/serve.rb
- lib/jekyll/configuration.rb
- lib/jekyll/document.rb
- lib/jekyll/site.rb
- test/**/*.rb
Max: 240
Metrics/CollectionLiteralLength:
Enabled: true
Metrics/CyclomaticComplexity:
Exclude:
- lib/jekyll/commands/serve.rb
- lib/jekyll/utils.rb
Max: 11
Metrics/MethodLength:
CountComments: false
Max: 20
Severity: error
Metrics/ModuleLength:
Exclude:
- lib/jekyll/filters.rb
Max: 240
Metrics/ParameterLists:
Max: 4
Metrics/PerceivedComplexity:
Max: 13
# Minitest cops
# ----------------------------------------
Minitest/AssertEmptyLiteral:
Enabled: false
Minitest/AssertInDelta:
Enabled: true
Minitest/AssertKindOf:
Enabled: true
Minitest/AssertOperator:
Enabled: false
Minitest/AssertOutput:
Enabled: true
Minitest/AssertPathExists:
Enabled: true
Minitest/AssertPredicate:
Enabled: false
Minitest/AssertRaisesWithRegexpArgument:
Enabled: true
Minitest/AssertSame:
Enabled: true
Minitest/AssertSilent:
Enabled: true
Minitest/AssertWithExpectedArgument:
Enabled: true
Minitest/AssertionInLifecycleHook:
Enabled: true
Minitest/DuplicateTestRun:
Enabled: true
Minitest/EmptyLineBeforeAssertionMethods:
Enabled: false
Minitest/LifecycleHooksOrder:
Enabled: true
Minitest/LiteralAsActualArgument:
Enabled: true
Minitest/MultipleAssertions:
Enabled: true
Minitest/NonExecutableTestMethod:
Enabled: true
Minitest/NonPublicTestMethod:
Enabled: true
Minitest/RedundantMessageArgument:
Enabled: true
Minitest/RefuteInDelta:
Enabled: true
Minitest/RefuteKindOf:
Enabled: true
Minitest/RefuteOperator:
Enabled: false
Minitest/RefutePathExists:
Enabled: true
Minitest/RefutePredicate:
Enabled: false
Minitest/RefuteSame:
Enabled: true
Minitest/ReturnInTestMethod:
Enabled: true
Minitest/SkipEnsure:
Enabled: true
Minitest/SkipWithoutReason:
Enabled: true
Minitest/TestFileName:
Enabled: true
Exclude:
- test/helper.rb
Minitest/TestMethodName:
Enabled: false
Minitest/UnreachableAssertion:
Enabled: true
Minitest/UnspecifiedException:
Enabled: true
Minitest/UselessAssertion:
Enabled: true
# Naming cops
# ----------------------------------------
Naming/FileName:
Enabled: false
Naming/HeredocDelimiterNaming:
Exclude:
- test/**/*.rb
Naming/MemoizedInstanceVariableName:
Exclude:
- lib/jekyll/convertible.rb
- lib/jekyll/drops/site_drop.rb
- lib/jekyll/drops/unified_payload_drop.rb
- lib/jekyll/page_without_a_file.rb
# Performance cops
# ----------------------------------------
Performance/AncestorsInclude:
Enabled: false
Performance/ArraySemiInfiniteRangeSlice:
Enabled: true
Performance/BigDecimalWithNumericArgument:
Enabled: true
Performance/BlockGivenWithExplicitBlock:
Enabled: true
Performance/ChainArrayAllocation:
Enabled: true
Performance/CollectionLiteralInLoop:
Enabled: true
Performance/ConstantRegexp:
Enabled: true
Performance/MapCompact:
Enabled: true
Performance/MapMethodChain:
Enabled: true
Performance/MethodObjectAsBlock:
Enabled: true
Performance/RedundantEqualityComparisonBlock:
Enabled: false
Performance/RedundantSortBlock:
Enabled: true
Performance/RedundantSplitRegexpArgument:
Enabled: true
Performance/RedundantStringChars:
Enabled: true
Performance/ReverseFirst:
Enabled: true
Performance/SortReverse:
Enabled: false
Performance/Squeeze:
Enabled: true
Performance/StringIdentifierArgument:
Enabled: true
Performance/StringInclude:
Enabled: true
Exclude:
- lib/jekyll/utils/platforms.rb
Performance/Sum:
Enabled: true
# Security cops
# ----------------------------------------
Security/CompoundHash:
Enabled: true
Security/IoMethods:
Enabled: true
Security/MarshalLoad:
Exclude:
- lib/jekyll/regenerator.rb
- test/**/*.rb
Security/YAMLLoad:
Exclude:
- features/**/*.rb
- test/**/*.rb
# Style cops
# ----------------------------------------
Style/AccessModifierDeclarations:
Enabled: false
Style/AccessorGrouping:
Enabled: true
Style/Alias:
EnforcedStyle: prefer_alias_method
Style/AndOr:
Severity: error
Style/ArgumentsForwarding:
Enabled: false
Style/ArrayCoercion:
Enabled: true
Style/ArrayIntersect:
Enabled: true
Style/BisectedAttrAccessor:
Enabled: true
Style/CaseLikeIf:
Enabled: true
Style/ClassAndModuleChildren:
Exclude:
- test/**/*.rb
Style/ClassEqualityComparison:
Enabled: true
Style/CollectionCompact:
Enabled: true
Style/CombinableLoops:
Enabled: true
Style/ConcatArrayLiterals:
Enabled: true
Style/DirEmpty:
Enabled: true
Style/DocumentDynamicEvalDefinition:
Enabled: true
Style/Documentation:
Enabled: false
Style/DoubleNegation:
Enabled: false
Style/EmptyHeredoc:
Enabled: true
Style/EndlessMethod:
Enabled: true
Style/EnvHome:
Enabled: true
Style/ExactRegexpMatch:
Enabled: true
Style/ExplicitBlockArgument:
Enabled: false
Style/ExponentialNotation:
Enabled: true
Style/FetchEnvVar:
Enabled: false
Style/FileEmpty:
Enabled: true
Style/FileRead:
Enabled: false
Style/FileWrite:
Enabled: true
Style/FormatStringToken:
Exclude:
- lib/jekyll/liquid_renderer/table.rb
- lib/jekyll/profiler.rb
- lib/jekyll/utils/ansi.rb
Style/FrozenStringLiteralComment:
EnforcedStyle: always
Style/GlobalStdStream:
Enabled: true
Style/GuardClause:
Enabled: false
Style/HashAsLastArrayItem:
Enabled: true
Style/HashConversion:
Enabled: true
Style/HashEachMethods:
Enabled: true
Style/HashExcept:
Enabled: true
Style/HashLikeCase:
Enabled: true
Style/HashSyntax:
EnforcedStyle: hash_rockets
Severity: error
Style/HashTransformKeys:
Enabled: false
Style/HashTransformValues:
Enabled: true
Style/IfWithBooleanLiteralBranches:
Enabled: true
Style/KeywordParametersOrder:
Enabled: true
Style/MagicCommentFormat:
Enabled: true
Style/MapCompactWithConditionalBlock:
Enabled: true
Style/MapToHash:
Enabled: true
Style/MinMaxComparison:
Enabled: true
Style/MixinUsage:
Exclude:
- test/helper.rb
Style/ModuleFunction:
Enabled: false
Style/MultilineTernaryOperator:
Severity: error
Style/NegatedIfElseCondition:
Enabled: true
Style/NestedFileDirname:
Enabled: true
Style/NilLambda:
Enabled: true
Style/ObjectThen:
Enabled: true
Style/OperatorMethodCall:
Enabled: true
Style/OptionalBooleanParameter:
Enabled: true
Exclude:
- lib/jekyll/log_adapter.rb
Style/PercentLiteralDelimiters:
PreferredDelimiters:
"%Q": "{}"
"%W": "()"
"%q": "{}"
"%r": "!!"
"%s": "()"
"%w": "()"
"%x": "()"
Style/QuotedSymbols:
Enabled: true
Style/RedundantArgument:
Enabled: true
Style/RedundantArrayConstructor:
Enabled: true
Style/RedundantAssignment:
Enabled: true
Style/RedundantConstantBase:
Enabled: true
Style/RedundantCurrentDirectoryInPath:
Enabled: true
Style/RedundantDoubleSplatHashBraces:
Enabled: true
Style/RedundantEach:
Enabled: true
Style/RedundantFetchBlock:
Enabled: false
Style/RedundantFileExtensionInRequire:
Enabled: true
Style/RedundantFilterChain:
Enabled: true
Style/RedundantHeredocDelimiterQuotes:
Enabled: true
Style/RedundantInitialize:
Enabled: true
Exclude:
- lib/jekyll/plugin.rb
Style/RedundantLineContinuation:
Enabled: true
Style/RedundantRegexpArgument:
Enabled: true
Style/RedundantRegexpCharacterClass:
Enabled: true
Style/RedundantRegexpConstructor:
Enabled: true
Style/RedundantRegexpEscape:
Enabled: true
Style/RedundantSelfAssignment:
Enabled: true
Style/RedundantSelfAssignmentBranch:
Enabled: true
Style/RedundantStringEscape:
Enabled: true
Style/RegexpLiteral:
EnforcedStyle: percent_r
Style/RescueModifier:
Enabled: false
Style/ReturnNilInPredicateMethodDefinition:
Enabled: true
Style/SafeNavigation:
Exclude:
- lib/jekyll/document.rb
- lib/jekyll/page.rb
Style/SignalException:
EnforcedStyle: only_raise
Style/SingleArgumentDig:
Enabled: true
Style/SingleLineDoEndBlock:
Enabled: true
Style/SlicingWithRange:
Enabled: false
Style/SoleNestedConditional:
Enabled: true
Style/StringChars:
Enabled: true
Style/StringConcatenation:
Enabled: true
Exclude:
- lib/jekyll/commands/*.rb
- test/**/*.rb
Style/StringLiterals:
EnforcedStyle: double_quotes
Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes
Style/SwapValues:
Enabled: true
Style/SymbolArray:
EnforcedStyle: brackets
Style/TrailingCommaInArrayLiteral:
EnforcedStyleForMultiline: consistent_comma
Style/TrailingCommaInHashLiteral:
EnforcedStyleForMultiline: consistent_comma

25
.rubocop_todo.yml Normal file
View File

@@ -0,0 +1,25 @@
# This configuration was generated by
# `rubocop --auto-gen-config --auto-gen-only-exclude`
# on 2022-04-06 10:48:47 UTC using RuboCop version 1.26.1.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
# versions of RuboCop, may require this file to be generated again.
# Offense count: 1
# This cop supports safe auto-correction (--auto-correct).
Performance/BindCall:
Exclude:
- 'test/helper.rb'
# Offense count: 1
Style/CombinableLoops:
Exclude:
- 'lib/jekyll/tags/post_url.rb'
# Offense count: 1
# Configuration parameters: AllowedMethods.
# AllowedMethods: respond_to_missing?
Style/OptionalBooleanParameter:
Exclude:
- 'lib/jekyll/log_adapter.rb'

128
404.html
View File

@@ -1,128 +0,0 @@
<!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>

49
Earthfile Normal file
View File

@@ -0,0 +1,49 @@
FROM alpine
# Run locally: `earthly +all` to run full CI process
all:
BUILD --build-arg RUBY=3.0 +test
BUILD --build-arg RUBY=2.7 +test
BUILD --build-arg RUBY=2.5 +test
BUILD --build-arg RUBY=jruby:9.2.14.0 +test
BUILD style-check
BUILD profile-docs
# Run locally: `earthly +test`
# Run with specific version: `earthly --build-arg RUBY=2.5 +test`
test:
FROM +deps
RUN script/test
RUN script/cucumber
RUN script/default-site
style-check:
FROM +deps
RUN script/fmt
profile-docs:
FROM +deps
RUN bundle install --jobs 4
RUN script/profile-docs
RUN script/memprof
# Install dependencies and copy in source
# used in above steps
deps:
ARG RUBY=3.0
IF case $RUBY in jruby*) ;; *) false; esac
FROM $RUBY
ENV JRUBY_OPTS="--dev -J-XX:+TieredCompilation -J-XX:TieredStopAtLevel=1 -J-XX:CompileThreshold=10 -J-XX:ReservedCodeCacheSize=128M"
ELSE
FROM ruby:$RUBY
END
WORKDIR /src
RUN apt-get update && apt-get install nodejs dnsutils git make coreutils g++ build-essential -y
RUN gem install bundler
RUN gem install sassc -v '2.4.0' --source 'https://rubygems.org/'
COPY Gemfile .
COPY jekyll.gemspec .
COPY lib/jekyll/version.rb lib/jekyll/version.rb
COPY test test
RUN bundle install --jobs 4
COPY . .

122
Gemfile Normal file
View File

@@ -0,0 +1,122 @@
# frozen_string_literal: true
source "https://rubygems.org"
gemspec :name => "jekyll"
gem "rake", "~> 13.0"
group :development do
gem "launchy", "~> 2.3"
gem "pry"
gem "pry-byebug" unless RUBY_ENGINE == "jruby"
end
#
group :test do
gem "activesupport", "< 7.1.0"
gem "cucumber", "~> 9.0"
gem "httpclient"
gem "jekyll_test_plugin"
gem "jekyll_test_plugin_malicious"
gem "memory_profiler"
# Runtime dependency of gem `httpclient`. _Needed only in Ruby 3.4+_.
# Remove once gem `httpclient` ships with `mutex_m` listed as a dependency in its gemspec.
gem "mutex_m", "~> 0.3" if RUBY_VERSION >= "3.4"
gem "nokogiri", "~> 1.7"
gem "rspec"
gem "rspec-mocks"
gem "rubocop", "~> 1.57.2"
gem "rubocop-minitest"
gem "rubocop-performance"
gem "rubocop-rake"
gem "rubocop-rspec"
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 "test-theme-skinny", :path => File.expand_path("test/fixtures/test-theme-skinny", __dir__)
gem "test-theme-symlink", :path => File.expand_path("test/fixtures/test-theme-symlink", __dir__)
gem "test-theme-w-empty-data", :path => File.expand_path("test/fixtures/test-theme-w-empty-data", __dir__)
if RUBY_ENGINE == "jruby"
gem "http_parser.rb", "~> 0.6.0"
gem "jruby-openssl"
end
end
#
group :test_legacy do
gem "test-unit" if RUBY_PLATFORM =~ %r!cygwin!
gem "minitest"
gem "minitest-profile"
gem "minitest-reporters"
gem "shoulda-context"
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 "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-syntax-coderay"
gem "matrix"
gem "mime-types", "~> 3.0"
gem "tomlrb"
platforms :ruby, :mswin, :mingw, :x64_mingw do
gem "classifier-reborn", "~> 2.2"
gem "liquid-c", "~> 4.0"
gem "yajl-ruby", "~> 1.4"
end
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library
platforms :jruby, :mswin, :mingw, :x64_mingw do
gem "tzinfo", ENV["TZINFO_VERSION"] if ENV["TZINFO_VERSION"]
gem "tzinfo-data"
end
end
#
group :rdoc, :optional => true do
# 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.
gem "psych", "~> 4.0"
gem "rdoc", "~> 6.0"
end
#
group :site do
gem "html-proofer", "~> 3.4" if ENV["PROOF"]
gem "jekyll-avatar"
gem "jekyll-mentions"
gem "jekyll-seo-tag"
gem "jekyll-sitemap"
gem "jemoji"
end

4194
History.markdown Normal file

File diff suppressed because it is too large Load Diff

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2008-present 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.

82
README.markdown Normal file
View File

@@ -0,0 +1,82 @@
# [Jekyll](https://jekyllrb.com/)
[![Gem Version](https://img.shields.io/gem/v/jekyll.svg)][ruby-gems]
[![Build Status](https://github.com/jekyll/jekyll/workflows/Continuous%20Integration/badge.svg)][ci-workflow]
[![Backers on Open Collective](https://opencollective.com/jekyll/backers/badge.svg)](#backers)
[![Sponsors on Open Collective](https://opencollective.com/jekyll/sponsors/badge.svg)](#sponsors)
[ruby-gems]: https://rubygems.org/gems/jekyll
[ci-workflow]: https://github.com/jekyll/jekyll/actions?query=workflow%3A%22Continuous+Integration%22+branch%3Amaster
[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](https://jekyllrb.com/philosophy)
## 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://github.com/jekyll/jekyll/wiki/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/) and [`#jekyll` Channel on Libera IRC](https://libera.chat)
## Diving In
* [Migrate](https://import.jekyllrb.com/docs/home/) from your previous system
* Learn how [Front Matter](https://jekyllrb.com/docs/front-matter/) 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
* Watch [video tutorials from Giraffe Academy](https://jekyllrb.com/tutorials/video-walkthroughs/)
## Need help?
If you don't find the answer to your problem in our [docs](https://jekyllrb.com/docs/), or in the [troubleshooting section](https://jekyllrb.com/docs/troubleshooting/), ask the [community](https://jekyllrb.com/docs/community/) for help.
## Code of Conduct
In order to have a more open and welcoming community, Jekyll adheres to a
[code of conduct](https://jekyllrb.com/docs/conduct/) adapted from the Ruby on Rails code of
conduct.
Please adhere to this code of conduct in any interactions you have in the
Jekyll community. It is strictly enforced on all official Jekyll
repositories, websites, and resources. If you encounter someone violating
these terms, please let one of our [core team members](https://jekyllrb.com/team/#core-team) know and we will address it as soon as possible.
## Credits
### Sponsors
Support this project by becoming a sponsor. Your logo will show up in this README with a link to your website. [Become a sponsor!](https://opencollective.com/jekyll#sponsor)
[![Jekyll Sponsor 0](https://opencollective.com/jekyll/sponsor/0/avatar.svg)](https://opencollective.com/jekyll/sponsor/0/website)
[![Jekyll Sponsor 1](https://opencollective.com/jekyll/sponsor/1/avatar.svg)](https://opencollective.com/jekyll/sponsor/1/website)
[![Jekyll Sponsor 2](https://opencollective.com/jekyll/sponsor/2/avatar.svg)](https://opencollective.com/jekyll/sponsor/2/website)
[![Jekyll Sponsor 3](https://opencollective.com/jekyll/sponsor/3/avatar.svg)](https://opencollective.com/jekyll/sponsor/3/website)
[![Jekyll Sponsor 4](https://opencollective.com/jekyll/sponsor/4/avatar.svg)](https://opencollective.com/jekyll/sponsor/4/website)
[![Jekyll Sponsor 5](https://opencollective.com/jekyll/sponsor/5/avatar.svg)](https://opencollective.com/jekyll/sponsor/5/website)
[![Jekyll Sponsor 6](https://opencollective.com/jekyll/sponsor/6/avatar.svg)](https://opencollective.com/jekyll/sponsor/6/website)
[![Jekyll Sponsor 7](https://opencollective.com/jekyll/sponsor/7/avatar.svg)](https://opencollective.com/jekyll/sponsor/7/website)
[![Jekyll Sponsor 8](https://opencollective.com/jekyll/sponsor/8/avatar.svg)](https://opencollective.com/jekyll/sponsor/8/website)
[![Jekyll Sponsor 9](https://opencollective.com/jekyll/sponsor/9/avatar.svg)](https://opencollective.com/jekyll/sponsor/9/website)
### Contributors
This project exists thanks to all the people who contribute.
[![Jekyll Contributors](https://opencollective.com/jekyll/contributors.svg?width=890&&avatarHeight=24&limit=100&button=false)](../../graphs/contributors)
### Backers
Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/jekyll#backer)
[![Jekyll Backers](https://opencollective.com/jekyll/backers.svg?width=890)](https://opencollective.com/jekyll#backers)
## License
See the [LICENSE](https://github.com/jekyll/jekyll/blob/master/LICENSE) file.

171
Rakefile Normal file
View File

@@ -0,0 +1,171 @@
# 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"
require "bundler/gem_tasks"
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)
# Normalize both old-style indented bullets (" *") and
# release-please-style non-indented bullets ("*") to "-"
markdown.gsub(%r!\n\s{0,2}\*{1}!, "\n-")
end
def linkify_prs(markdown)
# Match bare PR references like #1234 but skip those already linkified
# by release-please as [#1234](url)
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)
# Match old format: "X.Y.Z / YYYY-MM-DD"
# Match new release-please format: "[X.Y.Z](compare-url) (YYYY-MM-DD)"
header_regexp = %r!^(?:\[?)(\d{1,2})\.(\d{1,2})\.(\d{1,2})(?:\]\([^)]*\))? [\(/]\s?\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)
# Match both old format "## X.Y.Z" and release-please format "## [X.Y.Z]"
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 -r ./lib/#{name}.rb"
end

21
benchmark/capture-assign.rb Executable file
View File

@@ -0,0 +1,21 @@
#!/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

101
benchmark/conditional_liquid.rb Executable file
View File

@@ -0,0 +1,101 @@
#!/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

16
benchmark/end-with-vs-regexp Executable file
View File

@@ -0,0 +1,16 @@
#!/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

@@ -0,0 +1,54 @@
#!/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

@@ -0,0 +1,49 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require 'benchmark/ips'
require_relative '../lib/jekyll'
puts ''
print 'Setting up... '
SITE = Jekyll::Site.new(
Jekyll.configuration({
"source" => File.expand_path("../docs", __dir__),
"destination" => File.expand_path("../docs/_site", __dir__),
"disable_disk_cache" => true,
"quiet" => true,
})
)
TEMPLATE_1 = Liquid::Template.parse(<<~HTML)
{%- assign doc = site.documents | where: 'url', '/docs/assets/' | first -%}
{{- doc.title -}}
HTML
TEMPLATE_2 = Liquid::Template.parse(<<~HTML)
{%- assign doc = site.documents | find: 'url', '/docs/assets/' -%}
{{- doc.title -}}
HTML
[:reset, :read, :generate].each { |phase| SITE.send(phase) }
puts 'done.'
puts 'Testing... '
puts " #{'where + first'.cyan} results in #{TEMPLATE_1.render(SITE.site_payload).inspect.green}"
puts " #{'find'.cyan} results in #{TEMPLATE_2.render(SITE.site_payload).inspect.green}"
if TEMPLATE_1.render(SITE.site_payload) == TEMPLATE_2.render(SITE.site_payload)
puts 'Success! Proceeding to run benchmarks.'.green
puts ''
else
puts 'Something went wrong. Aborting.'.magenta
puts ''
return
end
Benchmark.ips do |x|
x.report('where + first') { TEMPLATE_1.render(SITE.site_payload) }
x.report('find') { TEMPLATE_2.render(SITE.site_payload) }
x.compare!
end

17
benchmark/flat-map Executable file
View File

@@ -0,0 +1,17 @@
#!/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

10
benchmark/hash-fetch Executable file
View File

@@ -0,0 +1,10 @@
#!/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

46
benchmark/jekyll-sanitize-path Executable file
View File

@@ -0,0 +1,46 @@
#!/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

29
benchmark/local-require Executable file
View File

@@ -0,0 +1,29 @@
#!/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

@@ -0,0 +1,33 @@
#!/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

25
benchmark/parse-date Executable file
View File

@@ -0,0 +1,25 @@
#!/usr/bin/env ruby
require_relative '../lib/jekyll'
require 'benchmark/ips'
date = "2014-08-02 14:43:06 PDT".freeze
time = Time.parse(date)
Benchmark.ips do |x|
x.report('Time.parse') do
Time.parse(date)
end
x.report('localtime') do
Time.parse(date).localtime
end
x.report('localtime parsed') do
time.localtime
end
x.report('Utils.parse_date') do
Jekyll::Utils.parse_date(date)
end
end

View File

@@ -0,0 +1,91 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
# For pull request: https://github.com/jekyll/jekyll/pull/8192
require 'benchmark/ips'
require 'bundler/setup'
require 'memory_profiler'
require 'jekyll'
CONTEXT = {"bar"=>"The quick brown fox"}
MARKUP_1 = %Q(foo=bar lorem="ipsum \\"dolor\\"" alpha='beta \\'gamma\\'').freeze
MARKUP_2 = %Q(foo=bar lorem="ipsum 'dolor'" alpha='beta "gamma"').freeze
#
def old_parse_params(markup)
params = {}
while (match = Jekyll::Tags::IncludeTag::VALID_SYNTAX.match(markup))
markup = markup[match.end(0)..-1]
value = if match[2]
match[2].gsub('\\"', '"')
elsif match[3]
match[3].gsub("\\'", "'")
elsif match[4]
CONTEXT[match[4]]
end
params[match[1]] = value
end
params
end
def new_parse_params(markup)
params = {}
markup.scan(Jekyll::Tags::IncludeTag::VALID_SYNTAX) do |key, d_quoted, s_quoted, variable|
value = if d_quoted
d_quoted.include?('\\"') ? d_quoted.gsub('\\"', '"') : d_quoted
elsif s_quoted
s_quoted.include?("\\'") ? s_quoted.gsub("\\'", "'") : s_quoted
elsif variable
CONTEXT[variable]
end
params[key] = value
end
params
end
#
def report(label, markup, color)
prof_report = MemoryProfiler.report { yield }
allocated_memory = prof_report.scale_bytes(prof_report.total_allocated_memsize)
allocated_objects = prof_report.total_allocated
retained_memory = prof_report.scale_bytes(prof_report.total_retained_memsize)
retained_objects = prof_report.total_retained
puts <<~MSG.send(color)
#{(label + " ").ljust(49, "-")}
MARKUP: #{markup}
RESULT: #{yield}
Total allocated: #{allocated_memory} (#{allocated_objects} objects)
Total retained: #{retained_memory} (#{retained_objects} objects)
MSG
end
report('old w/ escaping', MARKUP_1, :magenta) { old_parse_params(MARKUP_1) }
report('new w/ escaping', MARKUP_1, :cyan) { new_parse_params(MARKUP_1) }
report('old no escaping', MARKUP_2, :green) { old_parse_params(MARKUP_2) }
report('new no escaping', MARKUP_2, :yellow) { new_parse_params(MARKUP_2) }
#
Benchmark.ips do |x|
x.report("old + esc".magenta) { old_parse_params(MARKUP_1) }
x.report("new + esc".cyan) { new_parse_params(MARKUP_1) }
x.compare!
end
Benchmark.ips do |x|
x.report("old - esc".green) { old_parse_params(MARKUP_2) }
x.report("new - esc".yellow) { new_parse_params(MARKUP_2) }
x.compare!
end

65
benchmark/path-manager.rb Normal file
View File

@@ -0,0 +1,65 @@
# frozen_string_literal: true
require 'benchmark/ips'
require 'jekyll'
class FooPage
def initialize(dir:, name:)
@dir = dir
@name = name
end
def slow_path
File.join(*[@dir, @name].map(&:to_s).reject(&:empty?)).sub(%r!\A/!, "")
end
def fast_path
Jekyll::PathManager.join(@dir, @name).sub(%r!\A/!, "")
end
end
nil_page = FooPage.new(:dir => nil, :name => nil)
empty_page = FooPage.new(:dir => "", :name => "")
root_page = FooPage.new(:dir => "", :name => "ipsum.md")
nested_page = FooPage.new(:dir => "lorem", :name => "ipsum.md")
slashed_page = FooPage.new(:dir => "/lorem/", :name => "/ipsum.md")
if nil_page.slow_path == nil_page.fast_path
Benchmark.ips do |x|
x.report('nil_page slow') { nil_page.slow_path }
x.report('nil_page fast') { nil_page.fast_path }
x.compare!
end
end
if empty_page.slow_path == empty_page.fast_path
Benchmark.ips do |x|
x.report('empty_page slow') { empty_page.slow_path }
x.report('empty_page fast') { empty_page.fast_path }
x.compare!
end
end
if root_page.slow_path == root_page.fast_path
Benchmark.ips do |x|
x.report('root_page slow') { root_page.slow_path }
x.report('root_page fast') { root_page.fast_path }
x.compare!
end
end
if nested_page.slow_path == nested_page.fast_path
Benchmark.ips do |x|
x.report('nested_page slow') { nested_page.slow_path }
x.report('nested_page fast') { nested_page.fast_path }
x.compare!
end
end
if slashed_page.slow_path == slashed_page.fast_path
Benchmark.ips do |x|
x.report('slashed_page slow') { slashed_page.slow_path }
x.report('slashed_page fast') { slashed_page.fast_path }
x.compare!
end
end

15
benchmark/proc-call-vs-yield Executable file
View File

@@ -0,0 +1,15 @@
#!/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

51
benchmark/regexp-vs-include.rb Executable file
View File

@@ -0,0 +1,51 @@
#!/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

26
benchmark/sanitize-url.rb Executable file
View File

@@ -0,0 +1,26 @@
#!/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

@@ -0,0 +1,110 @@
#!/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!
def property(property, meta_key)
Benchmark.ips do |x|
x.config(time: 10, warmup: 5)
x.report("sort_by_property_directly with #{property} property") do
sort_by_property_directly(site_docs, meta_key)
end
x.report("schwartzian_transform with #{property} property") do
schwartzian_transform(site_docs, meta_key)
end
x.compare!
end
end
# First, test with a property only a handful of documents have.
test_property('sparse', 'redirect_from')
# Next, test with a property they all have.
test_property('non-sparse', 'title')

12
benchmark/sequential-assignment Executable file
View File

@@ -0,0 +1,12 @@
#!/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

@@ -0,0 +1,83 @@
#!/usr/bin/env ruby
# frozen_string_literal: true
require "forwardable"
require "colorator"
require "liquid"
require "benchmark/ips"
require "memory_profiler"
# Set up (memory) profiler
class Profiler
def self.run
yield new(ARGV[0] || 10_000)
end
def initialize(count)
@count = count.to_i
end
def report(label, color, &block)
prof_report = MemoryProfiler.report { @count.to_i.times(&block) }
allocated_memory = prof_report.scale_bytes(prof_report.total_allocated_memsize)
allocated_objects = prof_report.total_allocated
retained_memory = prof_report.scale_bytes(prof_report.total_retained_memsize)
retained_objects = prof_report.total_retained
puts <<~MSG.send(color)
With #{label} calls
Total allocated: #{allocated_memory} (#{allocated_objects} objects)
Total retained: #{retained_memory} (#{retained_objects} objects)
MSG
end
end
# Set up stage
class Drop < Liquid::Drop
def initialize(obj)
@obj = obj
end
end
class ForwardDrop < Drop
extend Forwardable
def_delegators :@obj, :name
end
class StaticDrop < Drop
def name
@obj.name
end
end
class Document
def name
"lipsum"
end
end
# Set up actors
document = Document.new
alpha = ForwardDrop.new(document)
beta = StaticDrop.new(document)
count = ARGV[0] || 10_000
# Run profilers
puts "\nMemory profiles for #{count} calls to invoke drop key:"
Profiler.run do |x|
x.report("forwarded", :cyan) { alpha["name"] }
x.report("static", :green) { beta["name"] }
end
# Benchmark
puts "\nBenchmarking the two scenarios..."
Benchmark.ips do |x|
x.report("forwarded".cyan) { alpha["name"] }
x.report("static".green) { beta["name"] }
x.compare!
end

9
benchmark/string-concat Executable file
View File

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

14
benchmark/string-replacement Executable file
View File

@@ -0,0 +1,14 @@
#!/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

7
benchmark/symbol-to-proc Executable file
View File

@@ -0,0 +1,7 @@
#!/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

View File

@@ -1,11 +0,0 @@
<!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>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

5
docs/.gitignore vendored Normal file
View File

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

View File

65
docs/_config.yml Normal file
View File

@@ -0,0 +1,65 @@
---
version: 4.4.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
site_branch: master
timezone: America/Los_Angeles
twitter:
username: jekyllrb
logo: "/img/logo-2x.png"
google_analytics_id: UA-50755011-1
google_site_verification: onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY
cloudinary_url: https://res.cloudinary.com/jekyll/image/upload/f_auto,q_auto,w_404
collections:
docs:
permalink: "/:collection/:path/"
output: true
posts:
permalink: "/news/:year/:month/:day/:title/"
output: true
tutorials:
permalink: "/:collection/:path/"
output: true
defaults:
- scope:
path: _docs
type: docs
values:
layout: docs
- scope:
path: _posts
type: posts
values:
layout: news_item
- scope:
path: _tutorials
type: tutorials
values:
layout: tutorials
- scope:
path: ''
values:
image: "/img/jekyll-og.png"
future: true
plugins:
- jekyll-avatar
- jekyll-feed
- jekyll-mentions
- jekyll-redirect-from
- jekyll-seo-tag
- jekyll-sitemap
- jemoji
feed:
categories:
- release
kramdown:
syntax_highlighter_opts:
default_lang: plaintext
sass:
style: compressed
strict_front_matter: true
exclude:
- icomoon-selection.json
- readme.md

View File

@@ -0,0 +1,140 @@
- name: Regeneration
description: Enable auto-regeneration of the site when files are modified.
flag: "-w, --[no-]watch"
- name: Configuration
description: >-
Specify config files instead of using <code>_config.yml</code> automatically.
Settings in later files override settings in earlier files.
flag: "--config FILE1[,FILE2,...]"
- name: Plugins
description: >-
Specify plugin directories instead of using <code>_plugins/</code> automatically.
option: "plugins_dir: [ DIR1,... ]"
flag: "-p, --plugins DIR1[,DIR2,...]"
- name: Layouts
description: >-
Specify layout directory instead of using <code>_layouts/</code> automatically.
option: "layouts_dir: DIR"
flag: --layouts DIR
- name: Drafts
description: Process and render draft posts.
option: "show_drafts: BOOL"
flag: -D, --drafts
- name: Environment
description: Use a specific environment value in the build.
flag: JEKYLL_ENV=production
- name: Future
description: Publish posts or collection documents with a future date.
option: "future: BOOL"
flag: --future
- name: Unpublished
description: Render posts that were marked as unpublished.
option: "unpublished: BOOL"
flag: --unpublished
- name: LSI
description: >-
Produce an index for related posts. Requires the
<a href="https://jekyll.github.io/classifier-reborn/">classifier-reborn</a> plugin.
option: "lsi: BOOL"
flag: --lsi
- name: Limit posts
description: Limit the number of posts to parse and publish.
option: "limit_posts: NUM"
flag: --limit_posts NUM
- name: Force polling
description: Force watch to use polling.
option: "force_polling: BOOL"
flag: --force_polling
- name: Verbose output
description: Print verbose output.
option: "verbose: BOOL"
flag: -V, --verbose
- name: Silence output
description: Silence the normal output from Jekyll during a build.
option: "quiet: BOOL"
flag: -q, --quiet
- name: Log level
description: Specify a log level among debug, info, warn, or error.
flag: JEKYLL_LOG_LEVEL=info
- name: Incremental build
description: >-
Enable the experimental
<a href="/docs/configuration/incremental-regeneration/">incremental
build</a> 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.
option: "incremental: BOOL"
flag: -I, --incremental
- name: Disable bundle require
description: Disables the need to require gems in `:jekyll_plugins` Gemfile
flag: JEKYLL_NO_BUNDLER_REQUIRE=true
- name: Liquid profiler
description: Generate a Liquid rendering profile to help you identify performance bottlenecks.
option: "profile: BOOL"
flag: --profile
- name: Strict front matter
description: Cause a build to fail if there is a YAML syntax error in a page's front matter.
option: "strict_front_matter: BOOL"
flag: --strict_front_matter
- name: Web Domain URL
option: "url: SCHEME://HOST[:PORT]"
description: >-
The canonical URL of the root of your production deploy, composed of the following components:<br>
&nbsp; &nbsp;• &nbsp; Protocol scheme (e.g. <code>http://</code>)<br>
&nbsp; &nbsp;• &nbsp; Hostname or IP address (e.g. <code>example.org</code>)<br>
&nbsp; &nbsp;• &nbsp; <em>(Optional)</em> The port number of the server, prefixed with a colon
(e.g. <code>:8080</code>)<br>
The value of this configuration option should NOT have a trailing slash. It will be appended
with the <code>baseurl</code> to form the full URL to your Jekyll site when using the
<a href="/docs/liquid/filters/">Liquid filter <code>absolute_url</code></a>.<br>
<strong>NOTE:</strong> This setting is automatically configured to the <strong>localhost URL</strong>
when the <code>jekyll serve</code> command is invoked.
- name: Base URL
description: >-
Serve the website from the given base URL (the path between web-server or domain root and your landing
page).
option: "baseurl: /PATH/TO/SITE"
flag: -b, --baseurl /PATH/TO/SITE
- name: Trace
description: Show the full backtrace when an error occurs.
flag: -t, --trace

View File

@@ -0,0 +1,108 @@
- name: Site source
description: Change the directory where Jekyll will read files
option: "source: DIR"
flag: -s, --source DIR
- name: Site destination
description: Change the directory where Jekyll will write files
option: "destination: DIR"
flag: -d, --destination DIR
- name: Safe
description: >-
Disable <a href="/docs/plugins/">non-whitelisted plugins</a>, caching to disk, and ignore symbolic links.
option: "safe: BOOL"
flag: --safe
- name: Disable disk cache
version-badge: 4.1.0
description: >-
Disable caching of content to disk in order to skip creating a <code>.jekyll-cache</code> or similar directory at
the source to avoid interference with virtual environments and third-party directory watchers. Caching to disk is
always disabled in <code>safe</code> mode.
option: "disable_disk_cache: BOOL"
flag: --disable-disk-cache
- name: Ignore theme configuration
version-badge: 4.1.0
description: >-
Jekyll 4.0 started allowing themes to bundle a <code>_config.yml</code> to simplify theme-onboarding for new users.
In the unfortunate situation that importing a bundled theme configuration messes up the merged site-configuration,
the user can configure Jekyll to not import the theme-config entirely.
option: "ignore_theme_config: BOOL"
- name: Exclude
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.
<br />
This configuration option supports Ruby's <a href="https://ruby-doc.org/3.3.5/File.html#method-c-fnmatch">
<code>File.fnmatch</code> filename globbing patterns</a> to match multiple entries to exclude. For example,
you can exclude multiple README.md files in your source tree from being included in your site by specifying the
following <code>exclude</code> option entries: <code>["README.md", "**/README.md"]</code>.
<br />
In Jekyll 3, the <code>exclude</code> configuration option replaces the default exclusion list.
<br />
In Jekyll 4, user-provided entries get added to the default exclusion list instead and the <code>include</code>
option can be used to override the default exclusion list entries.
<br />
The default exclusions are found in <code>_config.yml</code> as created by <code>jekyll new</code>:
<ul>
<li><code>.sass-cache/</code></li>
<li><code>.jekyll-cache/</code></li>
<li><code>gemfiles/</code></li>
<li><code>Gemfile</code></li>
<li><code>Gemfile.lock</code></li>
<li><code>node_modules/</code></li>
<li><code>vendor/bundle/</code></li>
<li><code>vendor/cache/</code></li>
<li><code>vendor/gems/</code></li>
<li><code>vendor/ruby/</code></li>
</ul>
option: "exclude: [DIR, FILE, ...]"
- name: Include
description: >-
Force inclusion of directories and/or files in the conversion. <code>.htaccess</code> is a good example since
dotfiles are excluded by default.
<br>
This configuration option supports Ruby's <a href="https://ruby-doc.org/3.3.5/File.html#method-c-fnmatch-3F">
<code>File.fnmatch</code> filename globbing patterns</a> to match multiple entries to include, refer the
<code>exclude</code> configuration option for more information.
<br>
With Jekyll 4, the <code>include</code> configuration option entries override the <code>exclude</code> option
entries.
option: "include: [DIR, FILE, ...]"
- name: Keep files
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>.
option: "keep_files: [DIR, FILE, ...]"
- name: Time zone
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.
option: "timezone: TIMEZONE"
- name: Encoding
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>.
option: "encoding: ENCODING"

View File

@@ -0,0 +1,80 @@
- name: Local server port
description: Listen on the given port. The default is `4000`.
option: "port: PORT"
flag: "-P, --port PORT"
- name: Local server hostname
description: Listen at the given hostname. The default is `localhost`.
option: "host: HOSTNAME"
flag: "-H, --host HOSTNAME"
- name: Live reload
description: Reload a page automatically on the browser when its content is edited.
option: "livereload: BOOL"
flag: "-l, --livereload"
- name: Live reload ignore
description: >-
File glob patterns for LiveReload to ignore.<br /><br />
Ensure that patterns are quoted when passed via the command-line to deter your shell from
expanding them.<br /><br /><strong>Note:</strong> The given glob patterns are matched against
the <code>relative_path</code> attribute of the processed resource. In the event Jekyll
reloads a <em>relative_path</em> matching the pattern in spite of being quoted, try listing
the pattern(s) under the config file option key.
option: "livereload_ignore: [ GLOB1,... ]"
flag: "--livereload-ignore GLOB1[,GLOB2,...]"
- name: Live reload min/max delay
description: Minimum/Maximum delay before automatically reloading page.
options:
- "livereload_min_delay: SECONDS"
- "livereload_max_delay: SECONDS"
flags:
- "--livereload-min-delay SECONDS"
- "--livereload-max-delay SECONDS"
- name: Live reload port
description: >-
Port for LiveReload to listen on.<br/><em>Ability to override via config file introduced in
<span class="version-badge">4.4.0</span></em>.
option: "livereload_port: PORT"
flag: "--livereload-port PORT"
- name: Open URL
description: Open the site's URL in the browser.
option: "open_url: BOOL"
flag: "-o, --open-url"
- name: Detach
description: Detach the server from the terminal.
option: "detach: BOOL"
flag: "-B, --detach"
- name: Skips the initial site build
description: Skips the initial site build which occurs before the server is started.
option: "skip_initial_build: BOOL"
flag: "--skip-initial-build"
- name: Show directory listing
description: Show a directory listing instead of loading your index file.
option: "show_dir_listing: BOOL"
flag: "--show-dir-listing"
- name: X.509 (SSL) private key
description: "SSL Private Key, stored or symlinked in the site source."
flag: "--ssl-key"
- name: X.509 (SSL) certificate
description: "SSL Public certificate, stored or symlinked in the site source."
flag: "--ssl-cert"

37
docs/_data/docs_nav.yml Normal file
View File

@@ -0,0 +1,37 @@
- title: Getting Started
docs:
- link: /docs/
- link: /docs/installation/
- link: /docs/ruby-101/
- link: /docs/community/
- link: /docs/step-by-step/01-setup/
- title: Build
docs:
- link: /docs/usage/
- link: /docs/configuration/
- link: /docs/rendering-process/
- title: Content
docs:
- link: /docs/pages/
- link: /docs/posts/
- link: /docs/front-matter/
- link: /docs/collections/
- link: /docs/datafiles/
- link: /docs/assets/
- link: /docs/static-files/
- title: Site Structure
docs:
- link: /docs/structure/
- link: /docs/liquid/
- link: /docs/variables/
- link: /docs/includes/
- link: /docs/layouts/
- link: /docs/permalinks/
- link: /docs/themes/
- link: /docs/pagination/
- title: Guides
docs:
- link: /docs/plugins/
- link: /docs/migrations/
- link: /docs/upgrading/
- link: /docs/deployment/

View File

@@ -0,0 +1,348 @@
#
# ---------------------------------------------------------------------------------------
# List of Liquid Filters provided by Jekyll Core that will be utilized for their
# documentation.
#
# To document a new filter, create a new "list-item" below with the following keys:
# name: : [REQUIRED] A string label that identifies the filter
# description: : [REQUIRED] A short description of what to expect from the filter
# version_badge: : [OPTIONAL] Jekyll version that introduced the filter
# examples: : [REQUIRED] A 'nested list' comprised of inputs and outputs
# input: : [REQUIRED] The filter syntax and usage
# output: : [OPTIONAL] The output from the filter
#
# Tip: Use YAML Block notations to "fold" a long string, or to "break" a long string
# to the following line. Block notations can also be used to avoid having to use
# backslashes to escape quotes.
# ---------------------------------------------------------------------------------------
#
- name: Relative URL
description: >-
Prepend <code>baseurl</code> config value to the input to convert a URL path into a relative URL.
This is recommended for a site that is hosted on a subpath of a domain.
examples:
- input: '{{ "/assets/style.css" | relative_url }}'
output: '/my-baseurl/assets/style.css'
#
- name: Absolute URL
description: >-
Prepend <code>url</code> and <code>baseurl</code> values to the input to convert a URL path to an absolute URL.
examples:
- input: '{{ "/assets/style.css" | absolute_url }}'
output: 'http://example.com/my-baseurl/assets/style.css'
#
- name: Date to XML Schema
description: Convert a Date into XML Schema (ISO 8601) format.
examples:
- input: '{{ site.time | date_to_xmlschema }}'
output: '2008-11-07T13:07:54-08:00'
#
- name: Date to RFC-822 Format
description: Convert a Date into the RFC-822 format used for RSS feeds.
examples:
- input: '{{ site.time | date_to_rfc822 }}'
output: 'Mon, 07 Nov 2008 13:07:54 -0800'
#
- name: Date to String
description: Convert a date to short format.
examples:
- input: '{{ site.time | date_to_string }}'
output: '07 Nov 2008'
#
- name: Date to String in ordinal US style
description: 'Format a date to ordinal, US, short format.'
version_badge: 3.8.0
examples:
- input: '{{ site.time | date_to_string: "ordinal", "US" }}'
output: 'Nov 7th, 2008'
#
- name: Date to Long String
description: Format a date to long format.
examples:
- input: '{{ site.time | date_to_long_string }}'
output: '07 November 2008'
#
- name: Date to Long String in ordinal UK style
description: 'Format a date to ordinal, UK, long format.'
version_badge: 3.8.0
examples:
- input: '{{ site.time | date_to_long_string: "ordinal" }}'
output: '7th November 2008'
#
- name: Where
description: Select all the objects in an array where the key has the given value.
examples:
- input: '{{ site.members | where:"graduation_year","2014" }}'
output:
#
- name: Where Expression
description: Select all the objects in an array where the expression is true.
version_badge: 3.2.0
examples:
- input: |-
{{ site.members | where_exp:"item",
"item.graduation_year == 2014" }}
output:
- input: |-
{{ site.members | where_exp:"item",
"item.graduation_year < 2014" }}
output:
- input: |-
{{ site.members | where_exp:"item",
"item.projects contains 'foo'" }}
output:
#
- name: Find
description: >-
Return <strong>the first object</strong> in an array for which the queried
attribute has the given value or return <code>nil</code> if no item in
the array satisfies the given criteria.
version_badge: 4.1.0
examples:
- input: '{{ site.members | find: "graduation_year", "2014" }}'
output:
#
- name: Find Expression
description: >-
Return <strong>the first object</strong> in an array for which the given
expression evaluates to true or return <code>nil</code> if no item in
the array satisfies the evaluated expression.
version_badge: 4.1.0
examples:
- input: |-
{{ site.members | find_exp:"item",
"item.graduation_year == 2014" }}
output:
- input: |-
{{ site.members | find_exp:"item",
"item.graduation_year < 2014" }}
output:
- input: |-
{{ site.members | find_exp:"item",
"item.projects contains 'foo'" }}
output:
#
- name: Group By
description: Group an array's items by a given property.
examples:
- input: '{{ site.members | group_by:"graduation_year" }}'
output: |-
[{"name"=>"2013", "items"=>[...]},
{"name"=>"2014", "items"=>[...]}]
#
- name: Group By Expression
description: Group an array's items using a Liquid expression.
version_badge: 3.4.0
examples:
- input: |-
{{ site.members | group_by_exp: "item",
"item.graduation_year | truncate: 3, ''" }}
output: |-
[{"name"=>"201", "items"=>[...]},
{"name"=>"200", "items"=>[...]}]
#
- name: XML Escape
description: Escape some text for use in XML.
examples:
- input: '{{ page.content | xml_escape }}'
output:
#
- name: CGI Escape
description: >-
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.
examples:
- input: '{{ "foo, bar; baz?" | cgi_escape }}'
output: 'foo%2C+bar%3B+baz%3F'
#
- name: URI Escape
description: >-
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.
examples:
- input: '{{ "http://foo.com/?q=foo, \bar?" | uri_escape }}'
output: 'http://foo.com/?q=foo,%20%5Cbar?'
#
- name: Number of Words
description: >-
Count the number of words in some text.<br/>
From <span class="version-badge">v4.1.0</span>, this filter takes an optional
argument to control the handling of Chinese-Japanese-Korean (CJK) characters
in the <code>input</code> string.<br/>
Passing <code>'cjk'</code> as the argument will count every CJK character
detected as one word irrespective of being separated by whitespace.<br/>
Passing <code>'auto'</code> (auto-detect) works similar to <code>'cjk'</code>
but is more performant if the filter is used on a variable string that may
or may not contain CJK chars.
examples:
- input: '{{ "Hello world!" | number_of_words }}'
output: 2
- input: '{{ "你好hello世界world" | number_of_words }}'
output: 1
- input: '{{ "你好hello世界world" | number_of_words: "cjk" }}'
output: 6
- input: '{{ "你好hello世界world" | number_of_words: "auto" }}'
output: 6
#
- name: Array to Sentence
description: >-
Convert an array into a sentence. Useful for listing tags.
Optional argument for connector.
examples:
- input: '{{ page.tags | array_to_sentence_string }}'
output: 'foo, bar, and baz'
- input: '{{ page.tags | array_to_sentence_string: "or" }}'
output: 'foo, bar, or baz'
#
- name: Markdownify
description: Convert a Markdown-formatted string into HTML.
examples:
- input: '{{ page.excerpt | markdownify }}'
output:
#
- name: Smartify
description: 'Convert "quotes" into &ldquo;smart quotes.&rdquo;'
examples:
- input: '{{ page.title | smartify }}'
output:
#
- name: Converting Sass/SCSS
description: Convert a Sass- or SCSS-formatted string into CSS.
examples:
- input: '{{ some_sass | sassify }}'
output:
- input: '{{ some_scss | scssify }}'
output:
#
- name: Slugify
description: Convert a string into a lowercase URL "slug". See below for options.
examples:
- input: '{{ "The _config.yml file" | slugify }}'
output: 'the-config-yml-file'
- input: '{{ "The _config.yml file" | slugify: "pretty" }}'
output: 'the-_config.yml-file'
- input: '{{ "The _cönfig.yml file" | slugify: "ascii" }}'
output: 'the-c-nfig-yml-file'
- input: '{{ "The cönfig.yml file" | slugify: "latin" }}'
output: 'the-config-yml-file'
#
- name: Data To JSON
description: Convert Hash or Array to JSON.
examples:
- input: '{{ site.data.projects | jsonify }}'
output:
#
- name: Normalize Whitespace
description: Replace any occurrence of whitespace with a single space.
examples:
- input: '{{ "a \n b" | normalize_whitespace }}'
output:
#
- name: Sort
description: >-
Sort an array. Optional arguments for hashes
1.&nbsp;property name
2.&nbsp;nils order (<em>first</em> or <em>last</em>).
examples:
- input: '{{ page.tags | sort }}'
output:
- input: '{{ site.posts | sort: "author" }}'
output:
- input: '{{ site.pages | sort: "title", "last" }}'
output:
#
- name: Sample
description: 'Pick a random value from an array. Optionally, pick multiple values.'
examples:
- input: '{{ site.pages | sample }}'
output:
- input: '{{ site.pages | sample: 2 }}'
output:
#
- name: To Integer
description: Convert a string or boolean to integer.
examples:
- input: '{{ some_var | to_integer }}'
output:
#
- name: Array Filters
description: >-
Push, pop, shift, and unshift elements from an Array.
These are <strong>NON-DESTRUCTIVE</strong>, i.e. they do not mutate the array,
but rather make a copy and mutate that.
examples:
- input: '{{ page.tags | push: "Spokane" }}'
output: '["Seattle", "Tacoma", "Spokane"]'
- input: '{{ page.tags | pop }}'
output: '["Seattle"]'
- input: '{{ page.tags | shift }}'
output: '["Tacoma"]'
- input: '{{ page.tags | unshift: "Olympia" }}'
output: '["Olympia", "Seattle", "Tacoma"]'
#
- name: Inspect
description: Convert an object into its String representation for debugging.
examples:
- input: '{{ some_var | inspect }}'
output:

View File

@@ -0,0 +1,223 @@
# Variables provided by Jekyll core
#
# name: : name of the variable
# description: : content returned by the variable
global:
- name: site
description: >-
Site wide information + configuration settings from <code>_config.yml</code>.
See below for details.
- name: page
description: >-
Page specific information + the <a href="/docs/front-matter/">front matter</a>.
Custom variables set via the front matter will be available here. See below for details.
- name: layout
description: >-
Layout specific information + the <a href="/docs/front-matter/">front matter</a>.
Custom variables set via front matter in layouts will be available here.
- name: jekyll
description: >-
Jekyll-centric information will be available here. See below for details.
- name: theme
description: >-
Theme-gem specific information as defined in the theme's gemspec. Useful for rendering
information in the theme demo's "About" page, for example. See below for details.
- name: content
description: >-
In layout files, the rendered content of the Post or Page being wrapped.
Not defined in Post or Page files.
- name: paginator
description: >-
When the <code>paginate</code> configuration option is set, this variable becomes available
for use. See <a href="../pagination/">Pagination</a> for details.
site:
- name: site.time
description: >-
The current time (when you run the <code>jekyll</code> command).
- name: site.pages
description: >-
A list of all Pages.
- name: site.posts
description: >-
A reverse chronological list of all Posts.
- name: site.related_posts
description: >-
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.
- name: site.static_files
description: >-
A list of all <a href="/docs/static-files/">static files</a> (i.e.
files not processed by Jekyll's converters or the Liquid renderer).
Each file has five properties: <code>path</code>, <code>modified_time</code>,
<code>name</code>, <code>basename</code> and <code>extname</code>.
- name: site.html_pages
description: >-
A subset of <code>site.pages</code> listing those which end in <code>.html</code>.
- name: site.html_files
description: >-
A subset of <code>site.static_files</code> listing those which end in <code>.html</code>.
- name: site.collections
description: >-
A list of all the collections (including posts).
- name: site.data
description: >-
A list containing the data loaded from the YAML files located in the <code>_data</code>
directory.
- name: site.documents
description: >-
A list of all the documents in every collection.
- name: site.categories.CATEGORY
description: >-
The list of all Posts in category <code>CATEGORY</code>.
- name: site.tags.TAG
description: >-
The list of all Posts with tag <code>TAG</code>.
- name: site.url
description: >-
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/2016/10/06/jekyll-3-3-is-here/#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>.
- name: "site.[CONFIGURATION_DATA]"
description: >-
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.
page:
- name: page.content
description: >-
The content of the Page, rendered or un-rendered depending upon what Liquid is being processed
and what <code>page</code> is.
- name: page.title
description: >-
The title of the Page or Document resource.
- name: page.excerpt
description: >-
The un-rendered excerpt of a Page or Document. Can be overridden in the
<a href="/docs/front-matter/">front matter</a>. It can either be disabled atomically for
certain page or document by setting an empty string to an <code>excerpt_separator</code> key in
the front matter of desired resource or disabled site-wide by setting the same as a top-level
key in the config file.
- name: page.url
description: >-
The URL of the Post without the domain, but with a leading slash, e.g.
<code>/2008/12/14/my-post.html</code>
- name: page.date
description: >-
The Date assigned to the Post. This can be overridden in a Post's 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>). Not applicable to Pages.
- name: page.id
description: >-
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>. Not applicable to
Pages.
- name: page.categories
description: >-
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="/docs/front-matter/">front matter</a>. Note: Path-based categories may not work for
documents in user-defined collections.
- name: page.collection
description: >-
The label of the collection to which a Document belongs. e.g. <code>posts</code> for a post, or
<code>puppies</code> for a document at path <code>_puppies/rover.md</code>. If not part of a
collection, an empty string is returned.
- name: page.tags
description: >-
The list of tags to which this post belongs. These can be specified in the
<a href="/docs/front-matter/">front matter</a>.
- name: page.dir
description: >-
The path between the source directory and the file of a page, e.g. <code>/pages/</code> when the page
is at path <code>pages/about.md</code> relative to the source directory. This is derived from the
<code>url</code> attribute of the page and can therefore be overridden via the <code>permalink</code>
key in the <a href="/docs/front-matter/">front matter</a>. NOTE: This variable is not applicable to
posts and documents in user-defined collections. Use the <code>categories</code> variable to get similar
info for posts.
- name: page.name
description: >-
The filename of the post or page, e.g. <code>about.md</code>
- name: page.path
description: >-
The path to the raw post or page, relative to the source directory. Example usage: Using a combination
of the repository's blob URL and this page variable to get the full URL to the file in the repository.
This can be overridden in the <a href="/docs/front-matter/">front matter</a>.
- name: page.slug
description: >-
The filename of a Document resource without its extension (or date prefixes for a post). For example,
slug for a post at URL <code>/2017/02/22/my-new-post.html</code>, would be <code>my-new-post</code>.
Can be overridden in the <a href="/docs/front-matter/">front matter</a>.
- name: page.ext
description: >-
The file extension of a Document resource. For example, <code>.html</code>. Can be overridden in the
<a href="/docs/front-matter/">front matter</a>.
- name: page.next
description: >-
The next post relative to the position of the current post in <code>site.posts</code>.
Returns <code>nil</code> for the last entry.
- name: page.previous
description: >-
The previous post relative to the position of the current post in <code>site.posts</code>.
Returns <code>nil</code> for the first entry.
jekyll:
- name: jekyll.version
description: Version of Jekyll used to build the site.
- name: jekyll.environment
description: Value assigned to environment variable <code>JEKYLL_ENV</code> during a build.
theme:
- name: theme.root
description: >-
Absolute path to the theme-gem. Rendered only when environment variable <code>JEKYLL_ENV</code>
is set to <code>development</code>.
- name: theme.authors
description: Comma separated string composed of the authors of the theme-gem.
- name: theme.description
description: Description or summary of the theme-gem as specified in the theme gemspec.
- name: theme.version
description: The version string of current theme.
- name: theme.dependencies
description: List of runtime dependencies of the theme.
- name: theme.metadata
description: A mapping of key-value pairs as defined in the theme gemspec.
paginator:
- name: paginator.page
description: The number of the current page
- name: paginator.per_page
description: Number of posts per page
- name: paginator.posts
description: Posts available for the current page
- name: paginator.total_posts
description: Total number of posts
- name: paginator.total_pages
description: Total number of pages
- name: paginator.previous_page
description: >-
The number of the previous page, or <code>nil</code> if no previous page exists
- name: paginator.previous_page_path
description: >-
The path to the previous page, or <code>nil</code> if no previous page exists
- name: paginator.next_page
description: >-
The number of the next page, or <code>nil</code> if no subsequent page exists
- name: paginator.next_page_path
description: >-
The path to the next page, or <code>nil</code> if no subsequent page exists

View File

@@ -0,0 +1,209 @@
- 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: AmyJohnstonXL
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: juliodevrel
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: nilsbo
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
- speaker: Pieter Roozen
twitter_handle: Pieter_Roozen
youtube_id: moQP0SqEPsw
topic: Jekyll As An API Endpoint
year: 2019
- speaker: Chen Hui Jing
twitter_handle: hj_chen
youtube_id: CERXESTZ5w4
topic: Why I love Jekyll Data Files
year: 2019
- speaker: Chris Ferdinandi
twitter_handle: ChrisFerdinandi
youtube_id: vR1aI_kQ4-A
topic: The Lean Web
year: 2019
- speaker: Catherine Roebuck
twitter_handle:
youtube_id: zTAP1m1BaDM
topic: Jekyll For City Government
year: 2019
- speaker: Joost van der Schee
twitter_handle: jhvanderschee
youtube_id: ztJJ1GSlYgI
topic: "Jekyll Codex - Jekyll for front-end developers"
year: 2019
- speaker: Matthew Loberg
twitter_handle: mloberg
youtube_id: 6eiAjAtSGqw
topic: Leverage AWS S3 And CloudFront To Deploy Blazing Fast Jekyll Sites
year: 2019
- speaker: George Phillips
twitter_handle: gphillips_nz
youtube_id: nEvdOwFJBVc
topic: Structuring Jekyll Sites For Enterprise Design Systems
year: 2019

139
docs/_data/permalinks.yml Normal file
View File

@@ -0,0 +1,139 @@
placeholders:
- name: year
desc: >-
Year from the post's filename with four digits. May be overridden via the document's
<code>date</code> front matter.
- name: short_year
desc: >-
Year from the post's filename without the century. (00..99) May be overridden via the
document's <code>date</code> front matter.
- name: month
desc: >-
Month from the post's filename. (01..12) May be overridden via the document's
<code>date</code> front matter.
- name: i_month
desc: >-
Month without leading zeros from the post's filename. May be overridden via the document's
<code>date</code> front matter.
- name: short_month
desc: >-
Three-letter month abbreviation, e.g. "Jan".
- name: long_month
intro_ver: "4.0"
desc: >-
Full month name, e.g. "January".
- name: day
desc: >-
Day of the month from the post's filename. (01..31) May be overridden via the document's
<code>date</code> front matter.
- name: i_day
desc: >-
Day of the month without leading zeros from the post's filename. May be overridden via the
document's <code>date</code> front matter.
- name: y_day
desc: >-
Ordinal day of the year from the post's filename, with leading zeros. (001..366)
- name: w_year
intro_ver: "4.0"
desc: >-
Week year which may differ from the month year for up to three days at the start of January
and end of December
- name: week
intro_ver: "4.0"
desc: >-
Week number of the current year, starting with the first week having a majority of its days
in January. (01..53)
- name: w_day
intro_ver: "4.0"
desc: >-
Day of the week, starting with Monday. (1..7)
- name: short_day
intro_ver: "4.0"
desc: >-
Three-letter weekday abbreviation, e.g. "Sun".
- name: long_day
intro_ver: "4.0"
desc: >-
Weekday name, e.g. "Sunday".
- name: hour
desc: >-
Hour of the day, 24-hour clock, zero-padded from the post's <code>date</code> front matter. (00..23)
- name: minute
desc: >-
Minute of the hour from the post's <code>date</code> front matter. (00..59)
- name: second
desc: >-
Second of the minute from the post's <code>date</code> front matter. (00..59)
- name: title
desc: >-
Title from the document's filename. May be overridden via the document's
<code>slug</code> front matter. Preserves case from the source.
- name: slug
desc: >-
Slugified title from the document's filename (any character except numbers and letters is
replaced as hyphen). May be overridden via the document's <code>slug</code> front matter.
- name: categories
desc: >-
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.
- name: slugified_categories
intro_ver: "4.1"
desc: >-
The specified categories for this post but <em>slugified</em>. If a category is a composite of
multiple words, Jekyll will downcase all alphabets and replace any non-alphanumeric character
with a hyphen. (e.g. <code>"Work 2 Progress"</code> will be converted into
<code>"work-2-progress"</code>). If a post has multiple categories, Jekyll will create
a hierarchy (e.g. <code>/work-2-progress/category2</code>). Also Jekyll automatically parses
out double slashes in the URLs, so if no categories are present, it will ignore this.
- name: output_ext
desc: >-
Extension of the output file. (Included by default and usually unnecessary.)
builtin_formats:
- name: date
format: "/:categories/:year/:month/:day/:title:output_ext"
- name: pretty
format: "/:categories/:year/:month/:day/:title/"
- name: ordinal
format: "/:categories/:year/:y_day/:title:output_ext"
- name: weekdate
intro_ver: "4.0"
format: "/:categories/:year/W:week/:short_day/:title:output_ext"
note: "<code>W</code> will be prefixed to the value of <code>:week</code>"
- name: none
format: "/:categories/:title:output_ext"
types:
documents:
- name: collection
desc: >-
Label of the containing collection.
- name: path
desc: >-
Path to the document relative to the collection's directory, including base filename of the document.
However, does not include the file extension.
- name: name
desc: >-
The document's base filename but slugified: downcased and every sequence of non-alphanumeric character
(including spaces) replaced by a hyphen.
- name: title
desc: >-
Takes on the value of front matter key <code>slug</code> if defined for the document. Otherwise takes
on the string value generated from the document's base filename by piping through the <code>slugify</code>
filter method with <code>pretty</code> option.<br/>
Regardless of the value taken, the case of the alphabets are preserved instead of being replaced with
lowercase counterparts.
- name: output_ext
desc: >-
Extension of the output file. (Included by default and usually unnecessary.)
pages:
- name: path
desc: >-
Path between the source directory and the base filename of the page.
- name: basename
desc: >-
The page's base filename.
- name: output_ext
desc: >-
Extension of the output file. (Included by default and usually unnecessary.)

View File

@@ -0,0 +1,15 @@
- title: Home
link: /
show_on_mobile: true
- title: Docs
link: /docs/
show_on_mobile: true
- title: Resources
link: /resources/
show_on_mobile: true
- title: Showcase
link: /showcase/
show_on_mobile: false
- title: News
link: /news/
show_on_mobile: true

3
docs/_data/ruby.yml Normal file
View File

@@ -0,0 +1,3 @@
min_version: 2.7.0
current_version: 3.4.1
current_version_output: ruby 3.4.1 (2024-12-25 revision 48d4efcb85)

308
docs/_data/showcase.yml Normal file
View File

@@ -0,0 +1,308 @@
- name: Tom Preston Werner Blog
url: https://tom.preston-werner.com/
image: tom-preston-werner.png
categories:
- personal
- blog
# - name: White House Social and Behavioral Sciences Team
# url: https://sbst.gov/
# image: sbst.png
# categories:
# - government
- name: SiteLeaf
url: https://www.siteleaf.com/
image: siteleaf.png
categories:
- software
- marketing-site
- name: CloudCannon
url: https://cloudcannon.com/
image: cloudcannon.png
categories:
- software
- marketing-site
- name: Vesterheim Norwegian-American Museum
url: https://vesterheim.org/
image: vesterheim.png
categories:
- marketing-site
- name: KOTN
url: https://kotn.com/
image: kotn.png
categories:
- marketing-site
- name: MvvmCross
url: https://www.mvvmcross.com/
image: mvvm.png
categories:
- software
- marketing-site
- name: Vidgrid
url: https://www.vidgrid.com/
image: vidgrid.png
categories:
- software
- marketing-site
- name: Bitcoin
url: https://bitcoin.org/
image: bitcoin.png
categories:
- software
- marketing-site
- name: Mapwize
url: https://www.mapwize.io/
image: mapwize.png
categories:
- software
- marketing-site
- name: Auth0 Blog
url: https://auth0.com/blog/
image: auth0-blog.png
categories:
- software
- blog
- name: Freedom of Information Act
url: https://www.foia.gov/
image: foia-gov.png
categories:
- government
- name: "Art & About Sydney"
url: https://www.artandabout.com.au/
image: art-sydney.png
categories:
- government
- name: Passbolt Help
url: https://help.passbolt.com/
image: passbolt-help.png
categories:
- knowledgebase
- name: We are COLLINS
url: https://www.wearecollins.com/
image: collins.png
categories:
- agency
- name: Lightburn
url: https://lightburn.co/
image: lightburn.png
categories:
- agency
- name: italia.it
url: https://developers.italia.it/
image: italia-it.png
categories:
- community
- name: Sydney New Years Eve
url: https://www.sydneynewyearseve.com/
image: nsw.png
categories:
- government
- name: Login.gov
url: https://login.gov/
image: login-gov.png
categories:
- government
- name: plainlanguage.gov
url: https://plainlanguage.gov/
image: plainlanguage-gov.png
categories:
- government
- name: U.S. Web Design Standards
url: https://designsystem.digital.gov/
image: uswds.png
categories:
- government
- name: Grantmaker Search
url: https://www.grantmakers.io/
image: grantmakers.png
categories:
- marketing-site
- name: Rehan Butt
url: https://rehanbutt.com/
image: rehn.png
categories:
- personal
- portfolio
- name: The Markdown Guide
url: https://www.markdownguide.org/
image: markdown-guide.png
categories:
- knowledgebase
- name: Probot
url: https://probot.github.io/
image: probot.png
categories:
- documentation
- name: Matt Grey
url: https://himatt.com/
image: matt-grey.png
categories:
- personal
- portfolio
- name: Lattice
url: https://lattice.com/
image: lattice.png
categories:
- software
- marketing-site
- name: MailTape
url: https://www.mailta.pe/
image: mailtape.png
categories:
- other
- name: Digital Democracy
url: https://www.digital-democracy.org/
image: digital-democracy.png
categories:
- other
- name: HTML Reference
url: https://htmlreference.io/
image: htmlreference.png
categories:
- documentation
- name: CSS Reference
url: https://cssreference.io/
image: cssreference.png
categories:
- documentation
- name: Chain
url: https://www.chain.com/
image: chain.png
categories:
- marketing-site
- name: IBM MobileFirst Foundation
url: https://mobilefirstplatform.ibmcloud.com/
image: ibm-mobile-foundation.png
categories:
- documentation
- name: "18F"
url: https://18f.gsa.gov/
image: 18f.png
categories:
- agency
- government
- name: Development Seed
url: https://developmentseed.org/
image: development-seed.png
categories:
- agency
- name: Isomer - Singapore Government Static Websites
url: https://isomer.gov.sg/
image: isomer.png
categories:
- government
- name: French Government Digital Services
url: https://beta.gouv.fr/
image: beta-gouv-fr.png
categories:
- government
- name: Paris Call for Trust and Security in Cyberspace
url: https://pariscall.international/
image: appel-de-paris.png
categories:
- government
- name: TwitchCon
url: https://www.twitchcon.com/
image: twitchcon.png
categories:
- marketing-site
- conference
- name: UN World Statistics
url: https://worldstatisticsday.org/
image: world-statistics-day.png
categories:
- government
- name: Netflix Devices
url: https://devices.netflix.com/
image: netflix.png
categories:
- marketing-site
- name: Twitch Developer Documentation
url: https://dev.twitch.tv/
image: twitch-developers.png
categories:
- marketing-site
- documentation
- name: Yeoman
url: https://yeoman.io/
image: yeoman.png
categories:
- open-source
- marketing-site
- name: Release Management Blog
url: https://release.mozilla.org/
image: mozilla-release-blog.png
categories:
- software
- blog
- name: frame.ai
url: https://frame.ai/
image: frame-ai.png
categories:
- software
- marketing-site
- name: Spotify for Developers
url: https://developer.spotify.com
image: spotify-developers.png
categories:
- marketing-site
- documentation
- software
- name: Sketch
url: https://www.sketch.com/
image: sketch.png
categories:
- software
- marketing-site
- name: Ruby on Rails
url: https://rubyonrails.org/
image: ruby-on-rails.png
categories:
- marketing-site
- documentation

14
docs/_data/tutorials.yml Normal file
View File

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

94
docs/_docs/assets.md Normal file
View File

@@ -0,0 +1,94 @@
---
title: Assets
permalink: /docs/assets/
---
Jekyll provides built-in support for [Sass](https://sass-lang.com/)
and can work with [CoffeeScript](https://coffeescript.org/) 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/' | relative_url }}">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:
```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. Any files here should not contain the empty front matter as
described above. If they do, they'll not 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.
For more information on Sass configuration options, see the [Sass configuration]({{ '/docs/configuration/sass/' | relative_url }}) docs.
## 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

@@ -0,0 +1,82 @@
---
title: Code of Conduct
permalink: "/docs/code_of_conduct/"
note: This file is autogenerated. Edit /.github/CODE_OF_CONDUCT.markdown instead.
redirect_from: "/conduct/index.html"
editable: false
---
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [olivia@jekyllrb.com](mailto:olivia@jekyllrb.com). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

392
docs/_docs/collections.md Normal file
View File

@@ -0,0 +1,392 @@
---
title: Collections
permalink: /docs/collections/
---
Collections are a great way to group related content like members of a team or
talks at a conference.
## Setup
To use a Collection you first need to define it in your `_config.yml`. For
example here's a collection of staff members:
```yaml
collections:
- staff_members
```
In this case `collections` is defined as a sequence (i.e., array) with no additional metadata defined for each collection.
You can optionally specify metadata for your collection by defining `collections` as a mapping (i.e., hashmap) instead of sequence, and then defining additional fields in it:
```yaml
collections:
staff_members:
people: true
```
{: .note .info}
When defining a collection as a sequence, its pages will not be rendered by
default. To enable this, <code>output: true</code> must be specified on the
collection, which requires defining the collection as a mapping. For more
information, see the section <a href="#output">Output</a>.
<div class="note">
<h5>Gather your collections {%- include docs_version_badge.html version="3.7.0" -%}</h5>
<p>You can optionally specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>.</p>
<p>Then Jekyll will look in <code>my_collections/_books</code> for the <code>books</code> collection, and
in <code>my_collections/_recipes</code> for the <code>recipes</code> collection.</p>
</div>
<div class="note warning">
<h5>Be sure to move drafts and posts into custom collections directory</h5>
<p>If you specify a directory to store all your collections in the same place with <code>collections_dir: my_collections</code>, then you will need to move your <code>_drafts</code> and <code>_posts</code> directory to <code>my_collections/_drafts</code> and <code>my_collections/_posts</code>. Note that, the name of your collections directory cannot start with an underscore (`_`).</p>
</div>
## Add content
Create a corresponding folder (e.g. `<source>/_staff_members`) and add
documents. 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 front
matter is provided, Jekyll will consider it to be a [static file]({{ '/docs/static-files/' | relative_url }})
and the contents will not undergo further processing. If front matter is provided,
Jekyll will process the file contents into the expected output.
Regardless of whether front matter exists or not, Jekyll will write to the destination
directory (e.g. `_site`) only if `output: true` has been set in the collection's
metadata.
For example here's how you would add a staff member to the collection set above.
The filename is `./_staff_members/jane.md` with the following content:
```markdown
---
name: Jane Doe
position: Developer
---
Jane has worked on Jekyll for the past *five years*.
```
<em>
Do note that in spite of being considered as a collection internally, the above
doesn't apply to [posts](/docs/posts/). Posts with a valid filename format will be
marked for processing even if they do not contain front matter.
</em>
<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>
## Output
Now you can iterate over `site.staff_members` on a page and output the content
for each staff member. Similar to posts, the body of the document is accessed
using the `content` variable:
{% raw %}
```liquid
{% for staff_member in site.staff_members %}
<h2>{{ staff_member.name }} - {{ staff_member.position }}</h2>
<p>{{ staff_member.content | markdownify }}</p>
{% endfor %}
```
{% endraw %}
If you'd like Jekyll to create a rendered page for each document in your
collection, you can set the `output` key to `true` in your collection
metadata in `_config.yml`:
```yaml
collections:
staff_members:
output: true
```
You can link to the generated page using the `url` attribute:
{% raw %}
```liquid
{% for staff_member in site.staff_members %}
<h2>
<a href="{{ staff_member.url }}">
{{ staff_member.name }} - {{ staff_member.position }}
</a>
</h2>
<p>{{ staff_member.content | markdownify }}</p>
{% endfor %}
```
{% endraw %}
## Future
You can configure a collection to show future items by setting the `future` metadata to `true` in the collection's configuration.
```yaml
collections:
staff_members:
future: true
```
## Permalinks
There are special [permalink variables for collections]({{ '/docs/permalinks/#collections' | relative_url }}) to
help you control the output url for the entire collection.
## Custom Sorting of Documents {%- include docs_version_badge.html version="4.0" -%}
{: #custom-sorting-of-documents}
By default, two documents in a collection are sorted by their `date` attribute when both of them have the `date` key in their front matter. However, if either or both documents do not have the `date` key in their front matter, they are sorted by their respective paths.
You can control this sorting via the collection's metadata.
### Sort By Front Matter Key
Documents can be sorted based on a front matter key by setting a `sort_by` metadata to the front matter key string. For example,
to sort a collection of tutorials based on key `lesson`, the configuration would be:
```yaml
collections:
tutorials:
sort_by: lesson
```
The documents are arranged in the increasing order of the key's value. If a document does not have the front matter key defined
then that document is placed immediately after sorted documents. When multiple documents do not have the front matter key defined,
those documents are sorted by their dates or paths and then placed immediately after the sorted documents.
### Manually Ordering Documents
You can also manually order the documents by setting an `order` metadata with **the filenames listed** in the desired order.
For example, a collection of tutorials would be configured as:
```yaml
collections:
tutorials:
order:
- hello-world.md
- introduction.md
- basic-concepts.md
- advanced-concepts.md
```
Any documents with filenames that do not match the list entry simply gets placed after the rearranged documents. If a document is
nested under subdirectories, include them in entries as well:
```yaml
collections:
tutorials:
order:
- hello-world.md
- introduction.md
- concepts/basics.md
- concepts/advanced.md
```
If both metadata keys have been defined properly, `order` list takes precedence.
## Liquid Attributes
### Collections
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>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 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 front matter is
provided, Jekyll will not generate the file in your collection. If
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>

View File

@@ -0,0 +1,8 @@
---
title: Report a bug
permalink: "/docs/community/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).

View File

@@ -0,0 +1,44 @@
---
title: Community
permalink: /docs/community/
redirect_from: "/help/index.html"
---
## Jekyll Contributor 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.
Read the full [code of conduct]({{ '/docs/conduct/' | relative_url }})
## Reporting Security Vulnerabilities
Find something in our codebase that could be exploited by malicious elements?
Consult our [Security Policy]({{ '/docs/security/' | relative_url }}) to see if a product version is considered *outdated* and how to report
the situation responsibly.
## Where to get support
If you're looking for support for Jekyll, there are a lot of options:
* Read the [Jekyll Documentation]({{ '/docs/' | relative_url }})
* If you have a question about using Jekyll, start a discussion on the [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 #jekyll on [Libera](irc://irc.libera.chat/#jekyll).
There are a bunch of helpful community members on these services who are willing to point you in the right direction.
**Reminder: Jekyll's issue tracker is not a support forum.**
## Ways to contribute
* [How to Contribute]({{ '/docs/contributing/' | relative_url }})
* [How to file a bug]({{ '/docs/community/bug/' | relative_url }})
* [Guide for maintaining Jekyll]({{ '/docs/maintaining/' | relative_url }})
## Jekyllconf
[Watch videos]({{ '/jekyllconf/' | relative_url }}) from members of the Jekyll community speak about interesting use cases, tricks theyve learned or meta Jekyll topics.
## Jekyll on Twitter
The [official Jekyll Twitter account](https://twitter.com/jekyllrb).

82
docs/_docs/conduct.md Normal file
View File

@@ -0,0 +1,82 @@
---
title: Code of Conduct
permalink: "/docs/conduct/"
note: This file is autogenerated. Edit /CONDUCT.markdown instead.
redirect_from: "/conduct/index.html"
editable: false
---
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [olivia@jekyllrb.com](mailto:olivia@jekyllrb.com). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
[https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)

View File

@@ -0,0 +1,19 @@
---
title: Configuration
permalink: /docs/configuration/
---
Jekyll gives you a lot of flexibility to customize how it builds your site. These
options can either be specified in a `_config.yml` or `_config.toml` file placed
in your sites root directory, or can be specified as flags for the `jekyll`
executable in the terminal.
* [Configuration Options]({{ '/docs/configuration/options/' | relative_url }})
* [Default Configuration]({{ '/docs/configuration/default/' | relative_url }})
* [Front Matter Defaults]({{ '/docs/configuration/front-matter-defaults/' | relative_url }})
* [Environments]({{ '/docs/configuration/environments/' | relative_url }})
* [Markdown Options]({{ '/docs/configuration/markdown/' | relative_url }})
* [Liquid Options]({{ '/docs/configuration/liquid/' | relative_url }})
* [Sass/SCSS Options]({{ '/docs/configuration/sass/' | relative_url }})
* [Webrick Options]({{ '/docs/configuration/webrick/' | relative_url }})
* [Incremental Regeneration]({{ '/docs/configuration/incremental-regeneration/' | relative_url }})

View File

@@ -0,0 +1,89 @@
---
title: Default Configuration
permalink: "/docs/configuration/default/"
---
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 info">
<h5>Be aware of directory paths</h5>
<p>
In general, make directory path values in configuration keys like <code>plugins_dir</code> relative to the current working directory, not the site source. The <code>sass</code> configuration key is an exception, where values must be relative to the site source.
</p>
</div>
```yaml
# Where things are
source : .
destination : ./_site
collections_dir : .
plugins_dir : _plugins # takes an array of strings and loads plugins in that order
layouts_dir : _layouts
data_dir : _data
includes_dir : _includes
sass:
sass_dir: _sass
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, 2, 3, 4, 5, 6]
smart_quotes : lsquo,rsquo,ldquo,rdquo
input : GFM
hard_wrap : false
footnote_nr : 1
show_warnings : false
```

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