mirror of
https://github.com/jekyll/jekyll.git
synced 2026-04-28 03:01:03 -04:00
Compare commits
322 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cda8c3a402 | ||
|
|
5431c0945b | ||
|
|
e68b3e3e16 | ||
|
|
0cc09f93ca | ||
|
|
448b8b5540 | ||
|
|
2cf2665d31 | ||
|
|
efc2a7433c | ||
|
|
021f58506f | ||
|
|
d5e62d0ca5 | ||
|
|
6ea69cae2a | ||
|
|
8b759b9c71 | ||
|
|
32c90c5eee | ||
|
|
76572b421a | ||
|
|
409034449b | ||
|
|
2db7db7c44 | ||
|
|
dfa5f036f7 | ||
|
|
d20aef3c1c | ||
|
|
61c9708264 | ||
|
|
964a2689a1 | ||
|
|
98c14c0f2f | ||
|
|
74f0c4d079 | ||
|
|
3689b5bd97 | ||
|
|
092010703f | ||
|
|
1ffce1ed6b | ||
|
|
7072c65f6e | ||
|
|
094fc89d70 | ||
|
|
70e4e87945 | ||
|
|
0e4182aefa | ||
|
|
6a4a630bdf | ||
|
|
8e378c0615 | ||
|
|
6b0af7144d | ||
|
|
f93928ab2c | ||
|
|
0c4a453e2c | ||
|
|
44fc6803d2 | ||
|
|
5e1b6d3fae | ||
|
|
fce1966b3a | ||
|
|
8ba078f95d | ||
|
|
94192a3ab4 | ||
|
|
f8a456d16e | ||
|
|
0f03b31b85 | ||
|
|
27805c97ec | ||
|
|
e223b9e1e3 | ||
|
|
860c5d6394 | ||
|
|
ca57a45b17 | ||
|
|
94831d572d | ||
|
|
ef6ae0305e | ||
|
|
4ad5419d55 | ||
|
|
32074ef944 | ||
|
|
eba4dbcc72 | ||
|
|
5861d3ab28 | ||
|
|
17d1d9422b | ||
|
|
34e35284aa | ||
|
|
0629bba297 | ||
|
|
192360dd6a | ||
|
|
96a5c80b59 | ||
|
|
75d70a0ba8 | ||
|
|
bc443c2e66 | ||
|
|
0fde781f2b | ||
|
|
aa8c2466ca | ||
|
|
a5cf2f9a42 | ||
|
|
f63a68bedd | ||
|
|
753b8aaa09 | ||
|
|
c59e59091d | ||
|
|
f2980230e5 | ||
|
|
c458e1413a | ||
|
|
760eaf0274 | ||
|
|
0913d65793 | ||
|
|
a6739dcfd2 | ||
|
|
05ce2b2ab2 | ||
|
|
f95c5e45bb | ||
|
|
cd5b71ec88 | ||
|
|
e300964879 | ||
|
|
37b4a4bd89 | ||
|
|
3a8b2822f1 | ||
|
|
995c7c8d65 | ||
|
|
cde2de69a7 | ||
|
|
425ad79ff2 | ||
|
|
3283e679bc | ||
|
|
5947231337 | ||
|
|
2445bd946e | ||
|
|
a5460320c5 | ||
|
|
e55274d8f8 | ||
|
|
3d5e86eb08 | ||
|
|
885c98a32b | ||
|
|
60a9cd7356 | ||
|
|
822ac4fa47 | ||
|
|
e44b52d9f9 | ||
|
|
ed79646d7d | ||
|
|
1484c6d6a4 | ||
|
|
38a18af96a | ||
|
|
b6bbe1b469 | ||
|
|
ed30c864f2 | ||
|
|
1ad8c8dc04 | ||
|
|
28e10da266 | ||
|
|
c52149824d | ||
|
|
1f3c0dc0d4 | ||
|
|
96a4198c27 | ||
|
|
c85bd15340 | ||
|
|
dbbfc5d48c | ||
|
|
c7e9061da3 | ||
|
|
22c756a2e0 | ||
|
|
12ab35011f | ||
|
|
84a29bd142 | ||
|
|
860d730ff3 | ||
|
|
8f2b53172f | ||
|
|
b38b7a1479 | ||
|
|
db3437a34f | ||
|
|
42dd477f8a | ||
|
|
01da87c5f9 | ||
|
|
839007fa15 | ||
|
|
55e993be25 | ||
|
|
108c8419e3 | ||
|
|
25fd87c3e2 | ||
|
|
5ae029f9cd | ||
|
|
2ed5f33da6 | ||
|
|
3234c1a38a | ||
|
|
901256a42c | ||
|
|
b2e99a0e12 | ||
|
|
6c9611d90a | ||
|
|
6d2d29220c | ||
|
|
f9c2395a86 | ||
|
|
646b424166 | ||
|
|
432d0e3e7d | ||
|
|
0753e56ec7 | ||
|
|
52aab1bc10 | ||
|
|
3f3a283018 | ||
|
|
b427a17315 | ||
|
|
7a79d0ba0c | ||
|
|
537032c49d | ||
|
|
644a704ad5 | ||
|
|
4bfb4edc40 | ||
|
|
2be8e6ce4f | ||
|
|
cd4d84a44f | ||
|
|
77bea6951b | ||
|
|
d0afea2b03 | ||
|
|
e57890a290 | ||
|
|
c52bbde5ec | ||
|
|
e0c4640a7a | ||
|
|
d9df973d2c | ||
|
|
99f1a235ea | ||
|
|
a70f5cba65 | ||
|
|
8e4ccfc4ff | ||
|
|
3ba746c979 | ||
|
|
1d7236f2c2 | ||
|
|
d865905d66 | ||
|
|
65d7a09174 | ||
|
|
895a5033c0 | ||
|
|
96a640a8c9 | ||
|
|
0417baf058 | ||
|
|
d86ba153fe | ||
|
|
1fbd42ceeb | ||
|
|
0b1aaf5dc1 | ||
|
|
a385117f2c | ||
|
|
1e18bef7c0 | ||
|
|
4c882541d7 | ||
|
|
f8a3f9bb6a | ||
|
|
2277999f39 | ||
|
|
3198f2e922 | ||
|
|
71fe6aaa0a | ||
|
|
e90053e489 | ||
|
|
dafa28d40c | ||
|
|
e5c4948de6 | ||
|
|
8c4bed5e4f | ||
|
|
16fb63a326 | ||
|
|
0ab743204a | ||
|
|
21847cf798 | ||
|
|
76a9a194cf | ||
|
|
6ee39423cd | ||
|
|
e57c755c6f | ||
|
|
cb6676ba13 | ||
|
|
d99471332d | ||
|
|
a6b861cd95 | ||
|
|
dd4312270c | ||
|
|
aef05280c8 | ||
|
|
d04f1afc81 | ||
|
|
e2527eb872 | ||
|
|
fdb4c623ba | ||
|
|
0be06e5eb1 | ||
|
|
acae1e1ce8 | ||
|
|
07c8d98e88 | ||
|
|
11987c65e0 | ||
|
|
58a1f62b23 | ||
|
|
c6dfae56d0 | ||
|
|
bb954ff16e | ||
|
|
7785ef670f | ||
|
|
6bedc7e069 | ||
|
|
8c8c88eec0 | ||
|
|
d03742e994 | ||
|
|
052f1bd412 | ||
|
|
73fcc42353 | ||
|
|
ee2d299370 | ||
|
|
16a1e5cac4 | ||
|
|
ecf098580d | ||
|
|
0cbcf93779 | ||
|
|
56bbf58911 | ||
|
|
4ecbeb4063 | ||
|
|
66e6b2f2d3 | ||
|
|
7b6dc1f287 | ||
|
|
80f799b0b6 | ||
|
|
7047e7dfb4 | ||
|
|
c0ad3ac41e | ||
|
|
4cc1905ae3 | ||
|
|
c4af6efca9 | ||
|
|
e0cd941c09 | ||
|
|
e90fa179d4 | ||
|
|
ac4abbd14d | ||
|
|
2b590254a1 | ||
|
|
87dd43e654 | ||
|
|
ef62f7455c | ||
|
|
e793a96bda | ||
|
|
583da3491f | ||
|
|
2bd91fdd8c | ||
|
|
bf13d8dfbc | ||
|
|
0da02acdf8 | ||
|
|
67ab1be220 | ||
|
|
ff60d51c9b | ||
|
|
03db5267a3 | ||
|
|
c7e3e689e7 | ||
|
|
99a1b72493 | ||
|
|
bf8d50ee08 | ||
|
|
2aa2861a5d | ||
|
|
3a1848066b | ||
|
|
a891118af4 | ||
|
|
bfa7c94899 | ||
|
|
39ee3317f4 | ||
|
|
249101aea6 | ||
|
|
0951a4653d | ||
|
|
ee3576e2cb | ||
|
|
dbaca2c107 | ||
|
|
69839ba6dc | ||
|
|
548b9e9372 | ||
|
|
572c86ec13 | ||
|
|
fc75f5360d | ||
|
|
300668ed7f | ||
|
|
f1a20d0e22 | ||
|
|
4c1ab7f182 | ||
|
|
b2891a476e | ||
|
|
80fc7729ad | ||
|
|
82bb2714df | ||
|
|
d78c65f2c7 | ||
|
|
072808d953 | ||
|
|
bf67f086c4 | ||
|
|
0cf8533f61 | ||
|
|
ee29b05e80 | ||
|
|
3fded46fa9 | ||
|
|
581717cc41 | ||
|
|
66fe8b5f21 | ||
|
|
28a475a660 | ||
|
|
9301d53ca9 | ||
|
|
f40e5cff5f | ||
|
|
4c42559a51 | ||
|
|
645584824f | ||
|
|
48977ec304 | ||
|
|
7558ecb1f7 | ||
|
|
99cfe52cd8 | ||
|
|
94028e7f4c | ||
|
|
91e00b2082 | ||
|
|
8cc0640a68 | ||
|
|
28d4eacdcb | ||
|
|
eef8030950 | ||
|
|
5367a0261d | ||
|
|
04123c0cad | ||
|
|
7206b7f9ef | ||
|
|
390b1f006b | ||
|
|
556febb436 | ||
|
|
a613eb2d82 | ||
|
|
2b56ad4f6d | ||
|
|
9c2c01bb7a | ||
|
|
a81cd42768 | ||
|
|
b32293cf67 | ||
|
|
e27605e380 | ||
|
|
520326406c | ||
|
|
f030e55f70 | ||
|
|
6d3dc74c7d | ||
|
|
35e08eb9db | ||
|
|
03f7ddc801 | ||
|
|
3554b73b7f | ||
|
|
6903f0b0f4 | ||
|
|
bb851e235d | ||
|
|
5d5d975672 | ||
|
|
fe45439b6c | ||
|
|
823c8f94d2 | ||
|
|
2cc51e6aba | ||
|
|
160a6816af | ||
|
|
d45fb96477 | ||
|
|
daca7e53a1 | ||
|
|
e05a25a668 | ||
|
|
7a70a3ae5e | ||
|
|
1baded9acd | ||
|
|
1a3d85a8a5 | ||
|
|
b632afd2db | ||
|
|
d09c5105d7 | ||
|
|
6633fd2335 | ||
|
|
b8cf7cf96d | ||
|
|
5b64b27b2c | ||
|
|
d1e392f301 | ||
|
|
7d9b6403c0 | ||
|
|
911e249d72 | ||
|
|
d2c7c43c3f | ||
|
|
7a698d4d14 | ||
|
|
a03e972378 | ||
|
|
18e5e5223b | ||
|
|
3d23171d22 | ||
|
|
a0c6b4c595 | ||
|
|
66dd820648 | ||
|
|
25369429a7 | ||
|
|
8896e125ef | ||
|
|
4537ccac41 | ||
|
|
674bcfb37e | ||
|
|
0f5f5ba8d1 | ||
|
|
796ae15c31 | ||
|
|
d70ffd2a20 | ||
|
|
2c0e51330b | ||
|
|
ac93d22df1 | ||
|
|
124ce72be8 | ||
|
|
6077ed6a01 | ||
|
|
7c28eb5f7e | ||
|
|
c254533c3b | ||
|
|
64dbf46a3b | ||
|
|
1cde234d41 | ||
|
|
b02b070d86 | ||
|
|
3b3f845846 |
@@ -3,7 +3,7 @@
|
||||
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
|
||||
#-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
FROM ruby:2
|
||||
FROM ruby:3.0
|
||||
|
||||
# Avoid warnings by switching to noninteractive
|
||||
ENV DEBIAN_FRONTEND=noninteractive
|
||||
@@ -28,7 +28,7 @@ RUN apt-get update \
|
||||
#
|
||||
# Install node.js
|
||||
&& apt-get -y install curl software-properties-common \
|
||||
&& curl -sL https://deb.nodesource.com/setup_13.x | bash - \
|
||||
&& 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.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
// 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 2",
|
||||
"name": "Ruby 3",
|
||||
"dockerFile": "Dockerfile",
|
||||
|
||||
// Set *default* container specific settings.json values on container create.
|
||||
@@ -12,15 +12,15 @@
|
||||
// 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",
|
||||
"postCreateCommand": "bundle install"
|
||||
|
||||
// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
|
||||
// "remoteUser": "vscode"
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
2
.github/CODEOWNERS
vendored
2
.github/CODEOWNERS
vendored
@@ -65,8 +65,6 @@
|
||||
# @jekyll/stability
|
||||
Gemfile @jekyll/stability
|
||||
*.gemspec @jekyll/stability
|
||||
.travis.yml @jekyll/stability
|
||||
appveyor.yml @jekyll/stability
|
||||
/lib/jekyll/configuration.rb @jekyll/stability
|
||||
/lib/jekyll/deprecator.rb @jekyll/stability
|
||||
/lib/jekyll/frontmatter_defaults.rb @jekyll/stability
|
||||
|
||||
2
.github/CONTRIBUTING.markdown
vendored
2
.github/CONTRIBUTING.markdown
vendored
@@ -11,7 +11,7 @@ See the [support guidelines](https://jekyllrb.com/docs/support/)
|
||||
Whether you're a developer, a designer, or just a Jekyll devotee, there are lots of ways to contribute. Here's a few ideas:
|
||||
|
||||
- [Install Jekyll on your computer](https://jekyllrb.com/docs/installation/) and kick the tires. Does it work? Does it do what you'd expect? If not, [open an issue](https://github.com/jekyll/jekyll/issues/new) and let us know.
|
||||
- Comment on some of the project's [open issues](https://github.com/jekyll/jekyll/issues). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?
|
||||
- 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.
|
||||
|
||||
8
.github/actions/spelling/README.md
vendored
8
.github/actions/spelling/README.md
vendored
@@ -8,8 +8,10 @@ File | Purpose | Format | Info
|
||||
[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.txt](advice.txt) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
|
||||
[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 `.txt` extension) and
|
||||
then include multiple files (with a `.txt` extension) inside that directory to merge multiple files together.
|
||||
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.
|
||||
|
||||
35
.github/actions/spelling/advice.md
vendored
35
.github/actions/spelling/advice.md
vendored
@@ -1,28 +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>
|
||||
|
||||
<details><summary>If you see a bunch of garbage</summary>
|
||||
If items relate to a ...
|
||||
* binary file (or some other file you wouldn't want to check at all).
|
||||
|
||||
If it relates to a ...
|
||||
<details><summary>well-formed pattern</summary>
|
||||
Please add a file path to the `excludes.txt` file matching the containing file.
|
||||
|
||||
See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it.
|
||||
|
||||
If not, try writing one and 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>
|
||||
<details><summary>binary-ish string</summary>
|
||||
|
||||
Please add a file path to the `excludes.txt` file instead of just accepting the garbage.
|
||||
|
||||
File paths are Perl 5 Regular Expressions - you can [test](
|
||||
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](
|
||||
`^` 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).
|
||||
</details>
|
||||
|
||||
* 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>
|
||||
|
||||
17
.github/actions/spelling/allow.txt
vendored
17
.github/actions/spelling/allow.txt
vendored
@@ -0,0 +1,17 @@
|
||||
builtins
|
||||
github
|
||||
hakiri
|
||||
https
|
||||
Linting
|
||||
Microsoft
|
||||
ssh
|
||||
Statictastic
|
||||
statictastic
|
||||
ubuntu
|
||||
Wikipedia
|
||||
workaround
|
||||
workaround
|
||||
workarounds
|
||||
WSL
|
||||
decapcms
|
||||
tina
|
||||
|
||||
520
.github/actions/spelling/candidate.patterns
vendored
Normal file
520
.github/actions/spelling/candidate.patterns
vendored
Normal 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
|
||||
(['"]|")[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-)/
|
||||
39
.github/actions/spelling/excludes.txt
vendored
39
.github/actions/spelling/excludes.txt
vendored
@@ -2,6 +2,8 @@
|
||||
|
||||
(?:^|/)(?i)COPYRIGHT
|
||||
(?:^|/)(?i)LICEN[CS]E
|
||||
(?:^|/)3rdparty/
|
||||
(?:^|/)go\.sum$
|
||||
(?:^|/)package(?:-lock|)\.json$
|
||||
(?:^|/)vendor/
|
||||
|
||||
@@ -9,20 +11,52 @@
|
||||
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\.
|
||||
\.min\..
|
||||
\.mod$
|
||||
\.mp[34]$
|
||||
\.o$
|
||||
\.ocf$
|
||||
\.otf$
|
||||
\.pdf$
|
||||
\.pem$
|
||||
\.png$
|
||||
\.svg$
|
||||
\.psd$
|
||||
\.pyc$
|
||||
\.s$
|
||||
\.svgz?$
|
||||
\.tar$
|
||||
\.tiff?$
|
||||
\.ttf$
|
||||
\.wav$
|
||||
\.webm$
|
||||
\.webp$
|
||||
\.woff$
|
||||
\.woff2$
|
||||
\.xlsx?$
|
||||
\.zip$
|
||||
|
||||
^docs/pages/redirects/github\.html$
|
||||
^lib/jekyll/mime\.types$
|
||||
@@ -33,3 +67,4 @@ ignore$
|
||||
^test/fixtures/webrick/bar/foo\.xhtml$
|
||||
^test/source/_posts/2009-06-22-no-yaml\.markdown$
|
||||
^\.github/
|
||||
^\Q.github/workflows/spelling.yml\E$
|
||||
|
||||
320
.github/actions/spelling/expect.txt
vendored
320
.github/actions/spelling/expect.txt
vendored
@@ -1,56 +1,34 @@
|
||||
acl
|
||||
activesupport
|
||||
adaoraul
|
||||
addons
|
||||
aeiou
|
||||
AFile
|
||||
afterall
|
||||
Alexey
|
||||
alfredxing
|
||||
algolia
|
||||
allowfullscreen
|
||||
Anatoliy
|
||||
andreyvit
|
||||
Ankit
|
||||
Anning
|
||||
apps
|
||||
appveyor
|
||||
arengu
|
||||
args
|
||||
ariejan
|
||||
arounds
|
||||
asciinema
|
||||
asdf
|
||||
ashmaroli
|
||||
attr
|
||||
Autobuild
|
||||
autocompletion
|
||||
autogenerated
|
||||
Autolink
|
||||
autoload
|
||||
autoreconf
|
||||
autosave
|
||||
awood
|
||||
aws
|
||||
awscli
|
||||
backend
|
||||
backport
|
||||
backtick
|
||||
backticks
|
||||
barcamp
|
||||
baseurl
|
||||
bashrc
|
||||
baz
|
||||
bbatsov
|
||||
bdimcheff
|
||||
bellvat
|
||||
benbalter
|
||||
Beney
|
||||
binstubs
|
||||
bip
|
||||
bitbucket
|
||||
blog
|
||||
Blogger
|
||||
blogging
|
||||
blogs
|
||||
bonafide
|
||||
Bou
|
||||
breadcrumbs
|
||||
@@ -60,7 +38,7 @@ bridgetownrb
|
||||
brightbox
|
||||
brighterplanet
|
||||
buddyworks
|
||||
Bugfix
|
||||
builtatlightspeed
|
||||
Burela
|
||||
byparker
|
||||
cachegrind
|
||||
@@ -70,19 +48,11 @@ cartera
|
||||
cavalle
|
||||
CDNs
|
||||
cgi
|
||||
changefreq
|
||||
changelog
|
||||
chango
|
||||
charset
|
||||
Chayoung
|
||||
chcp
|
||||
chdir
|
||||
Cheatsheet
|
||||
Checkoway
|
||||
chmod
|
||||
chown
|
||||
Chrononaut
|
||||
chruby
|
||||
cibuild
|
||||
cimg
|
||||
circleci
|
||||
@@ -92,103 +62,62 @@ cloudcannon
|
||||
Cloudinary
|
||||
cloudsh
|
||||
CLT
|
||||
codebase
|
||||
codeclimate
|
||||
CODEOWNERS
|
||||
coderay
|
||||
codeslinger
|
||||
coffeescript
|
||||
colorator
|
||||
commandline
|
||||
commonmark
|
||||
compat
|
||||
compatibilize
|
||||
concat
|
||||
config
|
||||
configyml
|
||||
contentblocks
|
||||
CORS
|
||||
Cov
|
||||
CRLFs
|
||||
cron
|
||||
crontab
|
||||
cruft
|
||||
css
|
||||
csv
|
||||
Currin
|
||||
CVE
|
||||
CWD
|
||||
cygwin
|
||||
daringfireball
|
||||
Dassonville
|
||||
datafiles
|
||||
datetime
|
||||
DCEU
|
||||
Debian
|
||||
debuggability
|
||||
defunkt
|
||||
delegators
|
||||
deployer
|
||||
deps
|
||||
dest
|
||||
Devkit
|
||||
devops
|
||||
digitalocean
|
||||
dirs
|
||||
disqus
|
||||
ditaa
|
||||
dnf
|
||||
doclist
|
||||
doctype
|
||||
doeorg
|
||||
dommmel
|
||||
dotfile
|
||||
Dousse
|
||||
downcase
|
||||
downcased
|
||||
duckduckgo
|
||||
duritong
|
||||
Dusseau
|
||||
dysinger
|
||||
ecf
|
||||
editorconfig
|
||||
eduardoboucas
|
||||
Elasticsearch
|
||||
elsif
|
||||
Emacs
|
||||
emails
|
||||
emoji
|
||||
emojis
|
||||
endcapture
|
||||
endcomment
|
||||
endfor
|
||||
endhighlight
|
||||
endif
|
||||
endraw
|
||||
endrender
|
||||
endtablerow
|
||||
Enumerables
|
||||
EOL
|
||||
erb
|
||||
errordocument
|
||||
Espinaco
|
||||
eugenebolshakov
|
||||
evaled
|
||||
exe
|
||||
execjs
|
||||
extensionpack
|
||||
extname
|
||||
extnames
|
||||
exts
|
||||
favicon
|
||||
Fengyun
|
||||
ffi
|
||||
figcaption
|
||||
filesystem
|
||||
Finazzo
|
||||
firstimage
|
||||
FIXME
|
||||
flakey
|
||||
flickr
|
||||
fnmatch
|
||||
fontello
|
||||
forloop
|
||||
formcake
|
||||
@@ -199,86 +128,47 @@ formkeep
|
||||
formspark
|
||||
formspree
|
||||
formx
|
||||
Forwardable
|
||||
frameborder
|
||||
freenode
|
||||
frontmatter
|
||||
fsnotify
|
||||
ftp
|
||||
fullstory
|
||||
Gaudino
|
||||
gcc
|
||||
gcnovus
|
||||
gemfile
|
||||
gemset
|
||||
gemspec
|
||||
getform
|
||||
getset
|
||||
getsimpleform
|
||||
gettalong
|
||||
gfm
|
||||
ghp
|
||||
ghpages
|
||||
giraffeacademy
|
||||
github
|
||||
githubcom
|
||||
githubusercontent
|
||||
gitignore
|
||||
gitlab
|
||||
gjtorikian
|
||||
globbed
|
||||
globbing
|
||||
google
|
||||
gotcha
|
||||
Goulven
|
||||
gridism
|
||||
GSo
|
||||
gsub
|
||||
gsubbing
|
||||
Hakiri
|
||||
hardcode
|
||||
hashbang
|
||||
hashmap
|
||||
helaili
|
||||
henrik
|
||||
heredoc
|
||||
heroku
|
||||
highlighter
|
||||
hilighting
|
||||
Hoizey
|
||||
homepage
|
||||
hostman
|
||||
hostname
|
||||
href
|
||||
htaccess
|
||||
htm
|
||||
html
|
||||
htmlproofer
|
||||
http
|
||||
httpd
|
||||
httpdocs
|
||||
hyperlinks
|
||||
Iaa
|
||||
ial
|
||||
ico
|
||||
icomoon
|
||||
iconset
|
||||
ified
|
||||
iframe
|
||||
img
|
||||
Impl
|
||||
Inlining
|
||||
invokables
|
||||
irc
|
||||
ivey
|
||||
ize
|
||||
jalali
|
||||
jameshamann
|
||||
jamstackthemes
|
||||
jan
|
||||
javascript
|
||||
Jax
|
||||
jayferd
|
||||
jcon
|
||||
jdoe
|
||||
jeffreytse
|
||||
@@ -288,30 +178,25 @@ jekyllbot
|
||||
jekyllconf
|
||||
Jekyllers
|
||||
Jekyllin
|
||||
Jekylling
|
||||
jekyllized
|
||||
jekylllayoutconcept
|
||||
jekyllrb
|
||||
jekyllthemes
|
||||
jemoji
|
||||
jmcglone
|
||||
jneen
|
||||
johnreilly
|
||||
jpg
|
||||
jqr
|
||||
jruby
|
||||
json
|
||||
jsonify
|
||||
juretta
|
||||
jwarby
|
||||
Kacper
|
||||
Kasberg
|
||||
kbd
|
||||
Kentico
|
||||
Kewin
|
||||
keycdn
|
||||
kickster
|
||||
Kinnula
|
||||
kinsta
|
||||
kiwifruit
|
||||
Kolesky
|
||||
konklone
|
||||
@@ -321,40 +206,23 @@ kramdown
|
||||
Kulig
|
||||
Kwokfu
|
||||
Lamprecht
|
||||
laquo
|
||||
lastmod
|
||||
launchctl
|
||||
launchy
|
||||
laurilehmijoki
|
||||
ldquo
|
||||
learnxinyminutes
|
||||
lexer
|
||||
LGTM
|
||||
libcurl
|
||||
libffi
|
||||
lifecycle
|
||||
lightgray
|
||||
limjh
|
||||
lexers
|
||||
linenos
|
||||
linkify
|
||||
linux
|
||||
liufengyun
|
||||
livereload
|
||||
localheinz
|
||||
localhost
|
||||
localtime
|
||||
Locher
|
||||
loglevel
|
||||
Losslessly
|
||||
lovin
|
||||
lsi
|
||||
lsquo
|
||||
lstrip
|
||||
lyche
|
||||
macos
|
||||
macromates
|
||||
mademistakes
|
||||
mailto
|
||||
Manmeet
|
||||
markdownify
|
||||
Maroli
|
||||
@@ -365,42 +233,26 @@ mathml
|
||||
mattr
|
||||
Maximiliano
|
||||
mchung
|
||||
mdash
|
||||
memberspace
|
||||
Memoize
|
||||
memoized
|
||||
memoizing
|
||||
mentoring
|
||||
mergable
|
||||
Mertcan
|
||||
mertkahyaoglu
|
||||
metadata
|
||||
metadatas
|
||||
microdata
|
||||
microsoft
|
||||
mimetype
|
||||
mingw
|
||||
minibundle
|
||||
minifier
|
||||
minitest
|
||||
Mittal
|
||||
mixin
|
||||
mkasberg
|
||||
mkd
|
||||
mkdir
|
||||
mkdn
|
||||
mkdown
|
||||
mmistakes
|
||||
modernizr
|
||||
mojombo
|
||||
moncefbelyamani
|
||||
moz
|
||||
mreid
|
||||
msdn
|
||||
mswin
|
||||
MSYS
|
||||
mtime
|
||||
multiline
|
||||
munging
|
||||
Mvvm
|
||||
myblog
|
||||
mycontent
|
||||
@@ -411,46 +263,31 @@ mypage
|
||||
myposts
|
||||
myproject
|
||||
myrepo
|
||||
mysite
|
||||
myvalue
|
||||
myvar
|
||||
myvariable
|
||||
Nadjib
|
||||
nakanishi
|
||||
namespace
|
||||
namespaced
|
||||
navbar
|
||||
nbsp
|
||||
navbars
|
||||
nearlyfreespeech
|
||||
nethack
|
||||
netlify
|
||||
netlifycms
|
||||
Neue
|
||||
nginx
|
||||
ngx
|
||||
nielsenramon
|
||||
nior
|
||||
nodejs
|
||||
noifniof
|
||||
nokogiri
|
||||
notextile
|
||||
onclick
|
||||
onebox
|
||||
oneclick
|
||||
onschedule
|
||||
opensource
|
||||
openssl
|
||||
Optim
|
||||
orderofinterpretation
|
||||
orgs
|
||||
OSVDB
|
||||
osx
|
||||
packagecontrol
|
||||
pacman
|
||||
paginator
|
||||
pandoc
|
||||
pantulis
|
||||
params
|
||||
parkr
|
||||
parseable
|
||||
paspagon
|
||||
@@ -458,124 +295,79 @@ passthrough
|
||||
pathawks
|
||||
Pathutil
|
||||
paywall
|
||||
pdf
|
||||
PDFs
|
||||
Pelykh
|
||||
permalink
|
||||
PHP
|
||||
pinboard
|
||||
Piwigo
|
||||
pjhyett
|
||||
pkill
|
||||
pkpass
|
||||
placeholders
|
||||
planetjekyll
|
||||
plantuml
|
||||
plugin
|
||||
png
|
||||
podcasts
|
||||
popen
|
||||
Porcel
|
||||
Posterous
|
||||
postfiles
|
||||
postlayout
|
||||
postmodern
|
||||
preinstalled
|
||||
prepends
|
||||
Prioritise
|
||||
Probot
|
||||
projectlist
|
||||
pubstorm
|
||||
pufuwozu
|
||||
pwa
|
||||
pwd
|
||||
pygments
|
||||
qrush
|
||||
Quaid
|
||||
quickstart
|
||||
rackup
|
||||
Rakefile
|
||||
raquo
|
||||
razorops
|
||||
rbenv
|
||||
rdiscount
|
||||
rdoc
|
||||
rdquo
|
||||
readme
|
||||
realz
|
||||
rebund
|
||||
redcarpet
|
||||
redcloth
|
||||
redgreen
|
||||
redhat
|
||||
refactor
|
||||
refactoring
|
||||
Refactors
|
||||
Refheap
|
||||
regen
|
||||
regex
|
||||
regexp
|
||||
remi
|
||||
reqs
|
||||
Responsify
|
||||
revertable
|
||||
rfc
|
||||
rfelix
|
||||
RHEL
|
||||
ridk
|
||||
roadmap
|
||||
rowspan
|
||||
rspec
|
||||
rsquo
|
||||
rss
|
||||
rstrip
|
||||
rsync
|
||||
rtomayko
|
||||
Rubo
|
||||
rubocop
|
||||
rubychan
|
||||
rubygem
|
||||
rubyinstaller
|
||||
rubyprof
|
||||
Ruparelia
|
||||
Rusiczki
|
||||
rvm
|
||||
ryanflorence
|
||||
saas
|
||||
samplelist
|
||||
samrayner
|
||||
sandboxed
|
||||
Sassc
|
||||
sassify
|
||||
schemastore
|
||||
Schroers
|
||||
Schwartzian
|
||||
scp
|
||||
screenshot
|
||||
scrollbar
|
||||
scroller
|
||||
scss
|
||||
scssify
|
||||
sdk
|
||||
scrollbars
|
||||
SDKROOT
|
||||
sectore
|
||||
semver
|
||||
seo
|
||||
serverless
|
||||
setenv
|
||||
SFTP
|
||||
shingo
|
||||
shopify
|
||||
shortlinks
|
||||
shortlog
|
||||
shoulda
|
||||
Shoulda
|
||||
sieversii
|
||||
sigpipe
|
||||
simplecov
|
||||
Singhaniya
|
||||
siteleaf
|
||||
sitemap
|
||||
SITENAME
|
||||
Slicehost
|
||||
slugified
|
||||
slugify
|
||||
smartforms
|
||||
smartify
|
||||
snipcart
|
||||
@@ -584,177 +376,101 @@ somedir
|
||||
sonnym
|
||||
Sonomy
|
||||
sourced
|
||||
sourcemaps
|
||||
spam
|
||||
spotify
|
||||
src
|
||||
ssg
|
||||
ssh
|
||||
SSL
|
||||
stackoverflow
|
||||
standalone
|
||||
staticfiles
|
||||
staticman
|
||||
statictastic
|
||||
STDERR
|
||||
stdout
|
||||
Stickyposts
|
||||
strftime
|
||||
stringified
|
||||
Stringify
|
||||
styleguide
|
||||
stylesheet
|
||||
subdir
|
||||
subdomain
|
||||
subfolder
|
||||
subfolderitems
|
||||
subnav
|
||||
subpages
|
||||
subpath
|
||||
subpiece
|
||||
subsubfolderitems
|
||||
subthing
|
||||
subvalues
|
||||
subwidget
|
||||
sudo
|
||||
superdirectories
|
||||
superdirs
|
||||
SUSE
|
||||
sverrirs
|
||||
svg
|
||||
svn
|
||||
swfobject
|
||||
swupd
|
||||
symlink
|
||||
symlinking
|
||||
tablerow
|
||||
tada
|
||||
Taillandier
|
||||
talkyard
|
||||
tbody
|
||||
technicalpickles
|
||||
templating
|
||||
templatize
|
||||
Termux
|
||||
textilize
|
||||
textpattern
|
||||
thead
|
||||
therubyracer
|
||||
Theunissen
|
||||
Thornquest
|
||||
thoughtbot
|
||||
throughs
|
||||
Tidelift
|
||||
timeago
|
||||
timezone
|
||||
titleize
|
||||
TLS
|
||||
timezones
|
||||
tmm
|
||||
tmp
|
||||
toc
|
||||
tok
|
||||
tomjoht
|
||||
toml
|
||||
tomo
|
||||
toolset
|
||||
toshimaru
|
||||
triaged
|
||||
triaging
|
||||
truncatewords
|
||||
tsv
|
||||
ttf
|
||||
Tudou
|
||||
Tumblr
|
||||
Tweetsert
|
||||
txtpen
|
||||
Tyborska
|
||||
tzinfo
|
||||
ubuntu
|
||||
uby
|
||||
ujh
|
||||
ultron
|
||||
undumpable
|
||||
unencode
|
||||
Unescape
|
||||
unescaping
|
||||
unicode
|
||||
uniq
|
||||
upcase
|
||||
uppercasing
|
||||
uri
|
||||
url
|
||||
urlset
|
||||
username
|
||||
usr
|
||||
utf
|
||||
utils
|
||||
utime
|
||||
usernames
|
||||
utm
|
||||
vanpelt
|
||||
Vasovi
|
||||
vendored
|
||||
vercel
|
||||
versioned
|
||||
versioning
|
||||
vertycal
|
||||
Veyor
|
||||
vilcans
|
||||
Vishesh
|
||||
visualstudio
|
||||
vnd
|
||||
vohedge
|
||||
vps
|
||||
vscode
|
||||
vwochnik
|
||||
Walkthroughs
|
||||
wdm
|
||||
We'd
|
||||
webfont
|
||||
webhook
|
||||
webfonts
|
||||
webhosting
|
||||
webmentions
|
||||
webrick
|
||||
website
|
||||
weekdate
|
||||
whitelist
|
||||
whitelisting
|
||||
wiki
|
||||
wikipedia
|
||||
wildcards
|
||||
willcodeforfoo
|
||||
woff
|
||||
wordpress
|
||||
Workaround
|
||||
workflow
|
||||
wsl
|
||||
www
|
||||
workflows
|
||||
xcode
|
||||
xcrun
|
||||
xdg
|
||||
Xhmikos
|
||||
xhtml
|
||||
Xiaoiver
|
||||
XMinutes
|
||||
xml
|
||||
xmlns
|
||||
xmlschema
|
||||
yajl
|
||||
yaml
|
||||
Yarp
|
||||
Yashu
|
||||
Yastreb
|
||||
yml
|
||||
Youku
|
||||
youtube
|
||||
yunbox
|
||||
zeropadding
|
||||
Zlatan
|
||||
zlib
|
||||
zoneinfo
|
||||
zpinter
|
||||
Zsh
|
||||
zshrc
|
||||
zypper
|
||||
zzot
|
||||
frontend
|
||||
prefetching
|
||||
|
||||
62
.github/actions/spelling/line_forbidden.patterns
vendored
Normal file
62
.github/actions/spelling/line_forbidden.patterns
vendored
Normal 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
|
||||
89
.github/actions/spelling/patterns.txt
vendored
89
.github/actions/spelling/patterns.txt
vendored
@@ -71,5 +71,94 @@ apiKey: '[a-f0-9]+'
|
||||
# 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+`
|
||||
|
||||
11
.github/actions/spelling/reject.txt
vendored
11
.github/actions/spelling/reject.txt
vendored
@@ -1,7 +1,10 @@
|
||||
^attache$
|
||||
benefitting
|
||||
occurence
|
||||
occurences?
|
||||
^dependan.*
|
||||
^oer$
|
||||
Sorce
|
||||
^[Ss]pae
|
||||
^untill
|
||||
^wether
|
||||
^[Ss]pae.*
|
||||
^untill$
|
||||
^untilling$
|
||||
^wether.*
|
||||
|
||||
6
.github/dependabot.yml
vendored
6
.github/dependabot.yml
vendored
@@ -4,3 +4,9 @@ updates:
|
||||
directory: "/"
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
- package-ecosystem: bundler
|
||||
reviewers:
|
||||
- "jekyll/core"
|
||||
directory: /
|
||||
schedule:
|
||||
interval: weekly
|
||||
|
||||
2
.github/first-timers-issue-template.md
vendored
2
.github/first-timers-issue-template.md
vendored
@@ -2,7 +2,7 @@
|
||||
|
||||
This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝
|
||||
|
||||
[About First Timers Only](http://www.firsttimersonly.com/).
|
||||
[About First Timers Only](https://www.firsttimersonly.com/).
|
||||
|
||||
### 🤔 What you will need to know.
|
||||
|
||||
|
||||
2
.github/workflows/benchmark.yml
vendored
2
.github/workflows/benchmark.yml
vendored
@@ -20,7 +20,7 @@ jobs:
|
||||
BENCHMARK: true
|
||||
steps:
|
||||
- name: Checkout Jekyll
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v4
|
||||
- name: Set up Ruby
|
||||
uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
|
||||
53
.github/workflows/ci.yml
vendored
53
.github/workflows/ci.yml
vendored
@@ -5,61 +5,80 @@ on:
|
||||
branches:
|
||||
- master
|
||||
- "*-stable"
|
||||
paths-ignore:
|
||||
- "docs/**"
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
- "*-stable"
|
||||
paths-ignore:
|
||||
- "docs/**"
|
||||
|
||||
jobs:
|
||||
ci:
|
||||
name: "Run Tests (${{ matrix.label }})"
|
||||
runs-on: "ubuntu-latest"
|
||||
name: "Run Tests (${{ matrix.ruby.label }} on ${{ matrix.os.label }})"
|
||||
runs-on: ${{ matrix.os.image }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
ruby:
|
||||
- label: Ruby 2.7
|
||||
ruby_version: "2.7"
|
||||
- label: Ruby 3.0
|
||||
ruby_version: "3.0"
|
||||
- label: Ruby 3.1
|
||||
ruby_version: "3.1"
|
||||
- label: JRuby 9.3.4.0
|
||||
ruby_version: "jruby-9.3.4.0"
|
||||
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@v3
|
||||
- name: "Set up ${{ matrix.label }}"
|
||||
uses: actions/checkout@v4
|
||||
- name: "Set up ${{ matrix.ruby.label }}"
|
||||
uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
ruby-version: ${{ matrix.ruby_version }}
|
||||
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
|
||||
run: bash script/cucumber --color
|
||||
- name: Generate and Build a new site
|
||||
run: bash script/default-site
|
||||
|
||||
xtras:
|
||||
name: "${{ matrix.job_name }} (Ruby ${{ matrix.ruby_version }})"
|
||||
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@v3
|
||||
- name: "Set up Ruby ${{ matrix.ruby_version }}"
|
||||
uses: actions/checkout@v4
|
||||
- name: "Set up ${{ matrix.setup_label }}"
|
||||
uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
ruby-version: ${{ matrix.ruby_version }}
|
||||
|
||||
65
.github/workflows/codeql.yml
vendored
Normal file
65
.github/workflows/codeql.yml
vendored
Normal 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}}"
|
||||
4
.github/workflows/docs.yml
vendored
4
.github/workflows/docs.yml
vendored
@@ -4,6 +4,8 @@ on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
paths:
|
||||
- "docs/**"
|
||||
|
||||
env:
|
||||
RUBY_VERSION: 2.7
|
||||
@@ -17,7 +19,7 @@ jobs:
|
||||
BUNDLE_JOBS: 4
|
||||
BUNDLE_RETRY: 3
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/checkout@v4
|
||||
- uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
ruby-version: ${{ env.RUBY_VERSION }}
|
||||
|
||||
2
.github/workflows/release.yml
vendored
2
.github/workflows/release.yml
vendored
@@ -20,7 +20,7 @@ jobs:
|
||||
- 2.7
|
||||
steps:
|
||||
- name: Checkout Repository
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v4
|
||||
- name: "Set up Ruby ${{ matrix.ruby_version }}"
|
||||
uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
|
||||
93
.github/workflows/spelling.yml
vendored
93
.github/workflows/spelling.yml
vendored
@@ -1,22 +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:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
- "*-stable"
|
||||
# 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:
|
||||
build:
|
||||
spelling:
|
||||
name: Spell Check
|
||||
runs-on: "ubuntu-latest"
|
||||
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: Checkout Repository
|
||||
uses: actions/checkout@v3
|
||||
- name: Check Spellings
|
||||
uses: check-spelling/check-spelling@v0.0.19
|
||||
- name: check-spelling
|
||||
id: spelling
|
||||
uses: check-spelling/check-spelling@v0.0.24
|
||||
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)
|
||||
|
||||
17
.github/workflows/third-party.yml
vendored
17
.github/workflows/third-party.yml
vendored
@@ -1,16 +1,11 @@
|
||||
name: Third-Party Repository Profiling
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build_n_profile:
|
||||
if: "!contains(github.event.commits[0].message, '[ci skip]')"
|
||||
runs-on: 'ubuntu-latest'
|
||||
runs-on: "ubuntu-latest"
|
||||
env:
|
||||
BUNDLE_GEMFILE: "sandbox/Gemfile"
|
||||
BUNDLE_PATH: "vendor/bundle"
|
||||
@@ -18,19 +13,19 @@ jobs:
|
||||
BUNDLE_RETRY: 3
|
||||
steps:
|
||||
- name: Checkout Jekyll
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 5
|
||||
path: jekyll
|
||||
- name: Checkout Third-Party Repository
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
repository: ashmaroli/tomjoht.github.io
|
||||
path: sandbox
|
||||
- name: Set up Ruby
|
||||
uses: ruby/setup-ruby@v1
|
||||
with:
|
||||
ruby-version: 2.7
|
||||
ruby-version: 3.4
|
||||
bundler-cache: true
|
||||
- name: Run Jekyll Build 3 times
|
||||
run: |
|
||||
|
||||
336
.rubocop.yml
336
.rubocop.yml
@@ -1,32 +1,53 @@
|
||||
---
|
||||
inherit_from: .rubocop_todo.yml
|
||||
# -----------------------------------------------------------------------------
|
||||
# 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-minitest
|
||||
- rubocop-performance
|
||||
- rubocop-rake
|
||||
- rubocop-rspec
|
||||
- ./rubocop/jekyll
|
||||
|
||||
Jekyll/NoPutsAllowed:
|
||||
Exclude:
|
||||
- rake/*.rake
|
||||
- "./rubocop/jekyll"
|
||||
- rubocop-minitest
|
||||
- rubocop-performance
|
||||
- rubocop-rake
|
||||
- rubocop-rspec
|
||||
|
||||
# Directive for all cops
|
||||
AllCops:
|
||||
TargetRubyVersion: 2.7
|
||||
Include:
|
||||
- lib/**/*.rb
|
||||
- test/**/*.rb
|
||||
- lib/**/*.rb
|
||||
- test/**/*.rb
|
||||
Exclude:
|
||||
- bin/**/*
|
||||
- exe/**/*
|
||||
- benchmark/**/*
|
||||
- script/**/*
|
||||
- vendor/**/*
|
||||
- tmp/**/*
|
||||
- benchmark/**/*
|
||||
- bin/**/*
|
||||
- exe/**/*
|
||||
- script/**/*
|
||||
- tmp/**/*
|
||||
- vendor/**/*
|
||||
|
||||
Gemspec/DateAssignment:
|
||||
# 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:
|
||||
@@ -35,6 +56,8 @@ Layout/EmptyLinesAroundAttributeAccessor:
|
||||
Enabled: true
|
||||
Layout/EndAlignment:
|
||||
Severity: error
|
||||
Layout/EndOfLine:
|
||||
Enabled: false
|
||||
Layout/FirstArrayElementIndentation:
|
||||
EnforcedStyle: consistent
|
||||
Layout/FirstHashElementIndentation:
|
||||
@@ -43,12 +66,18 @@ Layout/HashAlignment:
|
||||
EnforcedHashRocketStyle: table
|
||||
Layout/IndentationWidth:
|
||||
Severity: error
|
||||
Layout/LineContinuationLeadingSpace:
|
||||
Enabled: true
|
||||
Layout/LineContinuationSpacing:
|
||||
Enabled: true
|
||||
Layout/LineEndStringConcatenationIndentation:
|
||||
Enabled: true
|
||||
Layout/LineLength:
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb/
|
||||
- Rakefile
|
||||
- rake/*.rake
|
||||
- Gemfile
|
||||
- Gemfile
|
||||
- Rakefile
|
||||
- features/**/*.rb
|
||||
- rake/**/*.rake
|
||||
Max: 100
|
||||
Severity: warning
|
||||
Layout/MultilineMethodCallIndentation:
|
||||
@@ -62,16 +91,24 @@ Layout/SpaceBeforeBrackets:
|
||||
Layout/SpaceInsideHashLiteralBraces:
|
||||
Enabled: true
|
||||
Exclude:
|
||||
- test/**/*.rb
|
||||
- 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
|
||||
- test/**/*.rb
|
||||
Lint/ConstantOverwrittenInRescue:
|
||||
Enabled: true
|
||||
Lint/DeprecatedConstants:
|
||||
Enabled: true
|
||||
Lint/DeprecatedOpenSSLConstant:
|
||||
@@ -80,6 +117,10 @@ Lint/DuplicateBranch:
|
||||
Enabled: true
|
||||
Lint/DuplicateElsifCondition:
|
||||
Enabled: true
|
||||
Lint/DuplicateMagicComment:
|
||||
Enabled: true
|
||||
Lint/DuplicateMatchPattern:
|
||||
Enabled: true
|
||||
Lint/DuplicateRegexpCharacterClassElement:
|
||||
Enabled: true
|
||||
Lint/DuplicateRequire:
|
||||
@@ -104,11 +145,13 @@ Lint/LambdaWithoutLiteralBlock:
|
||||
Enabled: true
|
||||
Lint/MissingSuper:
|
||||
Enabled: false
|
||||
Lint/MixedCaseRange:
|
||||
Enabled: true
|
||||
Lint/MixedRegexpCaptureTypes:
|
||||
Enabled: false
|
||||
Lint/NestedPercentLiteral:
|
||||
Exclude:
|
||||
- test/test_site.rb
|
||||
- test/test_site.rb
|
||||
Lint/NoReturnInBeginEndBlocks:
|
||||
Enabled: true
|
||||
Lint/NumberedParameterAssignment:
|
||||
@@ -121,8 +164,16 @@ 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:
|
||||
@@ -147,32 +198,38 @@ Lint/UnreachableLoop:
|
||||
Enabled: true
|
||||
Lint/UselessMethodDefinition:
|
||||
Enabled: true
|
||||
Lint/UselessRuby2Keywords:
|
||||
Enabled: true
|
||||
Lint/UselessTimes:
|
||||
Enabled: true
|
||||
Lint/Void:
|
||||
Exclude:
|
||||
- lib/jekyll/site.rb
|
||||
- lib/jekyll/site.rb
|
||||
|
||||
# Metrics cops
|
||||
# ----------------------------------------
|
||||
Metrics/AbcSize:
|
||||
Max: 23
|
||||
Metrics/BlockLength:
|
||||
Exclude:
|
||||
- test/**/*.rb
|
||||
- lib/jekyll/configuration.rb
|
||||
- rake/*.rake
|
||||
- lib/jekyll/configuration.rb
|
||||
- rake/**/*.rake
|
||||
- test/**/*.rb
|
||||
Metrics/ClassLength:
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb$/
|
||||
- !ruby/regexp /test\/.*.rb$/
|
||||
- lib/jekyll/document.rb
|
||||
- lib/jekyll/site.rb
|
||||
- lib/jekyll/commands/serve.rb
|
||||
- lib/jekyll/configuration.rb
|
||||
- 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/utils.rb
|
||||
- lib/jekyll/commands/serve.rb
|
||||
- lib/jekyll/commands/serve.rb
|
||||
- lib/jekyll/utils.rb
|
||||
Max: 11
|
||||
Metrics/MethodLength:
|
||||
CountComments: false
|
||||
@@ -180,54 +237,102 @@ Metrics/MethodLength:
|
||||
Severity: error
|
||||
Metrics/ModuleLength:
|
||||
Exclude:
|
||||
- lib/jekyll/filters.rb
|
||||
- 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/AssertionInLifecycleHook:
|
||||
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/TestMethodName:
|
||||
Enabled: false
|
||||
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/AssertEmptyLiteral:
|
||||
Enabled: false
|
||||
Minitest/UselessAssertion:
|
||||
Enabled: true
|
||||
|
||||
# Naming cops
|
||||
# ----------------------------------------
|
||||
Naming/FileName:
|
||||
Enabled: false
|
||||
Naming/HeredocDelimiterNaming:
|
||||
Exclude:
|
||||
- test/**/*.rb
|
||||
- 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
|
||||
- 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:
|
||||
@@ -242,10 +347,18 @@ 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:
|
||||
@@ -254,22 +367,32 @@ Performance/SortReverse:
|
||||
Enabled: false
|
||||
Performance/Squeeze:
|
||||
Enabled: true
|
||||
Performance/StringIdentifierArgument:
|
||||
Enabled: true
|
||||
Performance/StringInclude:
|
||||
Enabled: true
|
||||
Exclude:
|
||||
- lib/jekyll/utils/platforms.rb
|
||||
- lib/jekyll/utils/platforms.rb
|
||||
Performance/Sum:
|
||||
Enabled: true
|
||||
|
||||
# Security cops
|
||||
# ----------------------------------------
|
||||
Security/CompoundHash:
|
||||
Enabled: true
|
||||
Security/IoMethods:
|
||||
Enabled: true
|
||||
Security/MarshalLoad:
|
||||
Exclude:
|
||||
- !ruby/regexp /test\/.*.rb$/
|
||||
- lib/jekyll/regenerator.rb
|
||||
- lib/jekyll/regenerator.rb
|
||||
- test/**/*.rb
|
||||
Security/YAMLLoad:
|
||||
Exclude:
|
||||
- !ruby/regexp /features\/.*.rb/
|
||||
- !ruby/regexp /test\/.*.rb$/
|
||||
- features/**/*.rb
|
||||
- test/**/*.rb
|
||||
|
||||
# Style cops
|
||||
# ----------------------------------------
|
||||
Style/AccessModifierDeclarations:
|
||||
Enabled: false
|
||||
Style/AccessorGrouping:
|
||||
@@ -282,38 +405,56 @@ Style/ArgumentsForwarding:
|
||||
Enabled: false
|
||||
Style/ArrayCoercion:
|
||||
Enabled: true
|
||||
Style/ArrayIntersect:
|
||||
Enabled: true
|
||||
Style/BisectedAttrAccessor:
|
||||
Enabled: true
|
||||
Style/CaseLikeIf:
|
||||
Enabled: true
|
||||
Style/StringChars:
|
||||
Enabled: true
|
||||
Style/ClassAndModuleChildren:
|
||||
Exclude:
|
||||
- test/**/*.rb
|
||||
- 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/utils/ansi.rb
|
||||
- lib/jekyll/liquid_renderer/table.rb
|
||||
- lib/jekyll/profiler.rb
|
||||
- lib/jekyll/liquid_renderer/table.rb
|
||||
- lib/jekyll/profiler.rb
|
||||
- lib/jekyll/utils/ansi.rb
|
||||
Style/FrozenStringLiteralComment:
|
||||
EnforcedStyle: always
|
||||
Style/GlobalStdStream:
|
||||
@@ -323,7 +464,7 @@ Style/GuardClause:
|
||||
Style/HashAsLastArrayItem:
|
||||
Enabled: true
|
||||
Style/HashConversion:
|
||||
Enabled: true
|
||||
Enabled: true
|
||||
Style/HashEachMethods:
|
||||
Enabled: true
|
||||
Style/HashExcept:
|
||||
@@ -341,62 +482,115 @@ 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
|
||||
- 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": ()
|
||||
"%W": "()"
|
||||
"%q": "{}"
|
||||
"%r": "!!"
|
||||
"%s": ()
|
||||
"%w": ()
|
||||
"%x": ()
|
||||
"%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/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
|
||||
- lib/jekyll/commands/*.rb
|
||||
- test/**/*.rb
|
||||
Style/StringLiterals:
|
||||
EnforcedStyle: double_quotes
|
||||
Style/StringLiteralsInInterpolation:
|
||||
|
||||
25
Gemfile
25
Gemfile
@@ -15,15 +15,21 @@ end
|
||||
#
|
||||
|
||||
group :test do
|
||||
gem "cucumber", RUBY_VERSION >= "2.5" ? "~> 5.1.2" : "~> 4.1"
|
||||
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.26.0"
|
||||
gem "rubocop", "~> 1.57.2"
|
||||
gem "rubocop-minitest"
|
||||
gem "rubocop-performance"
|
||||
gem "rubocop-rake"
|
||||
@@ -48,7 +54,7 @@ group :test_legacy do
|
||||
gem "minitest"
|
||||
gem "minitest-profile"
|
||||
gem "minitest-reporters"
|
||||
gem "shoulda"
|
||||
gem "shoulda-context"
|
||||
gem "simplecov"
|
||||
end
|
||||
|
||||
@@ -75,7 +81,6 @@ group :jekyll_optional_dependencies do
|
||||
gem "kramdown-syntax-coderay"
|
||||
gem "matrix"
|
||||
gem "mime-types", "~> 3.0"
|
||||
gem "rdoc", "~> 6.3.0"
|
||||
gem "tomlrb"
|
||||
|
||||
platforms :ruby, :mswin, :mingw, :x64_mingw do
|
||||
@@ -94,6 +99,18 @@ 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"]
|
||||
|
||||
|
||||
347
History.markdown
347
History.markdown
@@ -1,6 +1,279 @@
|
||||
## HEAD
|
||||
## 4.4.0 / 2025-01-27
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Allow marking specific highlighted lines via Liquid (#9138)
|
||||
* Add gem `csv` to runtime dependency list (#9522)
|
||||
* Bump the minimum ruby version to 2.7 (#9525)
|
||||
* Acknowledge `livereload_port` from site config too (#9606)
|
||||
* Add gem `base64` as runtime dependency (#9740)
|
||||
* Add gem `json` as runtime_dependency (#9671)
|
||||
* Remove unnecessary constraint on gem `mercenary` (#9758)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Optimize default front matter using `File.fnmatch?` (#9185)
|
||||
* Remove totals in profile table properly (#9186)
|
||||
* Optimize `Site#each_site_file` (#9187)
|
||||
* Rename sass partial created for new blank site (#9257)
|
||||
* Fix `jekyll serve --detach` with jekyll-sass-converter 3.x (#9304)
|
||||
* Handle TypeError from `where` filter gracefully (#9292)
|
||||
* Add support for upcoming logger 1.4.3 (#9392)
|
||||
* Fix typo in devcontainer.json (#9364)
|
||||
* Correct rubocop lint errors (#9600)
|
||||
* Fix inexistent layout warning for the default 404 page (#9589)
|
||||
* Relax version constraint on `wdm` in new Gemfile (#9662)
|
||||
* Fix `--livereload-ignore` option (#9570)
|
||||
* Render theme-gem root only in development (#9680)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Cleanup highlight tag (#9177)
|
||||
* Run tests in utc (#9168)
|
||||
* Lock Ruby in CI to v3.1.2 and bump JRuby to v9.4.0.0 (#9196)
|
||||
* Update sass related tests for jekyll-sass-converter 3.x (#9223)
|
||||
* Split `test/test_tags.rb` into multiple files (#9230)
|
||||
* test: use hash explicitly for Struct initializer for ruby 3.2 (#9237)
|
||||
* script/default-site: accept flags for `jekyll new` (#9259)
|
||||
* Bump check-spelling/check-spelling from 0.0.20 to 0.0.21 (#9205)
|
||||
* Use check-spelling/check-spelling@v0.0.21 (#9199)
|
||||
* Bump RuboCop to v1.45.x (#9305)
|
||||
* Bump Rubocop to version 1.48.x (#9326)
|
||||
* Bump versions of ruby & nodejs in devcontainer (#9360)
|
||||
* Bump rubocop version to 1.52.x (#9361)
|
||||
* Upgrade RuboCop to 1.54 (#9401)
|
||||
* Add CodeQL workflow (#9397)
|
||||
* Bump actions/checkout from 3 to 4 (#9442)
|
||||
* Test suite uses shoulda-context only. (#9441)
|
||||
* Keep activesupport at version 7.0.x (#9469)
|
||||
* Bump Rubocop to 1.56.4 (#9459)
|
||||
* Configure dependabot to handle rubygems dependencies (#9445)
|
||||
* Update rubocop gem (#9476)
|
||||
* Fix Performance/StringIdentifierArgument violation in site.rb and allow activesupport 6 for windows tests (#9512)
|
||||
* Add a few more emeritus team members (#9535)
|
||||
* Make custom cop inherit `RuboCop::Cop::Base` (#9597)
|
||||
* CI: Use JRuby 9.4.8.0 (#9654)
|
||||
* Stop testing with Cucumber on JRuby (#9661)
|
||||
* Windows CI on GitHub Actions (#9659)
|
||||
* Run GitHub Actions only if needed (#9664)
|
||||
* Format `.rubocop.yml` via a rake task (#9687)
|
||||
* Configure some new cops (#9688)
|
||||
* Fix expected markup per WAI-ARIA requirements (#9737)
|
||||
* Add an optional `:rdoc` group of gems (#9742)
|
||||
* Test `inspect` filter with custom object (#9743)
|
||||
* Bump cucumber to v9 (#9747)
|
||||
* Add Ruby 3.4 to CI matrix (#9740)
|
||||
* Remove unnecessary runtime dependency (#9753)
|
||||
* Bump `check-spelling/check-spelling` action (#9756)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Fix Nested tree navigation with recursion example (#9174)
|
||||
* Fix typo on website (#9203)
|
||||
* Publish post on major release of sass-converter (#9225)
|
||||
* Update Jekyll on macOS (macos.md) and current ruby version to 3.1.3 in ruby.yml (#9195)
|
||||
* Add release post for v4.3.2 (#9263)
|
||||
* Grammatical reordering in 3-to-4 upgrading docs (#9245)
|
||||
* fixed grammatical mistake on "showcase" page (#9264)
|
||||
* Mark `highlight` `mark_lines` feature as 4.4 in docs (#9184)
|
||||
* Add v3.9.3 release history & post to `master` branch (#9284)
|
||||
* Update S3 deployment to remove s3_website (#9221)
|
||||
* Document Exclude behavior, Include overrides and the default exclusion list (#9376)
|
||||
* Update macos.md, remove Catalina (macOS 10.15) (#9405)
|
||||
* Update macos.md, add support for Ventura (#9406)
|
||||
* Typo fix - update to hooks and 3rd party deployment and one other article (#9411)
|
||||
* Update 07-assets.md (#9393)
|
||||
* Mention the front matter requirement in pages.md (#9423)
|
||||
* Point to the Rouge GitHub repo rather than broken website (#9362)
|
||||
* Add new theme directory to themes resources (#9356)
|
||||
* Adds Kinsta to 3rd party deployments (#9331)
|
||||
* Update Fedora prerequisites to include g++ (#9290)
|
||||
* Update convert-site-to-jekyll.md (#9348)
|
||||
* Update github-actions documentation (#9426)
|
||||
* Update resources.md (#9449)
|
||||
* Add GitHub Pages helpful notes (#9235)
|
||||
* Clarify which version of Jekyll needs 'jekyll-paginate' (#9477)
|
||||
* chore: update showcases (#9473)
|
||||
* Add FreeBSD installation instructions (#9481)
|
||||
* Fix broken link for the security team page (#9497)
|
||||
* Fix broken links for several Jekyll integrations (#9496)
|
||||
* Add release post for v4.3.3 (#9511)
|
||||
* Add docs version badge to page_excerpts feature (#9520)
|
||||
* Improve accessibility of the docs (#9338)
|
||||
* Fix gem quote consistency on docs (#9517)
|
||||
* Make site search work again (#9530)
|
||||
* Jekyll docs template typo - All pages show "Deployment" (#9548)
|
||||
* Fixed: Wrong navigation style on the right side of news and docs pages (#9586)
|
||||
* Add redirect for step-by-step tutorial (#9593)
|
||||
* Add Jekyll 3.10.0 release post & history (#9625)
|
||||
* Fix minor docs error (#9641)
|
||||
* Update windows.md (#9644)
|
||||
* Document keys of global variable `{{ jekyll }}` (#9653)
|
||||
* Fix incorrect and inconsistent variables in the permalinks page (#9591)
|
||||
* Fix lapses in documentation of page variables (#9667)
|
||||
* Add note about VSCode warning for SCSS files (#9609)
|
||||
* docs: Fix incorrect parentheses (#9629)
|
||||
* docs: Fix of a bug in the pagination section (#8890)
|
||||
* Update current Ruby version renders and macOS docs (#9614)
|
||||
* Improve docs around using GitHub Actions to build and deploy Jekyll sites (#9682)
|
||||
* Fix grammar in the description of `page.excerpt` variable (#9689)
|
||||
* Render HTML tables at `/docs/permalinks/` using a data file (#9666)
|
||||
* Fix HTML attribute separation whitespace placement in the Navigation include code of Assets step of the Step by Step Tutorial (#9695)
|
||||
* Fix missing glob matching pattern support description in the documentation of the `include` and `exclude` configuration options (#9697)
|
||||
* Fix missing `url` configuration option documentation (#9699)
|
||||
* Link to GitHub Pages Dependency versions page instead of explicitly specifying Jekyll version (#9715)
|
||||
* Fix broken link on third-party.md (#9704)
|
||||
* Fix: remove inaccessible links and their descriptions (#9745)
|
||||
* Add release post for v4.4.0 (#9759)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
* Extract markup for `Improve this page` into an inclusion (#9675)
|
||||
|
||||
## 4.3.4 / 2024-09-16
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Backport #9662 for v4.3.x: Relax version constraint on wdm in new Gemfile (#9683)
|
||||
* Backport #9680 for v4.3.x: Render theme-gem root only in development (#9684)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Sync workflows with counterparts on `master` (#9681)
|
||||
|
||||
## 4.3.3 / 2023-12-27
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Backport #9392 for v4.3.x: Fix backward compatibility issues in the Logger (#9510)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Backport #9237 for v4.3.x: Use Hash explicitly for Struct initializer (#9285)
|
||||
|
||||
## 3.10.0 / 2024-06-23
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Backport add-csv-dependency from #9522 to Jekyll 3 (#9616)
|
||||
* 3.10-stable: Add webrick as a dependency (#9620)
|
||||
|
||||
## 3.9.5 / 2024-02-12
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* 3.9-stable: allow Pages to be Excerpted (#9550)
|
||||
|
||||
## 3.9.4 / 2023-12-28
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Backport #9392 for v3.9.x: Add support for Ruby 3.3 Logger (#9513)
|
||||
|
||||
## 3.9.3 / 2023-01-29
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* 3.9.x: Support i18n 1.x (#9269)
|
||||
* Backport #8880 for v3.9.x: Support both tzinfo v1 and v2 along with non-half hour offsets (#9280)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* v3.9.x: test under Ruby 3.2 #9272)
|
||||
* v3.9.x: fix rdiscount test (#9277)
|
||||
|
||||
## 4.3.2 / 2023-01-20
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Backport #9257 for v4.3.x: Rename sass partial created for new blank site (#9262)
|
||||
* Backport #9187 for v4.3.x: Optimize `Site#each_site_file` (#9256)
|
||||
* Backport #9186 for v4.3.x: Remove totals in profile table properly (#9255)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* Backport #9223 for 4.3.x: Update sass related tests for jekyll-sass-converter 3.x (#9254)
|
||||
|
||||
## 4.3.1 / 2022-10-26
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Respect user-defined name attribute in documents (#9167)
|
||||
* Revert "Incrementally rebuild when a data file is changed" (#9170)
|
||||
|
||||
### Documentation
|
||||
|
||||
* Release post for v4.3.1 (#9171)
|
||||
|
||||
## 4.3.0 / 2022-10-20
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Add webrick as a dependency (#8524)
|
||||
* Regenerate supported mime types (#8542)
|
||||
* Update include tag to be more permissive (#8618)
|
||||
* Optimize `Jekyll::Utils.parse_date` (#8425)
|
||||
* Update rubocop from 1.12 to 1.18 and min ruby from 2.4 to 2.5 (#8741)
|
||||
* Always hide cache-dir contents from Git (#8798)
|
||||
* Remove the warning about auto-regeneration on Windows (#8821)
|
||||
* Propagate _data folder from theme (#8815)
|
||||
* Support both tzinfo v1 and v2 along with non-half hour offsets. (#8880)
|
||||
* Run vendor-mimes to update mime.types (#8940)
|
||||
* Expose collection static files via `site.static_files` (#8961)
|
||||
* Expose `basename` from `document.rb` as `name` to Liquid templates (#8761)
|
||||
* Allow Configurable Converters on CSV (#8858)
|
||||
* Introduce `theme` drop to expose theme-gem details (#9129)
|
||||
* Relax version constraint to allow Rouge 4.x (#9134)
|
||||
* Incrementally rebuild when a data file is changed (#8771)
|
||||
* Support jekyll-sass-converter 3.x (#9132)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* fix: pin rubocop to 1.12 due to error with ruby 2.4 (#8651)
|
||||
* Load Jekyll plugins from BUNDLE_GEMFILE location (#8585)
|
||||
* fix(security): CVE-2021-28834 (#8680)
|
||||
* Inject livereload script using `location.protocol` instead of `http:` (#8718)
|
||||
* Respect collections_dir config within include tag (#8756)
|
||||
* Fix regression in Convertible module from v4.2.0 (#8786)
|
||||
* Revert #7253: "Don't reset site.url to localhost:4000 by default" (#8620)
|
||||
* Improve readability of CI logs (#8877)
|
||||
* Fix deprecation message for missing doc method (#8960)
|
||||
* Fix response header for content served via `jekyll serve` (#8965)
|
||||
* Trigger livereload in sites without pages (#8337)
|
||||
* Only enable BOM encoding option on UTF encodings (#8363)
|
||||
* Ensure theme config is a `Jekyll::Configuration` object (#8988)
|
||||
* Remove misleading totals row from `--profile` table (#9039)
|
||||
* Unlock Psych dependency (#9135)
|
||||
* Fix false positive conflicts for static files in a collection (#9141)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* style: enable new cops (#8538)
|
||||
* Allow dependabot to keep github actions up-to-date (#8540)
|
||||
* Update actions/cache requirement to v2.1.3 (#8543)
|
||||
* Pin rubocop version (#8564)
|
||||
* style: add rubocop 1.9 cops (#8567)
|
||||
* Cross Version Testing Locally and Faster CI (#8610)
|
||||
* Use official Ruby setup GH action (#8614)
|
||||
* Spell check action for markdown documentation (#8675)
|
||||
* Update expect to cover docs/_posts (#8677)
|
||||
* Bump check-spelling/check-spelling from 0.0.18 to 0.0.19 (#8740)
|
||||
* Enable Rubocop accessor grouping, fix existing offenses (#8293)
|
||||
* Tags:Highlight: Decomposed HTMLLegacy formatter (#8623)
|
||||
* Relax Rubocop Dependency (#8831)
|
||||
* Add a workflow to build gems consistently (#8830)
|
||||
* Fix random test failures in TestExcerpt #to_liquid (#8884)
|
||||
* Lock gem `psych` to `v3.x` (#8918)
|
||||
* Fix typo in Bug Report template (#8951)
|
||||
* Check symlink outside site_source without Pathutil (#9015)
|
||||
* Stop testing with Rubies older than 2.7 on non-Windows (#8955)
|
||||
* Bump actions/checkout from 2 to 3 (#8986)
|
||||
* Remove git.io shortlinks from repo (#9045)
|
||||
* Bump rubocop to 1.32 (#9093)
|
||||
* Bump RuboCop to `1.36.x` (#9125)
|
||||
* Use check-spelling/check-spelling@v0.0.20 (#9111)
|
||||
* Disable pending cops when running rubocop (#9136)
|
||||
* Relax RDoc version dependency (#9142)
|
||||
|
||||
### Documentation
|
||||
|
||||
@@ -18,7 +291,7 @@
|
||||
* docs: troubleshoot macOS with ARM64 architecture (#8560)
|
||||
* docs: add overview of .jekyll-cache dir (#8648)
|
||||
* docs: clarify where .jekyll-metadata comes from (#8646)
|
||||
* Razorops cicd added (#8656)
|
||||
* Razorops CI/CD added (#8656)
|
||||
* Specify default port and host for serve commands in docs (#8624)
|
||||
* Update third-party.md (#8652)
|
||||
* Add documentation for Sass configuration options (#8587)
|
||||
@@ -46,7 +319,7 @@
|
||||
* Add Security Policy document (#8823)
|
||||
* Manage repository meta documents consistently (#8908)
|
||||
* docs: add Layer0 deployment guide (#8915)
|
||||
* docs: Update REAMDE generated by `jekyll new-theme` (#8919)
|
||||
* docs: Update README generated by `jekyll new-theme` (#8919)
|
||||
* Update resources.md (#8925)
|
||||
* Rewrite documentation on installing plugins (#8921)
|
||||
* Improve maintainers guide on releasing a new version (#8928)
|
||||
@@ -63,61 +336,15 @@
|
||||
* Remove Aerobatic (#9007)
|
||||
* Add Jekyll 3.9.2 release post to 'master' branch (#9013)
|
||||
* Simplify macOS installation docs (#8993)
|
||||
* Improve document about Github Actions section (#8853)
|
||||
* Improve document about GitHub Actions section (#8853)
|
||||
* Update permalinks.md (#9017)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Add webrick as a dependency (#8524)
|
||||
* fix: pin rubocop to 1.12 due to error with ruby 2.4 (#8651)
|
||||
* Load Jekyll plugins from BUNDLE_GEMFILE location (#8585)
|
||||
* fix(security): CVE-2021-28834 (#8680)
|
||||
* Inject livereload script using `location.protocol` instead of `http:` (#8718)
|
||||
* Respect collections_dir config within include tag (#8756)
|
||||
* Fix regression in Convertible module from v4.2.0 (#8786)
|
||||
* Revert #7253: "Don't reset site.url to localhost:4000 by default" (#8620)
|
||||
* Improve readability of CI logs (#8877)
|
||||
* Fix deprecation message for missing doc method (#8960)
|
||||
* Fix response header for content served via `jekyll serve` (#8965)
|
||||
* Trigger livereload in sites without pages (#8337)
|
||||
* Only enable BOM encoding option on UTF encodings (#8363)
|
||||
|
||||
### Development Fixes
|
||||
|
||||
* style: enable new cops (#8538)
|
||||
* Allow dependabot to keep github actions up-to-date (#8540)
|
||||
* Update actions/cache requirement to v2.1.3 (#8543)
|
||||
* Pin rubocop version (#8564)
|
||||
* style: add rubocop 1.9 cops (#8567)
|
||||
* Cross Version Testing Locally and Faster CI (#8610)
|
||||
* Use official Ruby setup GH action (#8614)
|
||||
* Spell check action for markdown documentation (#8675)
|
||||
* Update expect to cover docs/_posts (#8677)
|
||||
* Enable Rubocop accessor grouping, fix existing offenses (#8293)
|
||||
* Tags:Highlight: Decomposed HTMLLegacy formatter (#8623)
|
||||
* Relax Rubocop Dependency (#8831)
|
||||
* Add a workflow to build gems consistently (#8830)
|
||||
* Fix random test failures in TestExcerpt #to_liquid (#8884)
|
||||
* Lock gem `psych` to `v3.x` (#8918)
|
||||
* Fix typo in Bug Report template (#8951)
|
||||
* Check symlink outside site_source without Pathutil (#9015)
|
||||
* Stop testing with Rubies older than 2.7 on non-Windows (#8955)
|
||||
* Bump actions/checkout from 2 to 3 (#8986)
|
||||
|
||||
### Minor Enhancements
|
||||
|
||||
* Regenerate supported mime types (#8542)
|
||||
* Update include tag to be more permissive (#8618)
|
||||
* Optimize `Jekyll::Utils.parse_date` (#8425)
|
||||
* Update rubocop from 1.12 to 1.18 and min ruby from 2.4 to 2.5 (#8741)
|
||||
* Always hide cache-dir contents from Git (#8798)
|
||||
* Remove the warning about auto-regeneration on Windows (#8821)
|
||||
* Propagate _data folder from theme (#8815)
|
||||
* Support both tzinfo v1 and v2 alongwith non-half hour offsets. (#8880)
|
||||
* Run vendor-mimes to update mime.types (#8940)
|
||||
* Expose collection static files via `site.static_files` (#8961)
|
||||
* Expose `basename` from `document.rb` as `name` to Liquid templates (#8761)
|
||||
* Allow Configurable Converters on CSV (#8858)
|
||||
* Add clarity to docs on permalinks placeholders and built-ins (#8995)
|
||||
* Remove Ionic Framework site from showcase (#9057)
|
||||
* Windows: describe which option to choose (#9049)
|
||||
* Improve links (http -> https) (#9064)
|
||||
* Update ruby version for macos guide (#9086)
|
||||
* Update posts.md (#9151)
|
||||
* Release post for v4.3.0 (#9157)
|
||||
|
||||
### Site Enhancements
|
||||
|
||||
@@ -1183,7 +1410,7 @@
|
||||
* make flakey test more robust (#6277)
|
||||
* Add a quick test for DataReader (#6284)
|
||||
* script/backport-pr: commit message no longer includes the `#` (#6289)
|
||||
* Add Add CODEOWNERS file to help automate reviews. (#6320)
|
||||
* Add CODEOWNERS file to help automate reviews. (#6320)
|
||||
* Fix builds on codeclimate (#6333)
|
||||
* Bump rubies on Travis (#6366)
|
||||
|
||||
@@ -2241,7 +2468,7 @@
|
||||
* Fixed an unclear code comment in site template SCSS (#3837)
|
||||
* Fix reading of binary metadata file (#3845)
|
||||
* Remove var collision with site template header menu iteration variable (#3838)
|
||||
* Change non-existent `hl_linenos` to `hl_lines` to allow passthrough in safe mode (#3787)
|
||||
* Change nonexistent `hl_linenos` to `hl_lines` to allow passthrough in safe mode (#3787)
|
||||
* Add missing flag to disable the watcher (#3820)
|
||||
* Update CI guide to include more direct explanations of the flow (#3891)
|
||||
* Set `future` to `false` in the default config (#3892)
|
||||
@@ -2550,7 +2777,7 @@
|
||||
* Document the `name` variable for collection permalinks (#2829)
|
||||
* Adds info about installing jekyll in current dir (#2839)
|
||||
* Remove deprecated `jekyll-projectlist` plugin from list of third-party plugins (#2742)
|
||||
* Remove tag plugins that are built in to Jekyll (#2751)
|
||||
* Remove tag plugins that are built into Jekyll (#2751)
|
||||
* Add `markdown-writer` package for Atom Editor to list of third-party plugins (#2763)
|
||||
* Fix typo in site documentation for collections (#2764)
|
||||
* Fix minor typo on plugins docs page (#2765)
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
# [Jekyll](https://jekyllrb.com/)
|
||||
|
||||
[][ruby-gems]
|
||||
[][ci-workflow]
|
||||
[][appveyor]
|
||||
[][ci-workflow]
|
||||
[](#backers)
|
||||
[](#sponsors)
|
||||
|
||||
@@ -28,7 +27,7 @@ See: [https://jekyllrb.com/philosophy](https://jekyllrb.com/philosophy)
|
||||
|
||||
## Diving In
|
||||
|
||||
* [Migrate](http://import.jekyllrb.com/docs/home/) from your previous system
|
||||
* [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
|
||||
|
||||
47
appveyor.yml
47
appveyor.yml
@@ -1,47 +0,0 @@
|
||||
version: "{build}"
|
||||
|
||||
clone_depth: 5
|
||||
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
- themes
|
||||
- /.*-stable/
|
||||
|
||||
build: off
|
||||
|
||||
environment:
|
||||
BUNDLE_WITHOUT: "benchmark:development"
|
||||
matrix:
|
||||
- RUBY_FOLDER_VER: "26"
|
||||
TZINFO_VERSION: "~> 1.2"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "26"
|
||||
TZINFO_VERSION: "~> 2.0"
|
||||
TEST_SUITE: "test"
|
||||
- RUBY_FOLDER_VER: "26"
|
||||
TEST_SUITE: "default-site"
|
||||
- RUBY_FOLDER_VER: "26"
|
||||
TEST_SUITE: "profile-docs"
|
||||
- RUBY_FOLDER_VER: "26"
|
||||
TEST_SUITE: "memprof"
|
||||
- RUBY_FOLDER_VER: "26"
|
||||
TZINFO_VERSION: "~> 1.2"
|
||||
TEST_SUITE: "cucumber"
|
||||
- RUBY_FOLDER_VER: "26"
|
||||
TZINFO_VERSION: "~> 2.0"
|
||||
TEST_SUITE: "cucumber"
|
||||
|
||||
install:
|
||||
- SET PATH=C:\Ruby%RUBY_FOLDER_VER%-x64\bin;%PATH%
|
||||
- bundle install --retry 5 --jobs=%NUMBER_OF_PROCESSORS% --clean --path vendor\bundle
|
||||
|
||||
test_script:
|
||||
- ruby --version
|
||||
- gem --version
|
||||
- bundler --version
|
||||
- bash ./script/cibuild
|
||||
|
||||
cache:
|
||||
# If one of the files after the right arrow changes, cache will be invalidated
|
||||
- 'vendor\bundle -> appveyor.yml,Gemfile,jekyll.gemspec'
|
||||
@@ -1,9 +1,10 @@
|
||||
---
|
||||
version: 4.2.2
|
||||
version: 4.4.0
|
||||
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
|
||||
|
||||
@@ -112,10 +112,27 @@
|
||||
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>
|
||||
• Protocol scheme (e.g. <code>http://</code>)<br>
|
||||
• Hostname or IP address (e.g. <code>example.org</code>)<br>
|
||||
• <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.
|
||||
option: "baseurl: URL"
|
||||
flag: -b, --baseurl 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
|
||||
|
||||
@@ -40,6 +40,30 @@
|
||||
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, ...]"
|
||||
|
||||
|
||||
@@ -47,6 +71,13 @@
|
||||
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, ...]"
|
||||
|
||||
|
||||
|
||||
@@ -17,7 +17,13 @@
|
||||
|
||||
|
||||
- name: Live reload ignore
|
||||
description: File glob patterns for LiveReload to 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,...]"
|
||||
|
||||
@@ -33,7 +39,10 @@
|
||||
|
||||
|
||||
- name: Live reload port
|
||||
description: Port for LiveReload to listen on.
|
||||
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"
|
||||
|
||||
|
||||
|
||||
@@ -16,6 +16,13 @@ global:
|
||||
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.
|
||||
@@ -91,38 +98,44 @@ site:
|
||||
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.
|
||||
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.
|
||||
The title of the Page or Document resource.
|
||||
- name: page.excerpt
|
||||
description: >-
|
||||
The un-rendered excerpt of a document.
|
||||
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
|
||||
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>).
|
||||
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>
|
||||
<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>.
|
||||
<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 this document belongs. e.g. <code>posts</code> for a post, or
|
||||
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
|
||||
@@ -131,16 +144,29 @@ page:
|
||||
<a href="/docs/front-matter/">front matter</a>.
|
||||
- name: page.dir
|
||||
description: >-
|
||||
The path between the source directory and the file of the post or page, e.g.
|
||||
<code>/pages/</code>.
|
||||
This can be overridden by <code>permalink</code> in the <a href="/docs/front-matter/">front matter</a>.
|
||||
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. Example usage: Linking back to the page or post’s source
|
||||
on GitHub. This can be overridden in the <a href="/docs/front-matter/">front matter</a>.
|
||||
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>.
|
||||
@@ -150,6 +176,28 @@ page:
|
||||
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
|
||||
|
||||
139
docs/_data/permalinks.yml
Normal file
139
docs/_data/permalinks.yml
Normal 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.)
|
||||
@@ -1,3 +1,3 @@
|
||||
min_version: 2.5.0
|
||||
current_version: 3.1.1
|
||||
current_version_output: ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236)
|
||||
min_version: 2.7.0
|
||||
current_version: 3.4.1
|
||||
current_version_output: ruby 3.4.1 (2024-12-25 revision 48d4efcb85)
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
- name: Tom Preston Werner Blog
|
||||
url: http://tom.preston-werner.com/
|
||||
url: https://tom.preston-werner.com/
|
||||
image: tom-preston-werner.png
|
||||
categories:
|
||||
- personal
|
||||
@@ -12,7 +12,7 @@
|
||||
# - government
|
||||
|
||||
- name: SiteLeaf
|
||||
url: https://siteleaf.com
|
||||
url: https://www.siteleaf.com/
|
||||
image: siteleaf.png
|
||||
categories:
|
||||
- software
|
||||
@@ -26,7 +26,7 @@
|
||||
- marketing-site
|
||||
|
||||
- name: Vesterheim Norwegian-American Museum
|
||||
url: http://vesterheim.org/
|
||||
url: https://vesterheim.org/
|
||||
image: vesterheim.png
|
||||
categories:
|
||||
- marketing-site
|
||||
@@ -52,7 +52,7 @@
|
||||
- marketing-site
|
||||
|
||||
- name: Bitcoin
|
||||
url: https://bitcoin.org/en/
|
||||
url: https://bitcoin.org/
|
||||
image: bitcoin.png
|
||||
categories:
|
||||
- software
|
||||
@@ -127,7 +127,7 @@
|
||||
- government
|
||||
|
||||
- name: U.S. Web Design Standards
|
||||
url: https://standards.usa.gov/
|
||||
url: https://designsystem.digital.gov/
|
||||
image: uswds.png
|
||||
categories:
|
||||
- government
|
||||
@@ -139,7 +139,7 @@
|
||||
- marketing-site
|
||||
|
||||
- name: Rehan Butt
|
||||
url: http://rehanbutt.com/
|
||||
url: https://rehanbutt.com/
|
||||
image: rehn.png
|
||||
categories:
|
||||
- personal
|
||||
@@ -165,7 +165,7 @@
|
||||
- portfolio
|
||||
|
||||
- name: Lattice
|
||||
url: https://latticehq.com/
|
||||
url: https://lattice.com/
|
||||
image: lattice.png
|
||||
categories:
|
||||
- software
|
||||
@@ -178,25 +178,25 @@
|
||||
- other
|
||||
|
||||
- name: Digital Democracy
|
||||
url: http://www.digital-democracy.org/
|
||||
url: https://www.digital-democracy.org/
|
||||
image: digital-democracy.png
|
||||
categories:
|
||||
- other
|
||||
|
||||
- name: HTML Reference
|
||||
url: http://htmlreference.io/
|
||||
url: https://htmlreference.io/
|
||||
image: htmlreference.png
|
||||
categories:
|
||||
- documentation
|
||||
|
||||
- name: CSS Reference
|
||||
url: http://cssreference.io/
|
||||
url: https://cssreference.io/
|
||||
image: cssreference.png
|
||||
categories:
|
||||
- documentation
|
||||
|
||||
- name: Chain
|
||||
url: https://chain.com/
|
||||
url: https://www.chain.com/
|
||||
image: chain.png
|
||||
categories:
|
||||
- marketing-site
|
||||
@@ -238,13 +238,6 @@
|
||||
categories:
|
||||
- government
|
||||
|
||||
- name: GitHub On Demand Training
|
||||
url: https://services.github.com/on-demand/
|
||||
image: github-learning-lab.png
|
||||
categories:
|
||||
- software
|
||||
- knowledgebase
|
||||
|
||||
- name: TwitchCon
|
||||
url: https://www.twitchcon.com/
|
||||
image: twitchcon.png
|
||||
@@ -253,13 +246,13 @@
|
||||
- conference
|
||||
|
||||
- name: UN World Statistics
|
||||
url: https://worldstatisticsday.org
|
||||
url: https://worldstatisticsday.org/
|
||||
image: world-statistics-day.png
|
||||
categories:
|
||||
- government
|
||||
|
||||
- name: Netflix Devices
|
||||
url: https://devices.netflix.com/en/
|
||||
url: https://devices.netflix.com/
|
||||
image: netflix.png
|
||||
categories:
|
||||
- marketing-site
|
||||
@@ -272,7 +265,7 @@
|
||||
- documentation
|
||||
|
||||
- name: Yeoman
|
||||
url: http://yeoman.io/
|
||||
url: https://yeoman.io/
|
||||
image: yeoman.png
|
||||
categories:
|
||||
- open-source
|
||||
@@ -292,13 +285,6 @@
|
||||
- software
|
||||
- marketing-site
|
||||
|
||||
- name: Ionic Framework
|
||||
url: https://ionicframework.com/
|
||||
image: ionic-framework.png
|
||||
categories:
|
||||
- software
|
||||
- marketing-site
|
||||
|
||||
- name: Spotify for Developers
|
||||
url: https://developer.spotify.com
|
||||
image: spotify-developers.png
|
||||
@@ -308,14 +294,14 @@
|
||||
- software
|
||||
|
||||
- name: Sketch
|
||||
url: https://sketch.com/
|
||||
url: https://www.sketch.com/
|
||||
image: sketch.png
|
||||
categories:
|
||||
- software
|
||||
- marketing-site
|
||||
|
||||
- name: Ruby on Rails
|
||||
url: http://rubyonrails.org/
|
||||
url: https://rubyonrails.org/
|
||||
image: ruby-on-rails.png
|
||||
categories:
|
||||
- marketing-site
|
||||
|
||||
@@ -7,6 +7,9 @@ Jekyll comes bundled with [jekyll-sass-converter](https://github.com/jekyll/jeky
|
||||
|
||||
You can further configure the plugin by adding options to your Jekyll config under the `sass` attribute. See the [plugin's documentation](https://github.com/jekyll/jekyll-sass-converter#usage) for details and for its default values.
|
||||
|
||||
{:.note .info}
|
||||
If you see a warning in VSCode regarding `@import "main";`, you may ignore it as the same does not affect the functionality of the SCSS code in Jekyll. However, Jekyll 4 does not allow importing a `main` sass partial (`_sass/main.scss`) from a sass page of a same name, viz. `css/main.scss`.
|
||||
|
||||
<div class="note info">
|
||||
<p>
|
||||
Note that directory paths specified in the <code>sass</code> configuration
|
||||
|
||||
@@ -57,4 +57,4 @@ This entire guide is open-source. Go ahead and [edit it][jekyll-docs-ci-buddy] i
|
||||
|
||||
[jekyll-docs-ci-buddy]: https://github.com/jekyll/jekyll/edit/master/docs/_docs/continuous-integration/buddyworks.md
|
||||
[jekyll-help]: https://jekyllrb.com/help/
|
||||
[buddy-forum]: http://forum.buddy.works/
|
||||
[buddy-forum]: https://forum.buddy.works/
|
||||
|
||||
@@ -30,8 +30,8 @@ source 'https://rubygems.org'
|
||||
|
||||
ruby '2.7.4'
|
||||
|
||||
gem 'jekyll'
|
||||
gem 'html-proofer'
|
||||
gem "jekyll"
|
||||
gem "html-proofer"
|
||||
```
|
||||
|
||||
```yaml
|
||||
|
||||
@@ -2,20 +2,35 @@
|
||||
title: GitHub Actions
|
||||
---
|
||||
|
||||
When building a Jekyll site with GitHub Pages, the standard flow is restricted for security reasons
|
||||
and to make it simpler to get a site setup. For more control over the build and still host the site
|
||||
with GitHub Pages you can use GitHub Actions.
|
||||
When building a Jekyll site with GitHub Pages, Jekyll runs in an environment restricted for security
|
||||
reasons, yet containing numerous [whitelisted plugins and themes][ghp-whitelist] to make it simpler
|
||||
to get a site set up.
|
||||
|
||||
The only workaround to have control over the build environment and gemset yet use GitHub Pages to
|
||||
host the site was previously by building elsewhere and pushing the built directory contents to the
|
||||
`gh-pages` branch on your repository.
|
||||
|
||||
However, GitHub now provides you with the option to use their in-house CI/CD product named
|
||||
*GitHub Actions* to *build and deploy (host)* your Jekyll site with complete control over the build
|
||||
environment and gemset.
|
||||
|
||||
## Advantages of using Actions
|
||||
|
||||
### Control over gemset
|
||||
|
||||
- **Jekyll version** --- Instead of using the currently enabled version at `3.9.0`, you can use any
|
||||
version of Jekyll you want. For example `{{site.version}}`, or point directly to the repository.
|
||||
- **Plugins** --- You can use any Jekyll plugins irrespective of them being on the
|
||||
[supported versions][ghp-whitelist] list, even `*.rb` files placed in the `_plugins` directory
|
||||
of your site.
|
||||
- **Themes** --- While using a custom theme is possible without Actions, it is now simpler.
|
||||
- **Jekyll version** --- Instead of using the classic GitHub Pages-provided version specified in
|
||||
the [Dependency versions][ghp-whitelist] list, you can use any version of Jekyll you want.
|
||||
For example `{{ site.version }}`, or point directly to the repository via the Gemfile.
|
||||
- **Plugins** --- You can use any Jekyll plugins irrespective of them being whitelisted by GitHub,
|
||||
including any `*.rb` files placed in the `_plugins` directory of your site.
|
||||
- **Themes** --- While using a custom theme is possible without Actions, it is now possible to use
|
||||
themes depending on features introduced in newer versions of Jekyll.
|
||||
|
||||
{: .note .info}
|
||||
If you are migrating from the classic flow but want to keep using a GitHub-hosted theme, you may use
|
||||
the [jekyll-remote-theme][remote-theme] plugin, add any required dependencies of your theme
|
||||
(previously bundled by default) into your `_config.yml` and `Gemfile` and set the
|
||||
`remote_theme: <owner>/<repo_name>` theme repository slug correctly in your `_config.yml`.
|
||||
|
||||
### Workflow Management
|
||||
|
||||
@@ -23,6 +38,8 @@ with GitHub Pages you can use GitHub Actions.
|
||||
steps, use environment variables.
|
||||
- **Logging** --- The build log is visible and can be tweaked to be verbose, so it is much easier to
|
||||
debug errors using Actions.
|
||||
- **Caching** --- The `ruby/setup-ruby` action makes it possible to cache installed gems
|
||||
automatically instead of having to download the bundle on each build.
|
||||
|
||||
## Workspace setup
|
||||
|
||||
@@ -30,18 +47,7 @@ The first and foremost requirement is a Jekyll project hosted at GitHub. Choose
|
||||
project or follow the [quickstart]({{ '/docs/' | relative_url }}) and push the repository to GitHub
|
||||
if it is not hosted there already.
|
||||
|
||||
We're only going to cover builds from the `main` branch in this page. Therefore, ensure that you
|
||||
are working on the `main` branch. If necessary, you may create it based on your default branch.
|
||||
When the Action builds your site, the contents of the _destination_ directory will be automatically
|
||||
pushed to the `gh-pages` branch with a commit, ready to be used for serving.
|
||||
|
||||
{: .note .warning}
|
||||
The Action we're using here will create (or reset an existing) `gh-pages` branch on every successful
|
||||
deploy.<br/> So, if you have an existing `gh-pages` branch that is used to deploy your production
|
||||
build, ensure to make a backup of the contents into a different branch so that you can rollback
|
||||
easily if necessary.
|
||||
|
||||
The Jekyll site we'll be using for the rest of this page initially consists of just a `_config.yml`,
|
||||
The Jekyll site we'll be using for the rest of this page, initially consists of just a `_config.yml`,
|
||||
an `index.md` page and a `Gemfile`. The contents are respectively:
|
||||
|
||||
```yaml
|
||||
@@ -71,10 +77,10 @@ Welcome to My Home Page
|
||||
|
||||
source 'https://rubygems.org'
|
||||
|
||||
gem 'jekyll', '~> 4.2'
|
||||
gem "jekyll", "~> 4.2"
|
||||
|
||||
group :jekyll_plugins do
|
||||
gem 'jekyll-timeago', '~> 0.13.1'
|
||||
gem "jekyll-timeago", "~> 0.13.1"
|
||||
end
|
||||
```
|
||||
|
||||
@@ -91,96 +97,17 @@ was generated with an old version of Bundler.
|
||||
|
||||
### Setting up the Action
|
||||
|
||||
GitHub Actions are registered for a repository by using a YAML file inside the directory path
|
||||
`.github/workflows` (note the dot at the start). For simplicity, here we use one of the
|
||||
[Jekyll Actions](#external-links) to show you how to use the action.
|
||||
|
||||
Create a **workflow file**, say `github-pages.yml`, using either the GitHub interface or by pushing
|
||||
a YAML file to the workflow directory path manually. The base contents are:
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
name: Build and deploy Jekyll site to GitHub Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main # or master before October 2020
|
||||
|
||||
jobs:
|
||||
github-pages:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/cache@v2
|
||||
with:
|
||||
path: vendor/bundle
|
||||
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-gems-
|
||||
- uses: helaili/jekyll-action@2.0.5 # Choose any one of the Jekyll Actions
|
||||
with: # Some relative inputs of your action
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
The above workflow can be explained as the following:
|
||||
|
||||
- We trigger the build using **on.push** condition for `main` branch only --- this prevents
|
||||
the Action from overwriting the `gh-pages` branch on any feature branch pushes.
|
||||
- The **name** of the job matches our YAML filename: `github-pages`.
|
||||
- The **checkout** action takes care of cloning your repository.
|
||||
- The **cache** action is an optimization to avoid fetching and installing gems on every build.
|
||||
- We specify our selected **action** and **version number** using `helaili/jekyll-action@2.0.5`,
|
||||
this handles the build and deploy. You can choose any one of the Jekyll Actions that matches
|
||||
your project and flavor from [GitHub Marketplace](https://github.com/marketplace?type=actions&query=jekyll+action).
|
||||
- We set a reference to a secret **environment variable** for the action to use. The `GITHUB_TOKEN`
|
||||
is a secret token automatically initialized at the start of every workflow run.
|
||||
More information can be found in [GitHub documentation](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret).
|
||||
|
||||
Instead of using the **on.push** condition, you could trigger your build on a **schedule** by
|
||||
using the [on.schedule] parameter. For example, here we build daily at midnight by specifying
|
||||
**cron** syntax, which can be tested at the [crontab guru] site.
|
||||
|
||||
```yaml
|
||||
on:
|
||||
schedule:
|
||||
- cron: "0 0 * * *"
|
||||
```
|
||||
|
||||
Note that this string must be quoted to prevent the asterisks from being evaluated incorrectly.
|
||||
|
||||
[on.schedule]: https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#onschedule
|
||||
[crontab guru]: https://crontab.guru/
|
||||
|
||||
### Providing permissions
|
||||
|
||||
At the start of each workflow run, GitHub automatically creates a unique `GITHUB_TOKEN` secret to use in
|
||||
your workflow. You can use the `GITHUB_TOKEN` to authenticate in a workflow run. You can use the
|
||||
`GITHUB_TOKEN` by using the standard syntax for referencing secrets: `${{ secrets.GITHUB_TOKEN }}`.
|
||||
For more information, please read [GitHub's docs on token authentication][github-token-ref]
|
||||
|
||||
[github-token-ref]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
|
||||
|
||||
If you need a token that requires permissions that aren't available in the `GITHUB_TOKEN`, you can create
|
||||
a Personal Access Token (PAT), and set it as a secret in your repository for this action to push to the
|
||||
`gh-pages` branch:
|
||||
|
||||
1. On your GitHub profile, under **Developer Settings**, go to the [Personal Access Tokens][tokens]
|
||||
section.
|
||||
2. **Create** a token. Give it a name like "GitHub Actions" and ensure it has permissions to
|
||||
`public_repos` (or the entire `repo` scope for private repository) --- necessary for the action
|
||||
to commit to the `gh-pages` branch.
|
||||
3. **Copy** the token value.
|
||||
4. Go to your repository's **Settings** and then the **Secrets** tab.
|
||||
5. **Create** a token named `YOUR_CUSTOM_TOKEN` (_important_). Give it a value using the value copied
|
||||
above.
|
||||
1. Go to the **Settings** tab on your repository.
|
||||
1. Click **Pages** under **Code and automation**.
|
||||
2. Change **Source** under **Build and deployment** from **Deploy from a branch** to **GitHub Actions**.
|
||||
2. Go to the **Actions** tab on your repository.
|
||||
1. Start a **New workflow** and search for **Jekyll**.
|
||||
2. Click **Configure** under the **Jekyll** workflow (not **GitHub Pages Jekyll** workflow).
|
||||
3. Review the change and click **Commit changes**.
|
||||
|
||||
### Build and deploy
|
||||
|
||||
On pushing any local changes onto `main`, the action will be triggered and the build will
|
||||
On pushing any local changes onto the default branch, the action will be triggered and the build will
|
||||
**start**.
|
||||
|
||||
To watch the progress and see any build errors, check on the build **status** using one of the
|
||||
@@ -193,40 +120,19 @@ following approaches:
|
||||
- **Actions tab**
|
||||
- Go to the repository's Actions tab. Click on the `jekyll` workflow tab.
|
||||
|
||||
If all goes well, all steps will be green and the built assets will now exist on the `gh-pages`
|
||||
branch.
|
||||
If all goes well, all steps will be green and the built assets will be uploaded to GitHub Pages.
|
||||
|
||||
On a successful build, GitHub Pages will **publish** the site stored on the repository `gh-pages`
|
||||
branches. Note that you do not need to setup a `gh-pages` branch or enable GitHub Pages, as the
|
||||
action will take care of this for you.
|
||||
(For private repositories, you'll have to upgrade to a paid plan).
|
||||
To see the **live site**, go to the **Deployments** tab on your repository, and click on the deployed
|
||||
site URL.
|
||||
|
||||
To see the **live site**:
|
||||
|
||||
1. Go to the **environment** tab on your repository.
|
||||
2. Click **View Deployment** to see the deployed site URL.
|
||||
3. View your site at the **URL**. Make sure the `timeago` filter works as expected.
|
||||
4. Optionally **add** this URL to your repository's main page and to your `README.md`, to make it
|
||||
easy for people to find.
|
||||
|
||||
When you need to make further **changes** to the site, commit to `master` and push. The workflow
|
||||
will build and deploy your site again.
|
||||
|
||||
Be sure **not to edit** the `gh-pages` branch directly, as any changes will be lost on the next
|
||||
successful deploy from the Action.
|
||||
When you need to make further **changes** to the site, commit to the default branch and push.
|
||||
The workflow will build and deploy your site again.
|
||||
|
||||
## External links
|
||||
|
||||
- [jekyll-actions] is an action available on the GitHub Marketplace and was used in this guide.
|
||||
- [jekyll-actions-quickstart] is an unofficial repository that includes a live demo of the
|
||||
`jekyll-actions` action. That project can be used as a template for making a new site.
|
||||
- [jekyll-action-ts] is another action to build and publish Jekyll sites on GiHub Pages that includes HTML formatting options with Prettier and caching.
|
||||
- [jekyll-deploy-action] is a GitHub Action to deploy the Jekyll site conveniently for GitHub Pages (An alternative action with better speed and compatibility).
|
||||
- [starter-workflows] is the official repository providing the workflow template used in this guide.
|
||||
|
||||
[ghp-whitelist]: https://pages.github.com/versions/
|
||||
[remote-theme]: https://github.com/benbalter/jekyll-remote-theme
|
||||
[timeago-plugin]: https://rubygems.org/gems/jekyll-timeago
|
||||
[tokens]: https://github.com/settings/tokens
|
||||
[jekyll-actions]: https://github.com/marketplace/actions/jekyll-actions
|
||||
[jekyll-actions-quickstart]: https://github.com/MichaelCurrin/jekyll-actions-quickstart
|
||||
[jekyll-action-ts]: https://github.com/limjh16/jekyll-action-ts
|
||||
[jekyll-deploy-action]: https://github.com/jeffreytse/jekyll-deploy-action
|
||||
[starter-workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
|
||||
|
||||
@@ -22,7 +22,7 @@ With [Razorops][razorops-homepage] you can set up your Jekyll websites project's
|
||||
|
||||
## 1. Getting started
|
||||
|
||||
1. Log in at [https://razorops.com/][razorops-homepage] with your GitHub/Bitbucket or Gitlab account
|
||||
1. Log in at [https://razorops.com/][razorops-homepage] with your GitHub/Bitbucket or GitLab account
|
||||
2. Create a pipeline, choose your Git provider and select your Jekyll Project
|
||||
3. Add .razorops.yaml file in your root directory of your project
|
||||
4. Add environment var and your deployment is ready
|
||||
|
||||
@@ -15,7 +15,7 @@ See the [support guidelines](https://jekyllrb.com/docs/support/)
|
||||
Whether you're a developer, a designer, or just a Jekyll devotee, there are lots of ways to contribute. Here's a few ideas:
|
||||
|
||||
- [Install Jekyll on your computer](https://jekyllrb.com/docs/installation/) and kick the tires. Does it work? Does it do what you'd expect? If not, [open an issue](https://github.com/jekyll/jekyll/issues/new) and let us know.
|
||||
- Comment on some of the project's [open issues](https://github.com/jekyll/jekyll/issues). Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?
|
||||
- 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.
|
||||
|
||||
@@ -7,7 +7,7 @@ In addition to the [built-in variables]({{'/docs/variables/' | relative_url }})
|
||||
you can specify your own custom data that can be accessed via the [Liquid
|
||||
templating system](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers).
|
||||
|
||||
Jekyll supports loading data from [YAML](http://yaml.org/), [JSON](http://www.json.org/), [CSV](https://en.wikipedia.org/wiki/Comma-separated_values), and [TSV](https://en.wikipedia.org/wiki/Tab-separated_values) files located in the `_data` directory.
|
||||
Jekyll supports loading data from [YAML](https://yaml.org), [JSON](https://www.json.org/json-en.html), [CSV](https://en.wikipedia.org/wiki/Comma-separated_values), and [TSV](https://en.wikipedia.org/wiki/Tab-separated_values) files located in the `_data` directory.
|
||||
Note that CSV and TSV files *must* contain a header row.
|
||||
|
||||
This powerful feature allows you to avoid repetition in your templates and to
|
||||
|
||||
@@ -16,12 +16,10 @@ rsync in the [Digital Ocean tutorial](https://www.digitalocean.com/community/tut
|
||||
## Amazon S3
|
||||
|
||||
If you want to host your site in Amazon S3, you can do so by
|
||||
using the [s3_website](https://github.com/laurilehmijoki/s3_website)
|
||||
application. It will push your site to Amazon S3 where it can be served like
|
||||
any web server,
|
||||
dynamically scaling to almost unlimited traffic. This approach has the
|
||||
benefit of being about the cheapest hosting option available for
|
||||
low-volume blogs as you only pay for what you use.
|
||||
using the AWS cli client and pushing your rendered `_site` directory directly to
|
||||
your S3 bucket.
|
||||
|
||||
`aws s3 sync _site s3://<YOUR DOMAIN>.com --size-only --storage-class REDUCED_REDUNDANCY`
|
||||
|
||||
## FTP
|
||||
|
||||
|
||||
@@ -10,10 +10,6 @@ The [AWS Amplify Console](https://console.amplify.aws) provides continuous deplo
|
||||
|
||||
Read this [step-by-step guide](https://medium.com/@jameshamann/deploy-your-jekyll-site-using-aws-amplify-with-only-a-few-clicks-8f3dd8f26112) to deploy and host your Jekyll site on AWS Amplify.
|
||||
|
||||
## Bip
|
||||
|
||||
[Bip](https://bip.sh) provides zero downtime deployment, a global CDN, SSL, unlimited bandwidth and more for Jekyll websites. Deploy in seconds from the command line. [Visit the Bip website](https://bip.sh) for more information - which is also built with Jekyll.
|
||||
|
||||
## CloudCannon
|
||||
|
||||
[CloudCannon](https://cloudcannon.com) has everything you need to build, host
|
||||
@@ -26,7 +22,7 @@ Sites on GitHub Pages are powered by Jekyll behind the scenes, so if you’re lo
|
||||
|
||||
## GitLab Pages
|
||||
|
||||
[GitLab Pages](https://about.gitlab.com/stages-devops-lifecycle/pages/) offers free hosting with custom domains. [Get started with Jekyll](https://docs.gitlab.com/ee/user/project/pages/getting_started_part_four.html#practical-example) and a fully customizable pipeline.
|
||||
[GitLab Pages](https://about.gitlab.com/stages-devops-lifecycle/pages/) offers free hosting with custom domains. [Get started with Jekyll](https://docs.gitlab.com/ee/user/project/pages/getting_started/pages_from_scratch.html) and a fully customizable pipeline.
|
||||
|
||||
## KeyCDN
|
||||
|
||||
@@ -35,11 +31,11 @@ The [Jekyll hosting tutorial](https://www.keycdn.com/support/jekyll-hosting) pro
|
||||
|
||||
## Kickster
|
||||
|
||||
Use [Kickster](http://kickster.nielsenramon.com/) for automated deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
|
||||
Use [Kickster](https://kickster.nielsenramon.com/) for automated deploys to GitHub Pages when using unsupported plugins on GitHub Pages.
|
||||
|
||||
Kickster provides a basic Jekyll project setup packed with web best practises and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
|
||||
Kickster provides a basic Jekyll project setup packed with web best practices and useful optimization tools increasing your overall project quality. Kickster ships with automated and worry-free deployment scripts for GitHub Pages.
|
||||
|
||||
Install the Kickster gem and you are good to go. More documentation can here found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
|
||||
Install the Kickster gem and you are good to go. More documentation can be found [here](https://github.com/nielsenramon/kickster#kickster). If you do not want to use the gem or start a new project you can just copy paste the deployment scripts for [Travis CI](https://github.com/nielsenramon/kickster/tree/master/snippets/travis) or [Circle CI](https://github.com/nielsenramon/kickster#automated-deployment-with-circle-ci).
|
||||
|
||||
## Netlify
|
||||
|
||||
@@ -72,3 +68,9 @@ Read this [Jekyll step-by-step guide](https://www.21yunbox.com/docs/#/deploy-jek
|
||||
## Layer0
|
||||
|
||||
[Layer0](https://www.layer0.co) is an all-in-one platform to develop, deploy, preview, experiment on, monitor, and run your headless frontend. It is focused on large, dynamic websites and best-in-class performance through EdgeJS (a JavaScript-based Content Delivery Network), predictive prefetching, and performance monitoring. Layer0 offers a free tier. Get started in just a few minutes by following [Layer0's guide to deploying Jekyll](https://docs.layer0.co/guides/jekyll).
|
||||
|
||||
## Kinsta Application Hosting
|
||||
[Kinsta Application Hosting](https://kinsta.com/application-hosting) is a Cloud Platform designed to help your company and dev teams ship web projects faster and more efficiently. You can host your apps, databases, and sites all in one place. Easily connect with GitHub and automate deployments and get 24/7 support for all your favorite languages and frameworks.
|
||||
|
||||
Read [this guide](https://kinsta.com/docs/jekyll-static-site-example/) to learn how to deploy Jekyll site on Kinsta.
|
||||
|
||||
|
||||
@@ -4,6 +4,399 @@ permalink: "/docs/history/"
|
||||
note: This file is autogenerated. Edit /History.markdown instead.
|
||||
---
|
||||
|
||||
## 4.4.0 / 2025-01-27
|
||||
{: #v4-4-0}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v4-4-0}
|
||||
|
||||
- Allow marking specific highlighted lines via Liquid ([#9138]({{ site.repository }}/issues/9138))
|
||||
- Add gem `csv` to runtime dependency list ([#9522]({{ site.repository }}/issues/9522))
|
||||
- Bump the minimum ruby version to 2.7 ([#9525]({{ site.repository }}/issues/9525))
|
||||
- Acknowledge `livereload_port` from site config too ([#9606]({{ site.repository }}/issues/9606))
|
||||
- Add gem `base64` as runtime dependency ([#9740]({{ site.repository }}/issues/9740))
|
||||
- Add gem `json` as runtime_dependency ([#9671]({{ site.repository }}/issues/9671))
|
||||
- Remove unnecessary constraint on gem `mercenary` ([#9758]({{ site.repository }}/issues/9758))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v4-4-0}
|
||||
|
||||
- Optimize default front matter using `File.fnmatch?` ([#9185]({{ site.repository }}/issues/9185))
|
||||
- Remove totals in profile table properly ([#9186]({{ site.repository }}/issues/9186))
|
||||
- Optimize `Site#each_site_file` ([#9187]({{ site.repository }}/issues/9187))
|
||||
- Rename sass partial created for new blank site ([#9257]({{ site.repository }}/issues/9257))
|
||||
- Fix `jekyll serve --detach` with jekyll-sass-converter 3.x ([#9304]({{ site.repository }}/issues/9304))
|
||||
- Handle TypeError from `where` filter gracefully ([#9292]({{ site.repository }}/issues/9292))
|
||||
- Add support for upcoming logger 1.4.3 ([#9392]({{ site.repository }}/issues/9392))
|
||||
- Fix typo in devcontainer.json ([#9364]({{ site.repository }}/issues/9364))
|
||||
- Correct rubocop lint errors ([#9600]({{ site.repository }}/issues/9600))
|
||||
- Fix inexistent layout warning for the default 404 page ([#9589]({{ site.repository }}/issues/9589))
|
||||
- Relax version constraint on `wdm` in new Gemfile ([#9662]({{ site.repository }}/issues/9662))
|
||||
- Fix `--livereload-ignore` option ([#9570]({{ site.repository }}/issues/9570))
|
||||
- Render theme-gem root only in development ([#9680]({{ site.repository }}/issues/9680))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v4-4-0}
|
||||
|
||||
- Cleanup highlight tag ([#9177]({{ site.repository }}/issues/9177))
|
||||
- Run tests in utc ([#9168]({{ site.repository }}/issues/9168))
|
||||
- Lock Ruby in CI to v3.1.2 and bump JRuby to v9.4.0.0 ([#9196]({{ site.repository }}/issues/9196))
|
||||
- Update sass related tests for jekyll-sass-converter 3.x ([#9223]({{ site.repository }}/issues/9223))
|
||||
- Split `test/test_tags.rb` into multiple files ([#9230]({{ site.repository }}/issues/9230))
|
||||
- test: use hash explicitly for Struct initializer for ruby 3.2 ([#9237]({{ site.repository }}/issues/9237))
|
||||
- script/default-site: accept flags for `jekyll new` ([#9259]({{ site.repository }}/issues/9259))
|
||||
- Bump check-spelling/check-spelling from 0.0.20 to 0.0.21 ([#9205]({{ site.repository }}/issues/9205))
|
||||
- Use check-spelling/check-spelling@v0.0.21 ([#9199]({{ site.repository }}/issues/9199))
|
||||
- Bump RuboCop to v1.45.x ([#9305]({{ site.repository }}/issues/9305))
|
||||
- Bump Rubocop to version 1.48.x ([#9326]({{ site.repository }}/issues/9326))
|
||||
- Bump versions of ruby & nodejs in devcontainer ([#9360]({{ site.repository }}/issues/9360))
|
||||
- Bump rubocop version to 1.52.x ([#9361]({{ site.repository }}/issues/9361))
|
||||
- Upgrade RuboCop to 1.54 ([#9401]({{ site.repository }}/issues/9401))
|
||||
- Add CodeQL workflow ([#9397]({{ site.repository }}/issues/9397))
|
||||
- Bump actions/checkout from 3 to 4 ([#9442]({{ site.repository }}/issues/9442))
|
||||
- Test suite uses shoulda-context only. ([#9441]({{ site.repository }}/issues/9441))
|
||||
- Keep activesupport at version 7.0.x ([#9469]({{ site.repository }}/issues/9469))
|
||||
- Bump Rubocop to 1.56.4 ([#9459]({{ site.repository }}/issues/9459))
|
||||
- Configure dependabot to handle rubygems dependencies ([#9445]({{ site.repository }}/issues/9445))
|
||||
- Update rubocop gem ([#9476]({{ site.repository }}/issues/9476))
|
||||
- Fix Performance/StringIdentifierArgument violation in site.rb and allow activesupport 6 for windows tests ([#9512]({{ site.repository }}/issues/9512))
|
||||
- Add a few more emeritus team members ([#9535]({{ site.repository }}/issues/9535))
|
||||
- Make custom cop inherit `RuboCop::Cop::Base` ([#9597]({{ site.repository }}/issues/9597))
|
||||
- CI: Use JRuby 9.4.8.0 ([#9654]({{ site.repository }}/issues/9654))
|
||||
- Stop testing with Cucumber on JRuby ([#9661]({{ site.repository }}/issues/9661))
|
||||
- Windows CI on GitHub Actions ([#9659]({{ site.repository }}/issues/9659))
|
||||
- Run GitHub Actions only if needed ([#9664]({{ site.repository }}/issues/9664))
|
||||
- Format `.rubocop.yml` via a rake task ([#9687]({{ site.repository }}/issues/9687))
|
||||
- Configure some new cops ([#9688]({{ site.repository }}/issues/9688))
|
||||
- Fix expected markup per WAI-ARIA requirements ([#9737]({{ site.repository }}/issues/9737))
|
||||
- Add an optional `:rdoc` group of gems ([#9742]({{ site.repository }}/issues/9742))
|
||||
- Test `inspect` filter with custom object ([#9743]({{ site.repository }}/issues/9743))
|
||||
- Bump cucumber to v9 ([#9747]({{ site.repository }}/issues/9747))
|
||||
- Add Ruby 3.4 to CI matrix ([#9740]({{ site.repository }}/issues/9740))
|
||||
- Remove unnecessary runtime dependency ([#9753]({{ site.repository }}/issues/9753))
|
||||
- Bump `check-spelling/check-spelling` action ([#9756]({{ site.repository }}/issues/9756))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Fix Nested tree navigation with recursion example ([#9174]({{ site.repository }}/issues/9174))
|
||||
- Fix typo on website ([#9203]({{ site.repository }}/issues/9203))
|
||||
- Publish post on major release of sass-converter ([#9225]({{ site.repository }}/issues/9225))
|
||||
- Update Jekyll on macOS (macos.md) and current ruby version to 3.1.3 in ruby.yml ([#9195]({{ site.repository }}/issues/9195))
|
||||
- Add release post for v4.3.2 ([#9263]({{ site.repository }}/issues/9263))
|
||||
- Grammatical reordering in 3-to-4 upgrading docs ([#9245]({{ site.repository }}/issues/9245))
|
||||
- fixed grammatical mistake on "showcase" page ([#9264]({{ site.repository }}/issues/9264))
|
||||
- Mark `highlight` `mark_lines` feature as 4.4 in docs ([#9184]({{ site.repository }}/issues/9184))
|
||||
- Add v3.9.3 release history & post to `master` branch ([#9284]({{ site.repository }}/issues/9284))
|
||||
- Update S3 deployment to remove s3_website ([#9221]({{ site.repository }}/issues/9221))
|
||||
- Document Exclude behavior, Include overrides and the default exclusion list ([#9376]({{ site.repository }}/issues/9376))
|
||||
- Update macos.md, remove Catalina (macOS 10.15) ([#9405]({{ site.repository }}/issues/9405))
|
||||
- Update macos.md, add support for Ventura ([#9406]({{ site.repository }}/issues/9406))
|
||||
- Typo fix - update to hooks and 3rd party deployment and one other article ([#9411]({{ site.repository }}/issues/9411))
|
||||
- Update 07-assets.md ([#9393]({{ site.repository }}/issues/9393))
|
||||
- Mention the front matter requirement in pages.md ([#9423]({{ site.repository }}/issues/9423))
|
||||
- Point to the Rouge GitHub repo rather than broken website ([#9362]({{ site.repository }}/issues/9362))
|
||||
- Add new theme directory to themes resources ([#9356]({{ site.repository }}/issues/9356))
|
||||
- Adds Kinsta to 3rd party deployments ([#9331]({{ site.repository }}/issues/9331))
|
||||
- Update Fedora prerequisites to include g++ ([#9290]({{ site.repository }}/issues/9290))
|
||||
- Update convert-site-to-jekyll.md ([#9348]({{ site.repository }}/issues/9348))
|
||||
- Update github-actions documentation ([#9426]({{ site.repository }}/issues/9426))
|
||||
- Update resources.md ([#9449]({{ site.repository }}/issues/9449))
|
||||
- Add GitHub Pages helpful notes ([#9235]({{ site.repository }}/issues/9235))
|
||||
- Clarify which version of Jekyll needs 'jekyll-paginate' ([#9477]({{ site.repository }}/issues/9477))
|
||||
- chore: update showcases ([#9473]({{ site.repository }}/issues/9473))
|
||||
- Add FreeBSD installation instructions ([#9481]({{ site.repository }}/issues/9481))
|
||||
- Fix broken link for the security team page ([#9497]({{ site.repository }}/issues/9497))
|
||||
- Fix broken links for several Jekyll integrations ([#9496]({{ site.repository }}/issues/9496))
|
||||
- Add release post for v4.3.3 ([#9511]({{ site.repository }}/issues/9511))
|
||||
- Add docs version badge to page_excerpts feature ([#9520]({{ site.repository }}/issues/9520))
|
||||
- Improve accessibility of the docs ([#9338]({{ site.repository }}/issues/9338))
|
||||
- Fix gem quote consistency on docs ([#9517]({{ site.repository }}/issues/9517))
|
||||
- Make site search work again ([#9530]({{ site.repository }}/issues/9530))
|
||||
- Jekyll docs template typo - All pages show "Deployment" ([#9548]({{ site.repository }}/issues/9548))
|
||||
- Fixed: Wrong navigation style on the right side of news and docs pages ([#9586]({{ site.repository }}/issues/9586))
|
||||
- Add redirect for step-by-step tutorial ([#9593]({{ site.repository }}/issues/9593))
|
||||
- Add Jekyll 3.10.0 release post & history ([#9625]({{ site.repository }}/issues/9625))
|
||||
- Fix minor docs error ([#9641]({{ site.repository }}/issues/9641))
|
||||
- Update windows.md ([#9644]({{ site.repository }}/issues/9644))
|
||||
- Document keys of global variable {% raw %}`{{ jekyll }}`{% endraw %} ([#9653]({{ site.repository }}/issues/9653))
|
||||
- Fix incorrect and inconsistent variables in the permalinks page ([#9591]({{ site.repository }}/issues/9591))
|
||||
- Fix lapses in documentation of page variables ([#9667]({{ site.repository }}/issues/9667))
|
||||
- Add note about VSCode warning for SCSS files ([#9609]({{ site.repository }}/issues/9609))
|
||||
- docs: Fix incorrect parentheses ([#9629]({{ site.repository }}/issues/9629))
|
||||
- docs: Fix of a bug in the pagination section ([#8890]({{ site.repository }}/issues/8890))
|
||||
- Update current Ruby version renders and macOS docs ([#9614]({{ site.repository }}/issues/9614))
|
||||
- Improve docs around using GitHub Actions to build and deploy Jekyll sites ([#9682]({{ site.repository }}/issues/9682))
|
||||
- Fix grammar in the description of `page.excerpt` variable ([#9689]({{ site.repository }}/issues/9689))
|
||||
- Render HTML tables at `/docs/permalinks/` using a data file ([#9666]({{ site.repository }}/issues/9666))
|
||||
- Fix HTML attribute separation whitespace placement in the Navigation include code of Assets step of the Step by Step Tutorial ([#9695]({{ site.repository }}/issues/9695))
|
||||
- Fix missing glob matching pattern support description in the documentation of the `include` and `exclude` configuration options ([#9697]({{ site.repository }}/issues/9697))
|
||||
- Fix missing `url` configuration option documentation ([#9699]({{ site.repository }}/issues/9699))
|
||||
- Link to GitHub Pages Dependency versions page instead of explicitly specifying Jekyll version ([#9715]({{ site.repository }}/issues/9715))
|
||||
- Fix broken link on third-party.md ([#9704]({{ site.repository }}/issues/9704))
|
||||
- Fix: remove inaccessible links and their descriptions ([#9745]({{ site.repository }}/issues/9745))
|
||||
- Add release post for v4.4.0 ([#9759]({{ site.repository }}/issues/9759))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v4-4-0}
|
||||
|
||||
- Extract markup for `Improve this page` into an inclusion ([#9675]({{ site.repository }}/issues/9675))
|
||||
|
||||
|
||||
## 4.3.4 / 2024-09-16
|
||||
{: #v4-3-4}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v4-3-4}
|
||||
|
||||
- Backport [#9662]({{ site.repository }}/issues/9662) for v4.3.x: Relax version constraint on wdm in new Gemfile ([#9683]({{ site.repository }}/issues/9683))
|
||||
- Backport [#9680]({{ site.repository }}/issues/9680) for v4.3.x: Render theme-gem root only in development ([#9684]({{ site.repository }}/issues/9684))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v4-3-4}
|
||||
|
||||
- Sync workflows with counterparts on `master` ([#9681]({{ site.repository }}/issues/9681))
|
||||
|
||||
|
||||
## 4.3.3 / 2023-12-27
|
||||
{: #v4-3-3}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v4-3-3}
|
||||
|
||||
- Backport [#9392]({{ site.repository }}/issues/9392) for v4.3.x: Fix backward compatibility issues in the Logger ([#9510]({{ site.repository }}/issues/9510))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v4-3-3}
|
||||
|
||||
- Backport [#9237]({{ site.repository }}/issues/9237) for v4.3.x: Use Hash explicitly for Struct initializer ([#9285]({{ site.repository }}/issues/9285))
|
||||
|
||||
|
||||
## 3.10.0 / 2024-06-23
|
||||
{: #v3-10-0}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-10-0}
|
||||
|
||||
- Backport add-csv-dependency from [#9522]({{ site.repository }}/issues/9522) to Jekyll 3 ([#9616]({{ site.repository }}/issues/9616))
|
||||
- 3.10-stable: Add webrick as a dependency ([#9620]({{ site.repository }}/issues/9620))
|
||||
|
||||
|
||||
## 3.9.5 / 2024-02-12
|
||||
{: #v3-9-5}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v3-9-5}
|
||||
|
||||
- 3.9-stable: allow Pages to be Excerpted ([#9550]({{ site.repository }}/issues/9550))
|
||||
|
||||
|
||||
## 3.9.4 / 2023-12-28
|
||||
{: #v3-9-4}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-9-4}
|
||||
|
||||
- Backport [#9392]({{ site.repository }}/issues/9392) for v3.9.x: Add support for Ruby 3.3 Logger ([#9513]({{ site.repository }}/issues/9513))
|
||||
|
||||
|
||||
## 3.9.3 / 2023-01-29
|
||||
{: #v3-9-3}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v3-9-3}
|
||||
|
||||
- 3.9.x: Support i18n 1.x ([#9269]({{ site.repository }}/issues/9269))
|
||||
- Backport [#8880]({{ site.repository }}/issues/8880) for v3.9.x: Support both tzinfo v1 and v2 along with non-half hour offsets ([#9280]({{ site.repository }}/issues/9280))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v3-9-3}
|
||||
|
||||
- v3.9.x: test under Ruby 3.2 [#9272]({{ site.repository }}/issues/9272))
|
||||
- v3.9.x: fix rdiscount test ([#9277]({{ site.repository }}/issues/9277))
|
||||
|
||||
|
||||
## 4.3.2 / 2023-01-20
|
||||
{: #v4-3-2}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v4-3-2}
|
||||
|
||||
- Backport [#9257]({{ site.repository }}/issues/9257) for v4.3.x: Rename sass partial created for new blank site ([#9262]({{ site.repository }}/issues/9262))
|
||||
- Backport [#9187]({{ site.repository }}/issues/9187) for v4.3.x: Optimize `Site#each_site_file` ([#9256]({{ site.repository }}/issues/9256))
|
||||
- Backport [#9186]({{ site.repository }}/issues/9186) for v4.3.x: Remove totals in profile table properly ([#9255]({{ site.repository }}/issues/9255))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v4-3-2}
|
||||
|
||||
- Backport [#9223]({{ site.repository }}/issues/9223) for 4.3.x: Update sass related tests for jekyll-sass-converter 3.x ([#9254]({{ site.repository }}/issues/9254))
|
||||
|
||||
|
||||
## 4.3.1 / 2022-10-26
|
||||
{: #v4-3-1}
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v4-3-1}
|
||||
|
||||
- Respect user-defined name attribute in documents ([#9167]({{ site.repository }}/issues/9167))
|
||||
- Revert "Incrementally rebuild when a data file is changed" ([#9170]({{ site.repository }}/issues/9170))
|
||||
|
||||
### Documentation
|
||||
|
||||
- Release post for v4.3.1 ([#9171]({{ site.repository }}/issues/9171))
|
||||
|
||||
|
||||
## 4.3.0 / 2022-10-20
|
||||
{: #v4-3-0}
|
||||
|
||||
### Minor Enhancements
|
||||
{: #minor-enhancements-v4-3-0}
|
||||
|
||||
- Add webrick as a dependency ([#8524]({{ site.repository }}/issues/8524))
|
||||
- Regenerate supported mime types ([#8542]({{ site.repository }}/issues/8542))
|
||||
- Update include tag to be more permissive ([#8618]({{ site.repository }}/issues/8618))
|
||||
- Optimize `Jekyll::Utils.parse_date` ([#8425]({{ site.repository }}/issues/8425))
|
||||
- Update rubocop from 1.12 to 1.18 and min ruby from 2.4 to 2.5 ([#8741]({{ site.repository }}/issues/8741))
|
||||
- Always hide cache-dir contents from Git ([#8798]({{ site.repository }}/issues/8798))
|
||||
- Remove the warning about auto-regeneration on Windows ([#8821]({{ site.repository }}/issues/8821))
|
||||
- Propagate _data folder from theme ([#8815]({{ site.repository }}/issues/8815))
|
||||
- Support both tzinfo v1 and v2 along with non-half hour offsets. ([#8880]({{ site.repository }}/issues/8880))
|
||||
- Run vendor-mimes to update mime.types ([#8940]({{ site.repository }}/issues/8940))
|
||||
- Expose collection static files via `site.static_files` ([#8961]({{ site.repository }}/issues/8961))
|
||||
- Expose `basename` from `document.rb` as `name` to Liquid templates ([#8761]({{ site.repository }}/issues/8761))
|
||||
- Allow Configurable Converters on CSV ([#8858]({{ site.repository }}/issues/8858))
|
||||
- Introduce `theme` drop to expose theme-gem details ([#9129]({{ site.repository }}/issues/9129))
|
||||
- Relax version constraint to allow Rouge 4.x ([#9134]({{ site.repository }}/issues/9134))
|
||||
- Incrementally rebuild when a data file is changed ([#8771]({{ site.repository }}/issues/8771))
|
||||
- Support jekyll-sass-converter 3.x ([#9132]({{ site.repository }}/issues/9132))
|
||||
|
||||
### Bug Fixes
|
||||
{: #bug-fixes-v4-3-0}
|
||||
|
||||
- fix: pin rubocop to 1.12 due to error with ruby 2.4 ([#8651]({{ site.repository }}/issues/8651))
|
||||
- Load Jekyll plugins from BUNDLE_GEMFILE location ([#8585]({{ site.repository }}/issues/8585))
|
||||
- fix(security): CVE-2021-28834 ([#8680]({{ site.repository }}/issues/8680))
|
||||
- Inject livereload script using `location.protocol` instead of `http:` ([#8718]({{ site.repository }}/issues/8718))
|
||||
- Respect collections_dir config within include tag ([#8756]({{ site.repository }}/issues/8756))
|
||||
- Fix regression in Convertible module from v4.2.0 ([#8786]({{ site.repository }}/issues/8786))
|
||||
- Revert [#7253]({{ site.repository }}/issues/7253): "Don't reset site.url to localhost:4000 by default" ([#8620]({{ site.repository }}/issues/8620))
|
||||
- Improve readability of CI logs ([#8877]({{ site.repository }}/issues/8877))
|
||||
- Fix deprecation message for missing doc method ([#8960]({{ site.repository }}/issues/8960))
|
||||
- Fix response header for content served via `jekyll serve` ([#8965]({{ site.repository }}/issues/8965))
|
||||
- Trigger livereload in sites without pages ([#8337]({{ site.repository }}/issues/8337))
|
||||
- Only enable BOM encoding option on UTF encodings ([#8363]({{ site.repository }}/issues/8363))
|
||||
- Ensure theme config is a `Jekyll::Configuration` object ([#8988]({{ site.repository }}/issues/8988))
|
||||
- Remove misleading totals row from `--profile` table ([#9039]({{ site.repository }}/issues/9039))
|
||||
- Unlock Psych dependency ([#9135]({{ site.repository }}/issues/9135))
|
||||
- Fix false positive conflicts for static files in a collection ([#9141]({{ site.repository }}/issues/9141))
|
||||
|
||||
### Development Fixes
|
||||
{: #development-fixes-v4-3-0}
|
||||
|
||||
- style: enable new cops ([#8538]({{ site.repository }}/issues/8538))
|
||||
- Allow dependabot to keep github actions up-to-date ([#8540]({{ site.repository }}/issues/8540))
|
||||
- Update actions/cache requirement to v2.1.3 ([#8543]({{ site.repository }}/issues/8543))
|
||||
- Pin rubocop version ([#8564]({{ site.repository }}/issues/8564))
|
||||
- style: add rubocop 1.9 cops ([#8567]({{ site.repository }}/issues/8567))
|
||||
- Cross Version Testing Locally and Faster CI ([#8610]({{ site.repository }}/issues/8610))
|
||||
- Use official Ruby setup GH action ([#8614]({{ site.repository }}/issues/8614))
|
||||
- Spell check action for markdown documentation ([#8675]({{ site.repository }}/issues/8675))
|
||||
- Update expect to cover docs/_posts ([#8677]({{ site.repository }}/issues/8677))
|
||||
- Bump check-spelling/check-spelling from 0.0.18 to 0.0.19 ([#8740]({{ site.repository }}/issues/8740))
|
||||
- Enable Rubocop accessor grouping, fix existing offenses ([#8293]({{ site.repository }}/issues/8293))
|
||||
- Tags:Highlight: Decomposed HTMLLegacy formatter ([#8623]({{ site.repository }}/issues/8623))
|
||||
- Relax Rubocop Dependency ([#8831]({{ site.repository }}/issues/8831))
|
||||
- Add a workflow to build gems consistently ([#8830]({{ site.repository }}/issues/8830))
|
||||
- Fix random test failures in TestExcerpt #to_liquid ([#8884]({{ site.repository }}/issues/8884))
|
||||
- Lock gem `psych` to `v3.x` ([#8918]({{ site.repository }}/issues/8918))
|
||||
- Fix typo in Bug Report template ([#8951]({{ site.repository }}/issues/8951))
|
||||
- Check symlink outside site_source without Pathutil ([#9015]({{ site.repository }}/issues/9015))
|
||||
- Stop testing with Rubies older than 2.7 on non-Windows ([#8955]({{ site.repository }}/issues/8955))
|
||||
- Bump actions/checkout from 2 to 3 ([#8986]({{ site.repository }}/issues/8986))
|
||||
- Remove git.io shortlinks from repo ([#9045]({{ site.repository }}/issues/9045))
|
||||
- Bump rubocop to 1.32 ([#9093]({{ site.repository }}/issues/9093))
|
||||
- Bump RuboCop to `1.36.x` ([#9125]({{ site.repository }}/issues/9125))
|
||||
- Use check-spelling/check-spelling@v0.0.20 ([#9111]({{ site.repository }}/issues/9111))
|
||||
- Disable pending cops when running rubocop ([#9136]({{ site.repository }}/issues/9136))
|
||||
- Relax RDoc version dependency ([#9142]({{ site.repository }}/issues/9142))
|
||||
|
||||
### Documentation
|
||||
|
||||
- typo - do instead of don't ([#8518]({{ site.repository }}/issues/8518))
|
||||
- Document support for TSV files consistently ([#8488]({{ site.repository }}/issues/8488))
|
||||
- Add a disclaimer to tutorials involving Ruby code ([#8525]({{ site.repository }}/issues/8525))
|
||||
- Improve documentation on developing generators ([#8527]({{ site.repository }}/issues/8527))
|
||||
- Fixes typo in layouts_dir documentation ([#8532]({{ site.repository }}/issues/8532))
|
||||
- Fix i.e. typos in collections.md ([#8529]({{ site.repository }}/issues/8529))
|
||||
- Remove GitHub Pages content which is in GitHub docs ([#8533]({{ site.repository }}/issues/8533))
|
||||
- Step By Step Instructions Review ([#8399]({{ site.repository }}/issues/8399))
|
||||
- Fix typo in migrating from 3.0 to 4.0 page ([#8572]({{ site.repository }}/issues/8572))
|
||||
- Fix for important missing step in macOS Installation Docs: Add the Homebrew gems directory to the PATH ([#8496]({{ site.repository }}/issues/8496))
|
||||
- Use latest Jekyll-action configuration ([#8579]({{ site.repository }}/issues/8579))
|
||||
- docs: troubleshoot macOS with ARM64 architecture ([#8560]({{ site.repository }}/issues/8560))
|
||||
- docs: add overview of .jekyll-cache dir ([#8648]({{ site.repository }}/issues/8648))
|
||||
- docs: clarify where .jekyll-metadata comes from ([#8646]({{ site.repository }}/issues/8646))
|
||||
- Razorops CI/CD added ([#8656]({{ site.repository }}/issues/8656))
|
||||
- Specify default port and host for serve commands in docs ([#8624]({{ site.repository }}/issues/8624))
|
||||
- Update third-party.md ([#8652]({{ site.repository }}/issues/8652))
|
||||
- Add documentation for Sass configuration options ([#8587]({{ site.repository }}/issues/8587))
|
||||
- Add formcarry to forms section ([#8471]({{ site.repository }}/issues/8471))
|
||||
- Add step to set SDKROOT ([#8478]({{ site.repository }}/issues/8478))
|
||||
- Improve the "Markdown Options" Docs ([#8681]({{ site.repository }}/issues/8681))
|
||||
- Add 'webrick' warning note to "Quickstart" Docs ([#8727]({{ site.repository }}/issues/8727))
|
||||
- Update windows.md ([#8701]({{ site.repository }}/issues/8701))
|
||||
- IRC networks - Libera, Freenode ([#8706]({{ site.repository }}/issues/8706))
|
||||
- Improve GitHub Flavored Markdown Docs ([#8684]({{ site.repository }}/issues/8684))
|
||||
- Fixing URL in MacOS install for rbenv-doctor ([#8693]({{ site.repository }}/issues/8693))
|
||||
- Fix adjective in `troubleshooting.md` document ([#8777]({{ site.repository }}/issues/8777))
|
||||
- Goodbye Frank. We'll miss you. 💔 ([#8807]({{ site.repository }}/issues/8807))
|
||||
- Update index.html: Grammar fix. ([#8803]({{ site.repository }}/issues/8803))
|
||||
- Prefer Libera. Remove Freenode. ([#8811]({{ site.repository }}/issues/8811))
|
||||
- Update feature_request.md ([#8797]({{ site.repository }}/issues/8797))
|
||||
- Remove AWS Amplify from the showcase ([#8812]({{ site.repository }}/issues/8812))
|
||||
- Move Frank to Emeritus Core Team Members ([#8813]({{ site.repository }}/issues/8813))
|
||||
- Release post for v4.2.1 ([#8818]({{ site.repository }}/issues/8818))
|
||||
- Update CircleCI example ([#8829]({{ site.repository }}/issues/8829))
|
||||
- Fix typo ([#8835]({{ site.repository }}/issues/8835))
|
||||
- Added docs for running locally ([#8852]({{ site.repository }}/issues/8852))
|
||||
- Linting README.markdown ([#8900]({{ site.repository }}/issues/8900))
|
||||
- Remove text on GITHUB_TOKEN which is now built-in ([#8907]({{ site.repository }}/issues/8907))
|
||||
- Add Security Policy document ([#8823]({{ site.repository }}/issues/8823))
|
||||
- Manage repository meta documents consistently ([#8908]({{ site.repository }}/issues/8908))
|
||||
- docs: add Layer0 deployment guide ([#8915]({{ site.repository }}/issues/8915))
|
||||
- docs: Update README generated by `jekyll new-theme` ([#8919]({{ site.repository }}/issues/8919))
|
||||
- Update resources.md ([#8925]({{ site.repository }}/issues/8925))
|
||||
- Rewrite documentation on installing plugins ([#8921]({{ site.repository }}/issues/8921))
|
||||
- Improve maintainers guide on releasing a new version ([#8928]({{ site.repository }}/issues/8928))
|
||||
- Fix link for "CloudSh" ([#8934]({{ site.repository }}/issues/8934))
|
||||
- Recommend using `actions/cache` in GitHub Actions documentation ([#8948]({{ site.repository }}/issues/8948))
|
||||
- Remove references to EOL hakiri.io service ([#8946]({{ site.repository }}/issues/8946))
|
||||
- Release post for v4.2.2 ([#8982]({{ site.repository }}/issues/8982))
|
||||
- Document releasing off `*-stable` branches ([#8984]({{ site.repository }}/issues/8984))
|
||||
- Update document by fix yaml syntax error ([#8991]({{ site.repository }}/issues/8991))
|
||||
- Enhance option's case for Jekyll configuration ([#8992]({{ site.repository }}/issues/8992))
|
||||
- Fix typo in `_docs/deployment/manual.md` ([#8997]({{ site.repository }}/issues/8997))
|
||||
- Add quiet/verbose options ([#8996]({{ site.repository }}/issues/8996))
|
||||
- Update README.markdown re IRC Pointer ([#9005]({{ site.repository }}/issues/9005))
|
||||
- Remove Aerobatic ([#9007]({{ site.repository }}/issues/9007))
|
||||
- Add Jekyll 3.9.2 release post to 'master' branch ([#9013]({{ site.repository }}/issues/9013))
|
||||
- Simplify macOS installation docs ([#8993]({{ site.repository }}/issues/8993))
|
||||
- Improve document about GitHub Actions section ([#8853]({{ site.repository }}/issues/8853))
|
||||
- Update permalinks.md ([#9017]({{ site.repository }}/issues/9017))
|
||||
- Add clarity to docs on permalinks placeholders and built-ins ([#8995]({{ site.repository }}/issues/8995))
|
||||
- Remove Ionic Framework site from showcase ([#9057]({{ site.repository }}/issues/9057))
|
||||
- Windows: describe which option to choose ([#9049]({{ site.repository }}/issues/9049))
|
||||
- Improve links (http -> https) ([#9064]({{ site.repository }}/issues/9064))
|
||||
- Update ruby version for macos guide ([#9086]({{ site.repository }}/issues/9086))
|
||||
- Update posts.md ([#9151]({{ site.repository }}/issues/9151))
|
||||
- Release post for v4.3.0 ([#9157]({{ site.repository }}/issues/9157))
|
||||
|
||||
### Site Enhancements
|
||||
{: #site-enhancements-v4-3-0}
|
||||
|
||||
- Improvements to CSS ([#7834]({{ site.repository }}/issues/7834))
|
||||
- Slightly update lang `sh` code-block styling ([#8857]({{ site.repository }}/issues/8857))
|
||||
|
||||
|
||||
## 4.2.2 / 2022-03-03
|
||||
{: #v4-2-2}
|
||||
|
||||
@@ -1171,7 +1564,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- make flakey test more robust ([#6277]({{ site.repository }}/issues/6277))
|
||||
- Add a quick test for DataReader ([#6284]({{ site.repository }}/issues/6284))
|
||||
- script/backport-pr: commit message no longer includes the `#` ([#6289]({{ site.repository }}/issues/6289))
|
||||
- Add Add CODEOWNERS file to help automate reviews. ([#6320]({{ site.repository }}/issues/6320))
|
||||
- Add CODEOWNERS file to help automate reviews. ([#6320]({{ site.repository }}/issues/6320))
|
||||
- Fix builds on codeclimate ([#6333]({{ site.repository }}/issues/6333))
|
||||
- Bump rubies on Travis ([#6366]({{ site.repository }}/issues/6366))
|
||||
|
||||
@@ -2330,7 +2723,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Fixed an unclear code comment in site template SCSS ([#3837]({{ site.repository }}/issues/3837))
|
||||
- Fix reading of binary metadata file ([#3845]({{ site.repository }}/issues/3845))
|
||||
- Remove var collision with site template header menu iteration variable ([#3838]({{ site.repository }}/issues/3838))
|
||||
- Change non-existent `hl_linenos` to `hl_lines` to allow passthrough in safe mode ([#3787]({{ site.repository }}/issues/3787))
|
||||
- Change nonexistent `hl_linenos` to `hl_lines` to allow passthrough in safe mode ([#3787]({{ site.repository }}/issues/3787))
|
||||
- Add missing flag to disable the watcher ([#3820]({{ site.repository }}/issues/3820))
|
||||
- Update CI guide to include more direct explanations of the flow ([#3891]({{ site.repository }}/issues/3891))
|
||||
- Set `future` to `false` in the default config ([#3892]({{ site.repository }}/issues/3892))
|
||||
@@ -2667,7 +3060,7 @@ note: This file is autogenerated. Edit /History.markdown instead.
|
||||
- Document the `name` variable for collection permalinks ([#2829]({{ site.repository }}/issues/2829))
|
||||
- Adds info about installing jekyll in current dir ([#2839]({{ site.repository }}/issues/2839))
|
||||
- Remove deprecated `jekyll-projectlist` plugin from list of third-party plugins ([#2742]({{ site.repository }}/issues/2742))
|
||||
- Remove tag plugins that are built in to Jekyll ([#2751]({{ site.repository }}/issues/2751))
|
||||
- Remove tag plugins that are built into Jekyll ([#2751]({{ site.repository }}/issues/2751))
|
||||
- Add `markdown-writer` package for Atom Editor to list of third-party plugins ([#2763]({{ site.repository }}/issues/2763))
|
||||
- Fix typo in site documentation for collections ([#2764]({{ site.repository }}/issues/2764))
|
||||
- Fix minor typo on plugins docs page ([#2765]({{ site.repository }}/issues/2765))
|
||||
|
||||
@@ -85,7 +85,7 @@ For example, suppose you have a special image syntax with complex formatting, an
|
||||
|
||||
```html
|
||||
<figure>
|
||||
<a href="http://jekyllrb.com">
|
||||
<a href="https://jekyllrb.com">
|
||||
<img src="logo.png" style="max-width: 200px;"
|
||||
alt="Jekyll logo" />
|
||||
</a>
|
||||
|
||||
@@ -18,5 +18,6 @@ For detailed install instructions, follow the guide for your operating system.
|
||||
|
||||
* [macOS]({{ '/docs/installation/macos/' | relative_url }})
|
||||
* [Ubuntu]({{ '/docs/installation/ubuntu/' | relative_url }})
|
||||
* [FreeBSD]({{ '/docs/installation/freebsd/' | relative_url }})
|
||||
* [Other Linux]({{ '/docs/installation/other-linux/' | relative_url }})
|
||||
* [Windows]({{ '/docs/installation/windows/' | relative_url }})
|
||||
50
docs/_docs/installation/freebsd.md
Normal file
50
docs/_docs/installation/freebsd.md
Normal file
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Jekyll on FreeBSD
|
||||
permalink: /docs/installation/freebsd/
|
||||
---
|
||||
|
||||
### Install Ruby
|
||||
|
||||
```sh
|
||||
sudo pkg install ruby
|
||||
```
|
||||
|
||||
### Install Ruby Gems
|
||||
|
||||
Find the latest version and install it. (Replace `ruby3x` with whatever the latest version is.)
|
||||
|
||||
```sh
|
||||
pkg search gems
|
||||
sudo pkg install ruby3x-gems
|
||||
```
|
||||
|
||||
## Set Gems directory and add that to the Bash path
|
||||
|
||||
Avoid installing RubyGems packages (called gems) as the root user. Instead,
|
||||
set up a gem installation directory for your user account. The following
|
||||
commands will add environment variables to your `~/.bashrc` file to configure
|
||||
the gem installation path:
|
||||
|
||||
```sh
|
||||
echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
|
||||
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
|
||||
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
|
||||
source ~/.bashrc
|
||||
```
|
||||
|
||||
## Install Jekyll Gems
|
||||
|
||||
```sh
|
||||
gem install jekyll bundler jekyll-sitemap
|
||||
```
|
||||
|
||||
## Verify install
|
||||
|
||||
Both of these commands should return some output showing version number, etc.
|
||||
|
||||
```sh
|
||||
ruby -v
|
||||
jekyll -v
|
||||
```
|
||||
|
||||
That's it! You're ready to start using Jekyll.
|
||||
@@ -5,9 +5,7 @@ permalink: /docs/installation/macos/
|
||||
|
||||
## Supported macOS versions
|
||||
|
||||
- Monterey (macOS 12)
|
||||
- Big Sur (macOS 11)
|
||||
- Catalina (macOS 10.15)
|
||||
We match [Homebrew's macOS requirements](https://docs.brew.sh/Installation#macos-requirements), which typically support the last 2 or 3 macOS versions.
|
||||
|
||||
Older macOS versions might work, but we don't officially support them.
|
||||
|
||||
@@ -51,10 +49,10 @@ Install `chruby` and `ruby-install` with Homebrew:
|
||||
brew install chruby ruby-install
|
||||
```
|
||||
|
||||
Install the latest stable version of Ruby:
|
||||
Install the latest stable version of Ruby (supported by Jekyll):
|
||||
|
||||
```sh
|
||||
ruby-install ruby
|
||||
ruby-install ruby {{ site.data.ruby.current_version }}
|
||||
```
|
||||
|
||||
This will take a few minutes, and once it's done, configure your shell to
|
||||
@@ -63,7 +61,7 @@ automatically use `chruby`:
|
||||
```sh
|
||||
echo "source $(brew --prefix)/opt/chruby/share/chruby/chruby.sh" >> ~/.zshrc
|
||||
echo "source $(brew --prefix)/opt/chruby/share/chruby/auto.sh" >> ~/.zshrc
|
||||
echo "chruby ruby-{{ site.data.ruby.current_version }}" >> ~/.zshrc
|
||||
echo "chruby ruby-{{ site.data.ruby.current_version }}" >> ~/.zshrc # run 'chruby' to see actual version
|
||||
```
|
||||
|
||||
If you're using Bash, replace `.zshrc` with `.bash_profile`. If you're not sure,
|
||||
|
||||
@@ -10,7 +10,7 @@ Installation on other Linux distributions works similarly to installing on [Ubun
|
||||
### Fedora
|
||||
|
||||
```sh
|
||||
sudo dnf install ruby ruby-devel openssl-devel redhat-rpm-config @development-tools
|
||||
sudo dnf install ruby ruby-devel openssl-devel redhat-rpm-config gcc-c++ @development-tools
|
||||
```
|
||||
### RHEL8/CentOS8
|
||||
|
||||
|
||||
@@ -23,7 +23,8 @@ We only cover RubyInstaller-2.4 and newer here. Older versions need to
|
||||
Use default options for installation.
|
||||
2. Run the `ridk install` step on the last stage of the installation wizard. This is needed for installing gems with native
|
||||
extensions. You can find additional information regarding this in the
|
||||
[RubyInstaller Documentation](https://github.com/oneclick/rubyinstaller2#using-the-installer-on-a-target-system)
|
||||
[RubyInstaller Documentation](https://github.com/oneclick/rubyinstaller2#using-the-installer-on-a-target-system).
|
||||
From the options choose `MSYS2 and MINGW development toolchain`.
|
||||
3. Open a new command prompt window from the start menu, so that changes to the `PATH` environment variable becomes effective.
|
||||
Install Jekyll and Bundler using `gem install jekyll bundler`
|
||||
4. Check if Jekyll has been installed properly: `jekyll -v`
|
||||
@@ -137,7 +138,7 @@ While `listen` has built-in support for UNIX systems, it may require an extra ge
|
||||
Add the following to the `Gemfile` for your site if you have issues with auto-regeneration on Windows alone:
|
||||
|
||||
```ruby
|
||||
gem 'wdm', '~> 0.1.1', :install_if => Gem.win_platform?
|
||||
gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?
|
||||
```
|
||||
|
||||
You have to use a [Ruby+Devkit](https://rubyinstaller.org/downloads/) version of the RubyInstaller and install
|
||||
|
||||
@@ -15,7 +15,7 @@ If you have page snippets that you use repeatedly across your site, an
|
||||
## Code snippet highlighting
|
||||
|
||||
Jekyll has built in support for syntax highlighting of over 100 languages
|
||||
thanks to [Rouge](http://rouge.jneen.net). Rouge is the default highlighter
|
||||
thanks to [Rouge](https://github.com/rouge-ruby/rouge). Rouge is the default highlighter
|
||||
in Jekyll 3 and above.
|
||||
|
||||
{: .note .warning}
|
||||
@@ -66,6 +66,26 @@ end
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### Marking specific lines {%- include docs_version_badge.html version="4.4.0" -%}
|
||||
{: #marking-specific-lines }
|
||||
|
||||
You can mark specific lines in a code snippet by using the optional
|
||||
argument `mark_lines`. This argument takes a space-separated list of
|
||||
line numbers which must be wrapped in double quotes. For example, the
|
||||
following code block will mark lines 1 and 2 but not line 3:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
{% highlight ruby mark_lines="1 2" %}
|
||||
def foo
|
||||
puts 'foo'
|
||||
end
|
||||
{% endhighlight %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
A default class name of `hll` will be applied to the marked lines.
|
||||
|
||||
### Stylesheets for syntax highlighting
|
||||
|
||||
In order for the highlighting to show up, you’ll need to include a highlighting
|
||||
|
||||
@@ -20,7 +20,7 @@ If the issue describes a feature request, ask:
|
||||
|
||||
1. Is this a setting? [Settings are a crutch](http://ben.balter.com/2016/03/08/optimizing-for-power-users-and-edge-cases/#settings-are-a-crutch) for doing "the right thing". Settings usually point to a bad default or an edge case that could be solved easily with a plugin. Keep the :christmas_tree: of settings as small as possible so as not to reduce the usability of the product. We like the philosophy "decisions not options."
|
||||
2. Would at least 80% of users find it useful? If even a quarter of our users won't use it, it's very likely that the request doesn't fit our product's core goal.
|
||||
3. Is there another way to accomplish the end goal of the request? Most feature requests are due to bad documentation for or understanding of a pre-existing feature. See if you can clarify the end goal of the request. What is the user trying to do? Could they accomplish that goal through another feature we already support?
|
||||
3. Is there another way to accomplish the end goal of the request? Most feature requests are due to bad documentation for or understanding of a preexisting feature. See if you can clarify the end goal of the request. What is the user trying to do? Could they accomplish that goal through another feature we already support?
|
||||
4. Even if 80% of our users will use it, does it fit the core goal of our project? We are writing a tool for making static websites, not a swiss army knife for publishing more generally.
|
||||
|
||||
Feel free to get others' opinions and ask questions of the issue author, but depending upon the answers to the questions above, it may be out of scope for our project.
|
||||
|
||||
@@ -9,7 +9,7 @@ members or recipes).
|
||||
|
||||
The simplest way of adding a page is to add an HTML file in the root
|
||||
directory with a suitable filename. You can also write a page in Markdown using
|
||||
a `.md` extension which converts to HTML on build. For a site with
|
||||
a `.md` extension and front matter which converts to HTML on build. For a site with
|
||||
a homepage, an about page, and a contact page, here’s what the root directory
|
||||
and associated URLs might look like:
|
||||
|
||||
@@ -35,7 +35,6 @@ If you have a lot of pages, you can organize them into subfolders. The same subf
|
||||
|
||||
You might want to have a particular folder structure for your source files that changes for the built site. With [permalinks](/docs/permalinks/) you have full control of the output URL.
|
||||
|
||||
## Excerpts for pages
|
||||
## Excerpts for pages {%- include docs_version_badge.html version="4.1.1" -%}
|
||||
|
||||
From Jekyll 4.1.1 onwards, one can *choose* to generate excerpts for their pages by setting `page_excerpts` to `true` in their
|
||||
config file.
|
||||
One can *choose* to generate excerpts for their pages by setting `page_excerpts` to `true` in their config file.
|
||||
|
||||
@@ -8,8 +8,9 @@ break the main listing of posts up into smaller lists and display them over
|
||||
multiple pages. Jekyll offers a pagination plugin, so you can automatically
|
||||
generate the appropriate files and folders you need for paginated listings.
|
||||
|
||||
For Jekyll 3, include the `jekyll-paginate` plugin in your Gemfile and in
|
||||
your `_config.yml` under `plugins`. For Jekyll 2, this is standard.
|
||||
For Jekyll 3 or higher, include the `jekyll-paginate` plugin in your
|
||||
Gemfile and in your `_config.yml` under `plugins`. For Jekyll 2, this is
|
||||
standard.
|
||||
|
||||
<div class="note info">
|
||||
<h5>Pagination only works within HTML files</h5>
|
||||
@@ -154,7 +155,7 @@ page with links to all but the current page.
|
||||
{% if page == paginator.page %}
|
||||
<em>{{ page }}</em>
|
||||
{% elsif page == 1 %}
|
||||
<a href="{{ '/' | relative_url }}">{{ page }}</a>
|
||||
<a href="{{ site.paginate_path | relative_url | replace: 'page:num/', '' }}">{{ page }}</a>
|
||||
{% else %}
|
||||
<a href="{{ site.paginate_path | relative_url | replace: ':num', page }}">{{ page }}</a>
|
||||
{% endif %}
|
||||
|
||||
@@ -55,229 +55,16 @@ Here's the full list of placeholders available:
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{%- for entry in site.data.permalinks.placeholders %}
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>year</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Year from the post’s filename with four digits.
|
||||
May be overridden via the document’s <code>date</code> front matter.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>short_year</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Year from the post’s filename without the century. (00..99)
|
||||
May be overridden via the document’s <code>date</code> front matter.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>month</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Month from the post’s filename. (01..12)
|
||||
May be overridden via the document’s <code>date</code> front matter.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>i_month</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Month without leading zeros from the post’s filename. May be
|
||||
overridden via the document’s <code>date</code> front matter.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>short_month</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Three-letter month abbreviation, e.g. “Jan”.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>long_month</code></p>
|
||||
<small>{% include docs_version_badge.html version="4.0" %}</small>
|
||||
</td>
|
||||
<td>
|
||||
<p>Full month name, e.g. “January”.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>day</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Day of the month from the post’s filename. (01..31)
|
||||
May be overridden via the document’s <code>date</code> front matter.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>i_day</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Day of the month without leading zeros from the post’s filename.
|
||||
May be overridden via the document’s <code>date</code> front matter.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>y_day</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Ordinal day of the year from the post’s filename, with leading zeros. (001..366)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>w_year</code></p>
|
||||
<small>{% include docs_version_badge.html version="4.0" %}</small>
|
||||
</td>
|
||||
<td>
|
||||
<p>Week year which may differ from the month year for up to three days at the start of January and end of December</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>week</code></p>
|
||||
<small>{% include docs_version_badge.html version="4.0" %}</small>
|
||||
</td>
|
||||
<td>
|
||||
<p>Week number of the current year, starting with the first week having a majority of its days in January. (01..53)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>w_day</code></p>
|
||||
<small>{% include docs_version_badge.html version="4.0" %}</small>
|
||||
</td>
|
||||
<td>
|
||||
<p>Day of the week, starting with Monday. (1..7)</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>short_day</code></p>
|
||||
<small>{% include docs_version_badge.html version="4.0" %}</small>
|
||||
</td>
|
||||
<td>
|
||||
<p>Three-letter weekday abbreviation, e.g. “Sun”.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>long_day</code></p>
|
||||
<small>{% include docs_version_badge.html version="4.0" %}</small>
|
||||
</td>
|
||||
<td>
|
||||
<p>Weekday name, e.g. “Sunday”.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>hour</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Hour of the day, 24-hour clock, zero-padded from the post’s
|
||||
<code>date</code> front matter. (00..23)
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>minute</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Minute of the hour from the post’s <code>date</code> front matter. (00..59)
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>second</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Second of the minute from the post’s <code>date</code> front matter. (00..59)
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>title</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Title from the document’s filename. May be overridden via
|
||||
the document’s <code>slug</code> front matter. Preserves case from the source.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>slug</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>categories</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
The specified categories for this post. If a post has multiple
|
||||
categories, Jekyll will create a hierarchy (e.g. <code>/category1/category2</code>).
|
||||
Also Jekyll automatically parses out double slashes in the URLs,
|
||||
so if no categories are present, it will ignore this.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>slugified_categories</code></p>
|
||||
<small>{% include docs_version_badge.html version="4.1" %}</small>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
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>)
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<td><p><code>:{{ entry.name }}</code></p>
|
||||
{%- if entry.intro_ver -%}
|
||||
<small>{% include docs_version_badge.html version = entry.intro_ver %}</small>
|
||||
{%- endif -%}
|
||||
</td>
|
||||
<td><p>{{ entry.desc }}</p></td>
|
||||
</tr>
|
||||
{%- endfor %}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -295,47 +82,22 @@ For posts, Jekyll also provides the following built-in styles for convenience:
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{%- for entry in site.data.permalinks.builtin_formats %}
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>date</code></p>
|
||||
<td><p><code>{{ entry.name }}</code></p>
|
||||
{%- if entry.intro_ver -%}
|
||||
<small>{% include docs_version_badge.html version = entry.intro_ver %}</small>
|
||||
{%- endif -%}
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:year/:month/:day/:title:output_ext</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>pretty</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:year/:month/:day/:title/</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>ordinal</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:year/:y_day/:title:output_ext</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>weekdate</code></p>
|
||||
<small>{% include docs_version_badge.html version="4.0" %}</small>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:year/W:week/:short_day/:title:output_ext</code></p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>none</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p><code>/:categories/:title:output_ext</code></p>
|
||||
<p><code>{{ entry.format }}</code>
|
||||
{%- if entry.note -%}<br/>
|
||||
<small>({{ entry.note }})</small>
|
||||
{%- endif -%}
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
{%- endfor %}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -370,57 +132,12 @@ Collections have the following placeholders available:
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{%- for entry in site.data.permalinks.types.documents -%}
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:collection</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Label of the containing collection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:path</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Path to the document relative to the collection's directory,
|
||||
including base filename of the document.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:name</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The document's base filename, with every sequence of spaces
|
||||
and non-alphanumeric characters replaced by a hyphen.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:title</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
The <code>:title</code> template variable will take the
|
||||
<code>slug</code> <a href="/docs/front-matter/">front matter</a>
|
||||
variable value if any is present in the document; if none is
|
||||
defined then <code>:title</code> will be equivalent to
|
||||
<code>:name</code>, aka the slug generated from the filename.
|
||||
Preserves case from the source.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:output_ext</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>Extension of the output file. (Included by default and usually unnecessary.)</p>
|
||||
</td>
|
||||
<td><p><code>:{{ entry.name }}</code></p></td>
|
||||
<td><p>{{ entry.desc }}</p></td>
|
||||
</tr>
|
||||
{%- endfor -%}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
@@ -442,36 +159,12 @@ Pages have the following placeholders available:
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{%- for entry in site.data.permalinks.types.pages -%}
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:path</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Path to the page relative to the site's source directory, excluding
|
||||
base filename of the page.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:basename</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>The page's base filename</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<p><code>:output_ext</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>
|
||||
Extension of the output file. (Included by default and usually
|
||||
unnecessary.)
|
||||
</p>
|
||||
</td>
|
||||
<td><p><code>:{{ entry.name }}</code></p></td>
|
||||
<td><p>{{ entry.desc }}</p></td>
|
||||
</tr>
|
||||
{%- endfor -%}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
@@ -87,6 +87,7 @@ module SamplePlugin
|
||||
# Placeholders that are used in constructing page URL.
|
||||
def url_placeholders
|
||||
{
|
||||
:path => @dir,
|
||||
:category => @dir,
|
||||
:basename => basename,
|
||||
:output_ext => output_ext,
|
||||
|
||||
@@ -211,7 +211,7 @@ The complete list of available hooks:
|
||||
<p><code>:post_convert</code></p>
|
||||
</td>
|
||||
<td>
|
||||
<p>After converting the post content, but before rendering the postlayout</p>
|
||||
<p>After converting the post content, but before rendering the post layout</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
||||
@@ -109,8 +109,10 @@ end
|
||||
<code>--safe</code> option to disable plugins (with the exception of some
|
||||
<a href="https://pages.github.com/versions">whitelisted plugins</a>) for security reasons. Unfortunately, this means your plugins won't
|
||||
work if you’re deploying via GitHub Pages.<br><br>
|
||||
You can still use GitHub Pages to publish your site, but you’ll need to build the site locally and push the generated files to your
|
||||
GitHub repository instead of the Jekyll source files.
|
||||
You can still use GitHub Pages to publish your site, but you'll need to either build the site locally and push the generated files to
|
||||
your GitHub repository or use
|
||||
<a href="{{ '/docs/continuous-integration/github-actions/' | relative_url }}" title="GitHub Actions">GitHub Actions</a> to host source
|
||||
files on GitHub yet build and deploy with full control on GitHub Pages.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -96,7 +96,7 @@ Linking to a PDF for readers to download:
|
||||
## Displaying an index of posts
|
||||
|
||||
Creating an index of posts on another page should be easy thanks to
|
||||
[Liquid](https://docs.shopify.com/themes/liquid/basics) and its tags. Here’s a
|
||||
[Liquid](https://shopify.github.io/liquid/) and its tags. Here’s a
|
||||
simple example of how to create a list of links to your blog posts:
|
||||
|
||||
{% raw %}
|
||||
@@ -168,7 +168,7 @@ Categories of a post work similar to the tags above:
|
||||
*The similarity between categories and tags however, ends there.*
|
||||
|
||||
Unlike tags, categories for posts can also be defined by a post's file path.
|
||||
Any directory above `_post` will be read-in as a category. For example,
|
||||
Any directory above `_posts` will be read-in as a category. For example,
|
||||
if a post is at path `movies/horror/_posts/2019-05-21-bride-of-chucky.markdown`,
|
||||
then `movies` and `horror` are automatically registered as categories for that
|
||||
post.
|
||||
|
||||
@@ -3,6 +3,8 @@ layout: step
|
||||
title: Setup
|
||||
menu_name: Step by Step Tutorial
|
||||
position: 1
|
||||
redirect_from:
|
||||
- /docs/step-by-step/
|
||||
---
|
||||
Welcome to Jekyll's step-by-step tutorial. This tutorial takes
|
||||
you from having some front-end web development experience to building your
|
||||
|
||||
@@ -17,20 +17,20 @@ Jekyll sites often use this structure to keep assets organized:
|
||||
...
|
||||
```
|
||||
So, from your assets folder, create folders called css, images and js.
|
||||
Additionally, directly under the root create another folder called '_sass', which you will need shortly.
|
||||
Additionally, directly under the root create another folder called `_sass`, which you will need shortly.
|
||||
|
||||
## Sass
|
||||
|
||||
Inlining the styles used in `_includes/navigation.html`(adding or configuring within the same file) is not a best practice.
|
||||
Instead, let's style the current page by defining our first class in a new css file instead.
|
||||
|
||||
To do this, refer to the class (that you will configure in the next parts of this step) from within the navigation.html file by removing the code you added earlier (to color the current link red) and inserting the following code:
|
||||
To do this, refer to the class (that you will configure in the next parts of this step) from within the `navigation.html` file by removing the code you added earlier (to color the current link red) and inserting the following code:
|
||||
|
||||
{% raw %}
|
||||
```liquid
|
||||
<nav>
|
||||
{% for item in site.data.navigation %}
|
||||
<a href="{{ item.link }}" {% if page.url == item.link %}class="current"{% endif %}>{{ item.name }}</a>
|
||||
<a href="{{ item.link }}"{% if page.url == item.link %} class="current"{% endif %}>{{ item.name }}</a>
|
||||
{% endfor %}
|
||||
</nav>
|
||||
```
|
||||
@@ -50,7 +50,7 @@ First create a Sass file at `assets/css/styles.scss` with the following content:
|
||||
|
||||
The empty front matter at the top tells Jekyll it needs to process the file. The
|
||||
`@import "main"` tells Sass to look for a file called `main.scss` in the sass
|
||||
directory (`_sass/`) by default which you already created directly under the root folder of your website).
|
||||
directory (`_sass/` by default) you already created at the root of your working directory earlier.
|
||||
|
||||
At this stage you'll just have a main css file. For larger projects, this is a
|
||||
great way to keep your CSS organized.
|
||||
|
||||
@@ -19,14 +19,15 @@ following content:
|
||||
layout: post
|
||||
author: jill
|
||||
---
|
||||
A banana is an edible fruit – botanically a berry – produced by several kinds
|
||||
of large herbaceous flowering plants in the genus Musa.
|
||||
|
||||
A banana is an edible fruit – botanically a berry – produced by several
|
||||
kinds of large herbaceous flowering plants in the genus Musa.
|
||||
|
||||
In some countries, bananas used for cooking may be called "plantains",
|
||||
distinguishing them from dessert bananas. The fruit is variable in size, color,
|
||||
and firmness, but is usually elongated and curved, with soft flesh rich in
|
||||
starch covered with a rind, which may be green, yellow, red, purple, or brown
|
||||
when ripe.
|
||||
distinguishing them from dessert bananas. The fruit is variable in size,
|
||||
color, and firmness, but is usually elongated and curved, with soft
|
||||
flesh rich in starch covered with a rind, which may be green, yellow,
|
||||
red, purple, or brown when ripe.
|
||||
```
|
||||
|
||||
This is like the `about.md` you created before except it has an author and
|
||||
@@ -115,11 +116,11 @@ author: jill
|
||||
---
|
||||
An apple is a sweet, edible fruit produced by an apple tree.
|
||||
|
||||
Apple trees are cultivated worldwide, and are the most widely grown species in
|
||||
the genus Malus. The tree originated in Central Asia, where its wild ancestor,
|
||||
Malus sieversii, is still found today. Apples have been grown for thousands of
|
||||
years in Asia and Europe, and were brought to North America by European
|
||||
colonists.
|
||||
Apple trees are cultivated worldwide, and are the most widely grown
|
||||
species in the genus Malus. The tree originated in Central Asia, where
|
||||
its wild ancestor, Malus sieversii, is still found today. Apples have
|
||||
been grown for thousands of years in Asia and Europe, and were brought
|
||||
to North America by European colonists.
|
||||
```
|
||||
|
||||
`_posts/2018-08-22-kiwifruit.md`:
|
||||
@@ -129,14 +130,14 @@ colonists.
|
||||
layout: post
|
||||
author: ted
|
||||
---
|
||||
Kiwifruit (often abbreviated as kiwi), or Chinese gooseberry is the edible
|
||||
berry of several species of woody vines in the genus Actinidia.
|
||||
Kiwifruit (often abbreviated as kiwi), or Chinese gooseberry is the
|
||||
edible berry of several species of woody vines in the genus Actinidia.
|
||||
|
||||
The most common cultivar group of kiwifruit is oval, about the size of a large
|
||||
hen's egg (5–8 cm (2.0–3.1 in) in length and 4.5–5.5 cm (1.8–2.2 in) in
|
||||
diameter). It has a fibrous, dull greenish-brown skin and bright green or
|
||||
golden flesh with rows of tiny, black, edible seeds. The fruit has a soft
|
||||
texture, with a sweet and unique flavor.
|
||||
The most common cultivar group of kiwifruit is oval, about the size of
|
||||
a large hen's egg (5–8 cm (2.0–3.1 in) in length and 4.5–5.5 cm
|
||||
(1.8–2.2 in) in diameter). It has a fibrous, dull greenish-brown skin
|
||||
and bright green or golden flesh with rows of tiny, black, edible
|
||||
seeds. The fruit has a soft texture, with a sweet and unique flavor.
|
||||
```
|
||||
|
||||
Open <a href="http://localhost:4000" target="_blank" data-proofer-ignore>http://localhost:4000</a>
|
||||
|
||||
@@ -42,10 +42,15 @@ bundle exec jekyll serve
|
||||
|
||||
This restricts your Ruby environment to only use gems set in your `Gemfile`.
|
||||
|
||||
Note: if publishing your site with GitHub Pages, you can match production
|
||||
version of Jekyll by using the `github-pages` gem instead of `jekyll`
|
||||
in your `Gemfile`. In this scenario you may also want to exclude `Gemfile.lock`
|
||||
from your repository because GitHub Pages ignores that file.
|
||||
|
||||
## Plugins
|
||||
|
||||
Jekyll plugins allow you to create custom generated content specific to your
|
||||
site. There's many [plugins](/docs/plugins/) available or you can even
|
||||
site. There are many [plugins](/docs/plugins/) available or you can even
|
||||
write your own.
|
||||
|
||||
There are three official plugins which are useful on almost any Jekyll site:
|
||||
@@ -63,12 +68,12 @@ in a `jekyll_plugins` group they'll automatically be required into Jekyll:
|
||||
```ruby
|
||||
source 'https://rubygems.org'
|
||||
|
||||
gem 'jekyll'
|
||||
gem "jekyll"
|
||||
|
||||
group :jekyll_plugins do
|
||||
gem 'jekyll-sitemap'
|
||||
gem 'jekyll-feed'
|
||||
gem 'jekyll-seo-tag'
|
||||
gem "jekyll-sitemap"
|
||||
gem "jekyll-feed"
|
||||
gem "jekyll-seo-tag"
|
||||
end
|
||||
```
|
||||
|
||||
|
||||
@@ -394,4 +394,4 @@ Themes are published via [RubyGems.org](https://rubygems.org). You will need a R
|
||||
gem push jekyll-theme-awesome-*.gem
|
||||
```
|
||||
|
||||
4. To release a new version of your theme, update the version number in the gemspec file, ( `jekyll-theme-awesome.gemspec` in this example ), and then repeat Steps 1 - 3 above. We recommend that you follow [Semantic Versioning](http://semver.org/) while bumping your theme-version.
|
||||
4. To release a new version of your theme, update the version number in the gemspec file, ( `jekyll-theme-awesome.gemspec` in this example ), and then repeat Steps 1 - 3 above. We recommend that you follow [Semantic Versioning](https://semver.org) while bumping your theme-version.
|
||||
|
||||
@@ -317,7 +317,7 @@ The issue is caused by trying to copy a non-existing symlink.
|
||||
<h5>Please report issues you encounter!</h5>
|
||||
<p>
|
||||
If you come across a bug, please <a href="{{ site.repository }}/issues/new">create an issue</a>
|
||||
on GitHub describing the problem and any work-arounds you find so we can
|
||||
on GitHub describing the problem and any workarounds you find so we can
|
||||
document it here for others.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@@ -89,11 +89,11 @@ then the layout can access that via {% raw %}`{{ layout.class }}`{% endraw %}.
|
||||
|
||||
For the first time, the default syntax highlighter has changed for the
|
||||
`highlight` tag and for backtick code blocks. Instead of [Pygments.rb](https://github.com/tmm1/pygments.rb),
|
||||
it's now [Rouge](http://rouge.jneen.net/). If you were using the `highlight` tag with certain
|
||||
it's now [Rouge](https://github.com/rouge-ruby/rouge). If you were using the `highlight` tag with certain
|
||||
options, such as `hl_lines`, they may not be available when using Rouge. To
|
||||
go back to using Pygments, set `highlighter: pygments` in your
|
||||
`_config.yml` file and run `gem install pygments.rb` or add
|
||||
`gem 'pygments.rb'` to your project's `Gemfile`.
|
||||
`gem "pygments.rb"` to your project's `Gemfile`.
|
||||
|
||||
### Relative Permalink support removed
|
||||
|
||||
|
||||
@@ -123,7 +123,7 @@ Jekyll has dropped support for `kramdown-1.x` entirely.
|
||||
|
||||
From [`v2.0` onwards](https://kramdown.gettalong.org/news.html#kramdown-200-released)
|
||||
kramdown requires specific extensions to be additionally installed to use
|
||||
certain features are desired outside of kramdown's core functionality.
|
||||
certain desired features outside of kramdown's core functionality.
|
||||
|
||||
Out of all the extensions listed in the report linked above, gem
|
||||
`kramdown-parser-gfm` is automatically installed along with Jekyll 4.0. The
|
||||
|
||||
@@ -34,6 +34,15 @@ The following is a reference of the available data.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Jekyll Variables
|
||||
|
||||
{% include docs_variables_table.html scope=site.data.jekyll_variables.jekyll %}
|
||||
|
||||
## Theme Variables {%- include docs_version_badge.html version="4.3.0" -%}
|
||||
{: #theme-variables }
|
||||
|
||||
{% include docs_variables_table.html scope=site.data.jekyll_variables.theme %}
|
||||
|
||||
## Paginator
|
||||
|
||||
{% include docs_variables_table.html scope=site.data.jekyll_variables.paginator %}
|
||||
|
||||
@@ -1,33 +1,33 @@
|
||||
<script>
|
||||
var anchorForId = function (id) {
|
||||
var anchor = document.createElement("a");
|
||||
anchor.className = "header-link";
|
||||
anchor.href = "#" + id;
|
||||
anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
|
||||
anchor.title = "Permalink";
|
||||
return anchor;
|
||||
};
|
||||
/* 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;
|
||||
};
|
||||
|
||||
var linkifyAnchors = function (level, containingElement) {
|
||||
var headers = containingElement.getElementsByTagName("h" + level);
|
||||
for (var h = 0; h < headers.length; h++) {
|
||||
var header = headers[h];
|
||||
|
||||
if (typeof header.id !== "undefined" && header.id !== "") {
|
||||
header.appendChild(anchorForId(header.id));
|
||||
}
|
||||
/* 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));
|
||||
}
|
||||
};
|
||||
});
|
||||
};
|
||||
|
||||
document.onreadystatechange = function () {
|
||||
if (this.readyState === "complete") {
|
||||
var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
|
||||
if (!contentBlock) {
|
||||
return;
|
||||
}
|
||||
for (var level = 1; level <= 6; level++) {
|
||||
linkifyAnchors(level, contentBlock);
|
||||
}
|
||||
/* 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>
|
||||
|
||||
@@ -1,14 +1,17 @@
|
||||
<div class="unit one-fifth hide-on-mobiles">
|
||||
<aside>
|
||||
{% for section in site.data.docs_nav -%}
|
||||
{% for section in site.data.docs_nav %}
|
||||
<h4>{{ section.title }}</h4>
|
||||
<ul>
|
||||
{%- for item in section.docs -%}
|
||||
{%- assign p = site.docs | where: "url", item.link | first %}
|
||||
<li {%- if page.url == p.url %} class="current" {%- endif -%}><a href="{{ p.url | relative_url }}">
|
||||
{{- p.menu_name | default: p.title -}}
|
||||
</a></li>
|
||||
{%- endfor %}
|
||||
{%- for item in section.docs -%}
|
||||
{%- assign item_page = site.docs | where: "url", item.link | first -%}
|
||||
{%- capture item_html -%}
|
||||
<a href="{{ item_page.url | relative_url }}">
|
||||
{{ item_page.menu_name | default: item_page.title }}
|
||||
</a>
|
||||
{% endcapture %}
|
||||
<li{% unless item_page.url != page.url %} class="current"{% endunless %}>{{ item_html }}</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endfor -%}
|
||||
</aside>
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
||||
<select onchange="if (this.value) window.location.href=this.value">
|
||||
<select id="doc-nav" onchange="navigateToUrl(this)" aria-label="Select a page from the documentation">
|
||||
<option value="">Navigate the docs…</option>
|
||||
{% for section in site.data.docs_nav -%}
|
||||
<optgroup label="{{ section.title }}">
|
||||
{%- for item in section.docs -%}
|
||||
{% assign p = site.docs | where: "url", item.link | first %}
|
||||
<option value="{{ p.url | relative_url }}">
|
||||
{{- p.menu_name | default: p.title -}}
|
||||
</option>
|
||||
{%- endfor %}
|
||||
</optgroup>
|
||||
{% endfor -%}
|
||||
{% for section in site.data.docs_nav %}
|
||||
<optgroup label="{{ section.title }}">
|
||||
{%- for item in section.docs -%}
|
||||
{% assign item_page = site.docs | where: "url", item.link | first %}
|
||||
<option value="{{ item_page.url | relative_url }}">
|
||||
{{- item_page.menu_name | default: item_page.title -}}
|
||||
</option>
|
||||
{%- endfor %}
|
||||
</optgroup>
|
||||
{% endfor %}
|
||||
</select>
|
||||
</div>
|
||||
|
||||
@@ -1,23 +1,18 @@
|
||||
<footer>
|
||||
<div class="grid">
|
||||
<div class="unit one-third center-on-mobiles">
|
||||
<div class="unit two-thirds center-on-mobiles">
|
||||
<p>Jekyll is lovingly maintained by the <a href="{{ '/team/' | relative_url }}">core team</a> of volunteers. </p>
|
||||
<p>The contents of this website are <br />© {{ site.time | date: '%Y' }} under the terms of the <a href="{{ site.repository }}/blob/master/LICENSE">MIT License</a>.</p>
|
||||
<p>The contents of this website are <br />© {{ site.time | date: '%Y' }} under the terms of the <a href="{{ site.repository }}/blob/master/LICENSE">MIT License</a>.</p>
|
||||
</div>
|
||||
<div class="unit two-thirds align-right center-on-mobiles">
|
||||
<div class="unit one-third align-right center-on-mobiles">
|
||||
<p>
|
||||
Proudly hosted by
|
||||
<a href="https://github.com">
|
||||
<img src="{{ 'img/footer-logo.png' | relative_url }}" width="100" height="30" alt="GitHub • Social coding">
|
||||
</a>
|
||||
</p>
|
||||
</div>
|
||||
<div class="unit two-thirds align-right center-on-mobiles">
|
||||
<p>
|
||||
Jekyll is funded thanks to its
|
||||
<a href="https://github.com/jekyll/jekyll#sponsors">
|
||||
sponsors!
|
||||
</a>
|
||||
Jekyll is funded thanks to its <a href="https://github.com/jekyll/jekyll#sponsors">sponsors!</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
5
docs/_includes/improve_doc_link.html
Normal file
5
docs/_includes/improve_doc_link.html
Normal file
@@ -0,0 +1,5 @@
|
||||
<div class="improve right hide-on-mobiles">
|
||||
<a data-proofer-ignore href="{{ site.repository }}/edit/{{ site.site_branch }}/docs/{{ page.path }}">
|
||||
<i class="fa fa-pencil"></i> Improve this page
|
||||
</a>
|
||||
</div>
|
||||
@@ -3,12 +3,12 @@
|
||||
{% if p.show_on_mobile -%}
|
||||
<li
|
||||
{%- if p.link == '/' -%}
|
||||
{%- if page.url == '/' %} class="current" {% endif -%}
|
||||
{%- if page.url == '/' %} class="current" aria-current="page" {% endif -%}
|
||||
{% else -%}
|
||||
{%- if page.url contains p.link %} class="current" {% endif -%}
|
||||
{%- if page.url contains p.link %} class="current" aria-current="page" {% endif -%}
|
||||
{% endif -%}
|
||||
><a href="{{ p.link | relative_url }}">{{ p.title }}</a></li>
|
||||
{% endif -%}
|
||||
{% endfor -%}
|
||||
<li><a href="{{ site.repository }}">GitHub</a></li>
|
||||
</ul>
|
||||
<li><a href="{{ site.repository }}" target="_blank" rel="noopener">GitHub</a></li>
|
||||
</ul>
|
||||
@@ -1,10 +1,10 @@
|
||||
<div class="unit one-fifth hide-on-mobiles">
|
||||
<aside>
|
||||
<ul>
|
||||
<li {%- if page.title == 'News' %} class="current" {%- endif %}>
|
||||
<li {% if page.title == 'News' %} class="current" {% endif %}>
|
||||
<a href="{{ '/news/' | relative_url }}">All News</a>
|
||||
</li>
|
||||
<li {%- if page.title == 'Releases' %} class="current" {%- endif %}>
|
||||
<li {% if page.title == 'Releases' %} class="current" {% endif %}>
|
||||
<a href="{{ '/news/releases/' | relative_url }}">Jekyll Releases</a>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -23,7 +23,7 @@
|
||||
<ul>
|
||||
{% for post in site.posts -%}
|
||||
{% unless post.categories contains 'release' -%}
|
||||
<li {%- if page.title == post.title %} class="current" {%- endif %}>
|
||||
<li {% if page.title == post.title %} class="current" {% endif %}>
|
||||
<a href="{{ post.url | relative_url }}">{{ post.title }}</a>
|
||||
</li>
|
||||
{% endunless -%}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
||||
<select onchange="if (this.value) window.location.href=this.value">
|
||||
<select id="news-nav" onchange="navigateToUrl(this)" aria-label="Select a post from the blog">
|
||||
<option value="">Navigate the blog…</option>
|
||||
<option value="{{ '/news/' | relative_url }}">Home</option>
|
||||
<optgroup label="posts">
|
||||
@@ -8,4 +8,4 @@
|
||||
{% endfor -%}
|
||||
</optgroup>
|
||||
</select>
|
||||
</div>
|
||||
</div>
|
||||
@@ -1,5 +1,5 @@
|
||||
<article>
|
||||
<h2>
|
||||
<article itemscope itemtype="http://schema.org/NewsArticle">
|
||||
<h2 itemprop="headline">
|
||||
<a href="{{ post.url | relative_url }}">
|
||||
{{- post.title -}}
|
||||
</a>
|
||||
@@ -10,16 +10,16 @@
|
||||
</span>
|
||||
</span>
|
||||
<div class="post-meta">
|
||||
<span class="post-date">
|
||||
<span class="post-date" itemprop="datePublished" content="{{ post.date | date: "%Y-%m-%d" }}">
|
||||
{{- post.date | date_to_string -}}
|
||||
</span>
|
||||
{% assign author = post.author -%}
|
||||
<a href="https://github.com/{{ author }}" class="post-author">
|
||||
<a class="post-author" itemprop="author" itemscope itemtype="http://schema.org/Person" target="_blank" href="https://github.com/{{ author }}">
|
||||
{% avatar user=author size=24 -%}
|
||||
<span class="author-name">{{ author }}</span>
|
||||
<span class="author-name" itemprop="name">{{ author }}</span>
|
||||
</a>
|
||||
</div>
|
||||
<div class="post-content">
|
||||
<div class="post-content" itemprop="articleBody">
|
||||
{{- post.content -}}
|
||||
</div>
|
||||
</article>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<article>
|
||||
<article itemscope itemtype="http://schema.org/Article">
|
||||
<div class="cell-left">
|
||||
<span class="post-category">
|
||||
<span class="label">
|
||||
@@ -8,18 +8,18 @@
|
||||
</div>
|
||||
<div class="cell-right">
|
||||
<div class="post-meta">
|
||||
<h2 class="post-title">
|
||||
<a href="{{ post.url | relative_url }}">
|
||||
<h2 class="post-title" itemprop="headline">
|
||||
<a href="{{ post.url | relative_url }}" itemprop="url">
|
||||
{{- post.title -}}
|
||||
</a>
|
||||
</h2>
|
||||
<span class="post-date">
|
||||
<span class="post-date" itemprop="datePublished" content="{{ post.date | date: '%Y-%m-%d' }}">
|
||||
{{- post.date | date_to_string -}}
|
||||
</span>
|
||||
{% assign author = post.author -%}
|
||||
<a href="https://github.com/{{ author }}" class="post-author">
|
||||
<a href="https://github.com/{{ author }}" class="post-author" itemprop="author" itemscope itemtype="http://schema.org/Person">
|
||||
{% avatar user=author size=24 -%}
|
||||
<span class="author-name">{{ author }}</span>
|
||||
<span class="author-name" itemprop="name">{{ author }}</span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1 +1 @@
|
||||
<input type="text" id="docsearch-input" placeholder="Search the docs…">
|
||||
<input type="text" id="docsearch-input" placeholder="Search the docs…" aria-label="Search">
|
||||
@@ -1,5 +1,5 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en-US">
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
<div class="docs-nav-mobile unit whole show-on-mobiles">
|
||||
<select onchange="if (this.value) window.location.href=this.value">
|
||||
<select id="tutorial-nav" onchange="navigateToUrl(this)" aria-label="Select a tutorial">
|
||||
<option value="">Navigate the tutorials…</option>
|
||||
{% for section in site.data.tutorials -%}
|
||||
<optgroup label="{{ section.title }}">
|
||||
{% for item in section.tutorials -%}
|
||||
{% assign item_url = item | prepend:"/tutorials/" | append:"/" -%}
|
||||
{% assign tutorial = site.tutorials | where: "url", item_url | first -%}
|
||||
<option value="{{ tutorial.url | relative_url }}">{{ tutorial.title }}</option>
|
||||
{% endfor -%}
|
||||
</optgroup>
|
||||
<optgroup label="{{ section.title }}">
|
||||
{% for item in section.tutorials -%}
|
||||
{% assign item_url = item | prepend:"/tutorials/" | append:"/" -%}
|
||||
{% assign tutorial = site.tutorials | where: "url", item_url | first -%}
|
||||
<option value="{{ tutorial.url | relative_url }}">{{ tutorial.title }}</option>
|
||||
{% endfor -%}
|
||||
</optgroup>
|
||||
{% endfor -%}
|
||||
</select>
|
||||
</div>
|
||||
</div>
|
||||
@@ -9,5 +9,16 @@
|
||||
{%- include anchor_links.html -%}
|
||||
{%- include analytics.html -%}
|
||||
{%- include search/script.html -%}
|
||||
|
||||
<script>
|
||||
{%- comment -%}
|
||||
// This function is called when the user selects an option from a <select> element.
|
||||
// If the selected option has a valid URL, it changes the window location to that URL.
|
||||
{%- endcomment %}
|
||||
const navigateToUrl = (select) => {
|
||||
const url = select.value;
|
||||
url && (window.location.href = url);
|
||||
};
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@@ -7,10 +7,7 @@ layout: default
|
||||
{% include docs_contents_mobile.html -%}
|
||||
<div class="unit four-fifths">
|
||||
<article>
|
||||
<div class="improve right hide-on-mobiles">
|
||||
<a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/{{ page.path }}"><i
|
||||
class="fa fa-pencil"></i> Improve this page</a>
|
||||
</div>
|
||||
{% include improve_doc_link.html %}
|
||||
<h1>{{ page.title }}</h1>
|
||||
{{ content }}
|
||||
</article>
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
layout: news
|
||||
---
|
||||
|
||||
<article>
|
||||
<h2>
|
||||
<article itemscope itemtype="http://schema.org/Article">
|
||||
<h2 itemprop="headline">
|
||||
{{ page.title }}
|
||||
<a href="{{ page.url | relative_url }}" class="header-link" title="Permalink">
|
||||
<span class="sr-only">Permalink</span>
|
||||
@@ -16,16 +16,16 @@ layout: news
|
||||
</span>
|
||||
</span>
|
||||
<div class="post-meta">
|
||||
<span class="post-date">
|
||||
<span class="post-date" itemprop="datePublished" content="{{ page.date | date: "%Y-%m-%d" }}">
|
||||
{{- page.date | date_to_string -}}
|
||||
</span>
|
||||
{% assign author = page.author -%}
|
||||
<a href="https://github.com/{{ author }}" class="post-author">
|
||||
<a class="post-author" itemprop="author" itemscope itemtype="http://schema.org/Person" target="_blank" href="https://github.com/{{ author }}">
|
||||
{% avatar user=author size=24 -%}
|
||||
<span class="author-name">{{ author }}</span>
|
||||
<span class="author-name" itemprop="name">{{ author }}</span>
|
||||
</a>
|
||||
</div>
|
||||
<div class="post-content">
|
||||
<div class="post-content" itemprop="articleBody">
|
||||
{{ content }}
|
||||
</div>
|
||||
</article>
|
||||
|
||||
@@ -7,9 +7,7 @@ layout: default
|
||||
<div class="unit whole">
|
||||
<article>
|
||||
{%- if page.permalink contains "resources" %}
|
||||
<div class="improve right hide-on-mobiles">
|
||||
<a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/{{ page.path }}"><i class="fa fa-pencil"></i> Improve this page</a>
|
||||
</div>
|
||||
{% include improve_doc_link.html %}
|
||||
{% endif -%}
|
||||
<h1>{{ page.title }}</h1>
|
||||
{{ content }}
|
||||
|
||||
@@ -6,9 +6,7 @@ layout: default
|
||||
{% include docs_contents_mobile.html -%}
|
||||
<div class="unit four-fifths">
|
||||
<article>
|
||||
<div class="improve right hide-on-mobiles">
|
||||
<a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/{{ page.path }}"><i class="fa fa-pencil"></i> Improve this page</a>
|
||||
</div>
|
||||
{% include improve_doc_link.html %}
|
||||
<h1>Step by Step Tutorial</h1>
|
||||
<h2>{{ page.position }}. {{ page.title }}</h2>
|
||||
{{ content }}
|
||||
|
||||
@@ -8,10 +8,7 @@ layout: default
|
||||
<div class="unit four-fifths">
|
||||
<article>
|
||||
<header class="tutorial-header">
|
||||
<div class="improve right hide-on-mobiles">
|
||||
<a href="https://github.com/jekyll/jekyll/edit/master/docs/{{ page.path }}"><i
|
||||
class="fa fa-pencil"></i> Improve this page</a>
|
||||
</div>
|
||||
{% include improve_doc_link.html %}
|
||||
<h1 class="tutorial-title">{{ page.title }}</h1>
|
||||
{% assign author = page.author %}
|
||||
{% if author %}
|
||||
|
||||
@@ -82,7 +82,7 @@ First, read the [upgrade guide](/docs/upgrading/3-to-4/)!
|
||||
Next, Edit your project's `Gemfile` to test Jekyll v4.x:
|
||||
|
||||
```ruby
|
||||
gem "jekyll", "~> 4.0"
|
||||
gem 'jekyll', '~> 4.0'
|
||||
```
|
||||
|
||||
Then run `bundle update` to update all dependencies. Unless you're using
|
||||
|
||||
88
docs/_posts/2022-10-20-jekyll-4-3-0-released.markdown
Normal file
88
docs/_posts/2022-10-20-jekyll-4-3-0-released.markdown
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
title: 'Jekyll 4.3.0 Released'
|
||||
date: 2022-10-20 10:20:22 -0500
|
||||
author: ashmaroli
|
||||
version: 4.3.0
|
||||
category: release
|
||||
---
|
||||
|
||||
Hello Jekyllers!
|
||||
|
||||
The Jekyll team is happy to announce the release of `v4.3.0` shipping with some nice improvements and bug-fixes.
|
||||
|
||||
## Improvements
|
||||
|
||||
### Dependencies
|
||||
|
||||
- Gem `webrick` is now a listed dependency. You no longer have to add the gem to your Gemfile when using Jekyll with
|
||||
Ruby 3.0 or newer.
|
||||
- You may now use Rouge v4 or continue using Rouge v3.x by explicitly mentioning the version in your Gemfile.
|
||||
- Support for gem `tzinfo` v2 and non-half-hour offsets have been added.
|
||||
- You will be able to use v3 of `jekyll-sass-converter` when it ships.
|
||||
|
||||
### Builds
|
||||
|
||||
- Added support for bundling and loading data files from within a theme-gem similar to existing theme-gem contents.
|
||||
- Changes to data files at source will now be respected during incremental builds.
|
||||
- `site.static_files` now include static files within a collection.
|
||||
- You may now configure converters for CSV data.
|
||||
- `.jekyll-cache` or its equivalent custom cache directory will be automatically ignored by Git.
|
||||
- Vendor the current latest mime-types dataset for use with local development server.
|
||||
|
||||
{% raw %}
|
||||
### Liquid Templates
|
||||
|
||||
- `basename` attribute of documents are now exposed to Liquid as `name`, for example `{{ page.name }}`. Excerpts delegate
|
||||
to associated document attribute.
|
||||
- Top-level variable `{{ theme }}` introduced to expose gemspec details of theme-gem. (Valid only when using theme-gem)
|
||||
{% endraw %}
|
||||
|
||||
## Bug-fixes
|
||||
|
||||
Some noteworthy bug-fixes include:
|
||||
|
||||
- Respect `BUNDLE_GEMFILE` when loading Jekyll plugins via Bundler.
|
||||
- Prevent loading versions older than kramdown-2.3.1 as a security measure.
|
||||
- Trigger livereloading even if the site has *no pages*.
|
||||
- Ensure the expected class of theme config is returned following a merger.
|
||||
- Enable BOM encoding only if configured encoding is 'UTF-8'.
|
||||
- Respect server protocol while injecting livereload script.
|
||||
- The table output for `--profile` stops printing incorrect "TOTALS" row.
|
||||
|
||||
[The full list of changes](/docs/history/#v4-3-0) may be perused if interested.
|
||||
|
||||
As always, we are grateful to the many contributors that helped improve the project codebase and documentation:
|
||||
|
||||
<small>Ashwin Maroli, Frank Taillandier, Matt Rogers, Parker Moore, Kelvin M. Klann, Josh Soref, Youssef Boulkaid,
|
||||
Emily Grace Seville, Robert Martin, jaybe@jekyll, Ben Keith, Jonathan Darrer, Kaben, Mike Kasberg, Moncef Belyamani,
|
||||
Phil Ross, Sesh Sadasivam, Adam Bell, Alaz Tetik, Alex Malaszkiewicz, Alex Saveau, Andreas Deininger, Andrew Davis,
|
||||
Andrew Gutekanst, Andrii Abramov, Aram Akhavan, Atlas Cove, Attaphong Rattanaveerachanon, Ben Whetton, Chris Keefe,
|
||||
Clayton Smith, Craig H Maynard, Curious Cat, Daniel Haim, Daniel Kehoe, Daryl Hepting, David Bruant, David Zhang,
|
||||
Edson Jiménez, Eric Cousineau, Gary, Giuseppe Bertone, Ikko Ashimine, JJ, JT, Jeff Wilcox, Jeffrey Veen,
|
||||
Jesse van der Pluijm, John Losito, Kantanat-Stamp, Kirstin Heidler, Korbs, Laurence Andrews, Liam Bigelow, Maik Riechert,
|
||||
Meet Gor, Meg Gutshall, Michael Gerzabek, MichaelCordingley, Miguel Brandão, Nahin Khan, Nemo, Nicholas Paxford,
|
||||
Nick Coish, Otto Urpelainen, Parikshit87, Phil Kirlin, Qasim Qureshi, Ricardo N Feliciano, Rishi Raj Jain, SNVMK,
|
||||
SaintMalik, Sampath Sukesh Ravolaparthi, Shannon Kularathna, Shyam Mohan K, Takuya N, Tejas Bubane, Toshimaru, Tyler887,
|
||||
Vinhas Kevin, alena-ko, fauno, lm, lucafrance, nusu, shorty, なつき</small>
|
||||
|
||||
---
|
||||
|
||||
### Announcement
|
||||
|
||||
I would like to inform you that following this release, Jekyll will start developing towards a v5.0 milestone that will
|
||||
**definitely contain breaking changes**. I have set up a [tentative roadmap at the GitHub repository][roadmap] to give everyone
|
||||
a glimpse of the PROBABLE OUTCOME. Towards that end, we will no longer accept documentation fixes on `master`. The `4.3-stable`
|
||||
branch will be used to build and deploy the site for https://jekyllrb.com.
|
||||
|
||||
Jekyll 3.x series is now under security-maintenance phase. Only security patches will be released when necessary.
|
||||
|
||||
Jekyll 4.x series will continue receiving bug-fixes and security-patches only. Depending on the state of progress towards v5.0,
|
||||
there will be *at least* one minor version release serving as a transitionary version containing deprecations and bridge code
|
||||
to ease the eventual upgrade to v5.0.
|
||||
|
||||
[roadmap]: {{ site.repository }}/issues/9156
|
||||
|
||||
---
|
||||
|
||||
That is all for now.
|
||||
Happy Jekyllin'!!
|
||||
21
docs/_posts/2022-10-26-jekyll-4-3-1-released.markdown
Normal file
21
docs/_posts/2022-10-26-jekyll-4-3-1-released.markdown
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: 'Jekyll 4.3.1 Released'
|
||||
date: 2022-10-26 19:09:42 +0530
|
||||
author: ashmaroli
|
||||
version: 4.3.1
|
||||
category: release
|
||||
---
|
||||
|
||||
Hello Jekyllers!
|
||||
|
||||
We're shipping `v4.3.1` containing fixes for two issues with v4.3.0:
|
||||
- Jekyll now respects user-defined `name` attribute for collection documents when accessed in Liquid templates.
|
||||
- Revert the changes made to trigger incremental rebuilds when data files are changed.
|
||||
|
||||
Thanks to the users who took the time to report the issues to us.
|
||||
Happy Jekyllin'
|
||||
|
||||
P.S. Development towards v5 has taken a back seat as of now. I plan on releasing a v4.4.0 instead.
|
||||
That said, please feel free to comment on the [tentative roadmap to v5][roadmap].
|
||||
|
||||
[roadmap]: {{ site.repository }}/issues/9156
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
title: Jekyll Sass Converter 3.0 Released
|
||||
date: 2022-12-21 17:52:15 +0530
|
||||
author: ashmaroli
|
||||
category: community
|
||||
---
|
||||
|
||||
Jekyll Sass Converter 3.0 shipped recently and is available to those using Jekyll 4.3 and above. This release contains major changes.
|
||||
Specifically, the plugin has **stopped using `sassc` for converting your Sass partials and stylesheets** into CSS files.
|
||||
Instead, the converter now uses the `sass-embedded` gem acting as an interface to Dart Sass, which is the current primary
|
||||
implementation of Sass under active development. The secondary implementation `libsass` which the `sassc` gem interfaced
|
||||
with has been deprecated by its developers.
|
||||
|
||||
However, Dart Sass isn't *fully compatible* with older Ruby Sass workflow.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Minimum Ruby Version: `Ruby 2.6.0` (all platforms).
|
||||
- Minimum Rubygems Version: `3.3.22` (for Linux-based platforms).
|
||||
|
||||
## Migration Guide
|
||||
|
||||
### Dropped `implmentation` Option
|
||||
|
||||
In `v3.0.x`, `sass-embedded` is the only supported Sass implmentation, and therefore the config option
|
||||
`sass.implementation` introduced in `v2.2.0` has been removed.
|
||||
|
||||
|
||||
### Dropped `add_charset` Option
|
||||
|
||||
The converter will no longer emit `@charset "UTF-8";` or a `U+FEFF` (byte-order marker) for `sassify` and `scssify`
|
||||
Jekyll filters and hence the redundant option `sass.add_charset` is no longer active.
|
||||
|
||||
|
||||
### Dropped `line_comments` Option
|
||||
|
||||
`sass-embedded` does not support `sass.line_comments` option.
|
||||
|
||||
|
||||
### Dropped support of importing files with non-standard extension names
|
||||
|
||||
`sass-embedded` only allows importing files that have extension names of `.sass`, `.scss` or `.css`. SCSS syntax in
|
||||
files with `.css` extension name will result in a syntax error.
|
||||
|
||||
|
||||
### Dropped support of importing files relative to site source
|
||||
|
||||
In `v2.x`, the Converter allowed imports using paths relative to site source directory, even if the site source
|
||||
directory is not present in Sass' `load_paths` option. This is a side effect of a bug in the converter, which will remain as is in
|
||||
`v2.x` due to its usage in the wild.
|
||||
|
||||
In `v3.x`, imports using paths relative to site source directory will not work out of box. To allow these imports, `.`
|
||||
(meaning current directory, or site source directory) need to be explicitly listed under `load_paths` option.
|
||||
|
||||
|
||||
### Dropped support of importing files with the same filename as their parent file
|
||||
|
||||
In `v2.x`, the Converter allowed imports of files with the same filename as their parent file from `sass_dir` or
|
||||
`load_paths`. This is a side effect of a bug in the Converter, which will remain as is in `v2.x` due to its usage in the
|
||||
wild.
|
||||
|
||||
In `v3.x`, imports using the same filename of parent file will create a circular import. To fix such imports, rename
|
||||
either of the files, or use complete relative path from the parent file.
|
||||
|
||||
|
||||
### Behavioral Differences in Sass Implementation
|
||||
|
||||
There are a few intentional behavioral differences between Dart Sass and Ruby Sass. Please refer
|
||||
[Behavioral Differences from Ruby Sass][behavioral-differences] for details.
|
||||
|
||||
[behavioral-differences]: https://github.com/sass/dart-sass#behavioral-differences-from-ruby-sass
|
||||
27
docs/_posts/2023-01-20-jekyll-4-3-2-released.markdown
Normal file
27
docs/_posts/2023-01-20-jekyll-4-3-2-released.markdown
Normal file
@@ -0,0 +1,27 @@
|
||||
---
|
||||
title: 'Jekyll 4.3.2 Released'
|
||||
date: 2023-01-20 23:00:00 +0530
|
||||
author: ashmaroli
|
||||
version: 4.3.2
|
||||
category: release
|
||||
---
|
||||
|
||||
Hello Jekyllers!
|
||||
|
||||
This is a small release containing fixes for some issues that came to our attention after the
|
||||
release of v4.3.1:
|
||||
- Our `link` tag had a significant performance regression with the release of v4.3.0 solely due
|
||||
to a change related to `Jekyll::Site#each_site_file`. The new patch restores previous performance
|
||||
while maintaining the enhancements introduced in v4.3.0.
|
||||
- The tables printed out on running a build with the `--profile` did not stop including the
|
||||
misleading `TOTALS` row as advertised in the release-notes for v4.3.0. The row has been removed
|
||||
completely now.
|
||||
- `jekyll-sass-converter-3.0.0` that shipped in the interim was not happy with our blank-site
|
||||
scaffolding (from running `jekyll new <path> --blank`) having a `main.scss` stylesheet template
|
||||
*import* a Sass partial *also named* `main.scss`. So the partial has been renamed to `base.scss`.
|
||||
|
||||
That's about it for this release. Depending on whether you use the features patched in this release,
|
||||
you may either wait for v4.4.0 (releasing in the near future) to update your Gemfile or, download
|
||||
the latest release right away! :)
|
||||
|
||||
Happy Jekyllin'!!
|
||||
15
docs/_posts/2023-01-29-jekyll-3-9-3-released.markdown
Normal file
15
docs/_posts/2023-01-29-jekyll-3-9-3-released.markdown
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: 'Jekyll 3.9.3 Released'
|
||||
date: 2023-01-29 18:30:22 2023 -0800
|
||||
author: parkr
|
||||
version: 3.9.3
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Jekyll 3.9.3 is a bug fix release loosening version restrictions for
|
||||
dependencies `i18n` and `tzinfo` gems. You can now use Jekyll v3.9 with
|
||||
newer versions of these gems!
|
||||
|
||||
More details in [the full release notes]({% link _docs/history.md %}#v3-9-3).
|
||||
|
||||
Happy Jekylling!
|
||||
19
docs/_posts/2023-12-27-jekyll-4-3-3-released.markdown
Normal file
19
docs/_posts/2023-12-27-jekyll-4-3-3-released.markdown
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: 'Jekyll 4.3.3 Released'
|
||||
date: 2023-12-27 11:15:00 -0600
|
||||
author: mattr-
|
||||
version: 4.3.3
|
||||
category: release
|
||||
---
|
||||
|
||||
Hello Jekyllers!
|
||||
|
||||
This is a very small release containing two things:
|
||||
|
||||
- A fix for using Jekyll with Ruby 3.3 and the new `logger` gem included with that release.
|
||||
- A test fix for newer versions of Ruby for packagers that run the test suite
|
||||
as part of their packaging process.
|
||||
|
||||
Nothing new in the way of features for this release. You'll need to wait for v4.4 for that. 😄
|
||||
|
||||
Happy Jekylling!!
|
||||
14
docs/_posts/2023-12-28-jekyll-3-9-4-released.markdown
Normal file
14
docs/_posts/2023-12-28-jekyll-3-9-4-released.markdown
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: 'Jekyll 3.9.4 Released'
|
||||
date: 2023-12-28 14:45:05 -0800
|
||||
author: parkr
|
||||
version: 3.9.4
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
Hey Jekyllers!
|
||||
|
||||
This release, 3.9.4, is to bring Ruby 3.3 support to Jekyll. You can find
|
||||
the details in [the changelog]({% link _docs/history.md %}#v3-9-4).
|
||||
|
||||
Happy Jekylling!
|
||||
16
docs/_posts/2024-06-23-jekyll-3-10-0-released.markdown
Normal file
16
docs/_posts/2024-06-23-jekyll-3-10-0-released.markdown
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: 'Jekyll 3.10.0 Released'
|
||||
date: 2024-06-23 21:56:58 -0700
|
||||
author: parkr
|
||||
version: 3.10.0
|
||||
categories: [release]
|
||||
---
|
||||
|
||||
As Ruby continues to march on, the maintainers have made the decision to
|
||||
drop some previously-bundled gems. This release makes Jekyll depend
|
||||
directly on those gems so that whether your Ruby installation has them
|
||||
bundled or not, your experience can continue uninterrupted.
|
||||
|
||||
More details [are in the changelog]({% link _docs/history.md %}#v3-10-0).
|
||||
|
||||
Happy Jekylling!
|
||||
18
docs/_posts/2024-09-16-jekyll-4-3-4-released.markdown
Normal file
18
docs/_posts/2024-09-16-jekyll-4-3-4-released.markdown
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: 'Jekyll 4.3.4 Released'
|
||||
date: 2024-09-16 21:34:22 +0530
|
||||
author: ashmaroli
|
||||
version: 4.3.4
|
||||
category: release
|
||||
---
|
||||
|
||||
Hello Jekyllers!
|
||||
|
||||
Publishing a small bug-fix release with the following patches:
|
||||
|
||||
* Relax version-constraint on gem `wdm` in Gemfile created by `jekyll new`.
|
||||
* Patch `Jekyll::Drops::ThemeDrop#root` to render absolute path to theme-gem only if `JEKYLL_ENV` is explicitly set
|
||||
to string `development`.
|
||||
|
||||
That is all for now.
|
||||
Happy Jekyllin'!!
|
||||
39
docs/_posts/2025-01-27-jekyll-4-4-0-released.markdown
Normal file
39
docs/_posts/2025-01-27-jekyll-4-4-0-released.markdown
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: 'Jekyll 4.4.0 Released'
|
||||
date: 2025-01-27 20:45:32 +0530
|
||||
author: ashmaroli
|
||||
version: 4.4.0
|
||||
category: release
|
||||
---
|
||||
|
||||
Greetings Jekyllers, Jekyll v4.4.0 has been published!
|
||||
|
||||
This release comes with the following notable changes since v4.3.x:
|
||||
|
||||
* Liquid tag `highlight` now allows marking specific lines in the code-block.
|
||||
* Allow customizing the port that the vendored livereload script listens to, either via command-line flag
|
||||
`--livereload-port NUM` or via setting desired value to key `livereload_port` in configuration file.
|
||||
* Acknowledge paths passed to CLI flag `--livereload-ignore` or list of paths defined under configuration key
|
||||
`livereload_ignore` in order prevent automatic browser-refreshes on change to those paths.
|
||||
* Support for Ruby versions older than Ruby 2.7.0 has been dropped. Regardless, we recommend using Ruby 3.2.0 or newer
|
||||
to reduce inconveniences with installing newer versions of various plugins for Jekyll.
|
||||
* In order to improve the out-of-the-box experience with newer versions of Ruby, we have added gems `base64`, `csv` as
|
||||
runtime-dependencies. Consequently, those gems will be automatically installed with Jekyll and made available for use
|
||||
on issuing `bundle exec jekyll <command>`. *Users on older versions of Jekyll will have to manually add the gems to
|
||||
their Gemfile to resolve dependency errors*.
|
||||
* Gem `json` has been added as a runtime-dependency as well to provide consistent behavior across different platforms and
|
||||
different Ruby versions.
|
||||
* Version constraint on `mercenary` gem has been relaxed to automatically allow future releases.
|
||||
|
||||
Special thanks to my co-maintainers and members from our community who were instrumental in improving Jekyll codebase,
|
||||
documentation and development workflow since the release of v4.3:
|
||||
|
||||
Akira Taguchi, Andy Coates, Daniel Haim, David Silveira, Gabriel B. Nunes, Gaelan Lloyd, Gourav Khunger, IFcoltransG,
|
||||
James Hoctor, Joe Mahoney, Joel Coffman, Jonas Jared Jacek, Jorge, Josh Soref, José Romero, Juan Vásquez, KenHV, Khalila,
|
||||
Koichi ITO, Krisztian Zsolt Sallai, Maciek Palmowski, Mamoru TASAKA, Matt Rogers, Michael Nordmeyer, Mike Slinn,
|
||||
Moncef Belyamani, Muhab Abdelreheem, Olle Jonsson, Olly Headey, Otto Liljalaakso, Parker Moore, QuinnG8, Ram Vasuthevan,
|
||||
Robert Austin, Robert Love, Sean M. Collins, Seth Falco, Seth Louis, Shruti Dalvi, Silent, Simon Wagar, Sutou Kouhei,
|
||||
Tomáš Hübelbauer, Valeriy Van, Virgil Ierubino, Vít Ondruch, William Entriken, William Underwood, a story, halorrr,
|
||||
iulianOnofrei (U-lee-aan), masaki, naoki kodama, nisbet-hubbard, plgagne, velle, waqarnazir, なつき and 林博仁 Buo-ren Lin
|
||||
|
||||
Happy Jekyllin'!!
|
||||
@@ -212,40 +212,38 @@ h6:hover .header-link {
|
||||
/* Footer */
|
||||
|
||||
footer {
|
||||
background-color: #212121;
|
||||
font-size: 16px;
|
||||
padding-bottom: 5px;
|
||||
color: #c0c0c0;
|
||||
margin-top: 40px;
|
||||
padding-bottom: 5px;
|
||||
font-size: 15px;
|
||||
font-weight: 400;
|
||||
color: #999999;
|
||||
background-color: #212121;
|
||||
|
||||
a {
|
||||
color: #fff;
|
||||
color: #dddddd;
|
||||
|
||||
&:hover {
|
||||
|
||||
img { opacity: 1; }
|
||||
}
|
||||
}
|
||||
|
||||
.align-right {
|
||||
|
||||
p { display: inline-block; }
|
||||
}
|
||||
p { margin-block: 12px }
|
||||
|
||||
img {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 5px;
|
||||
opacity: .8;
|
||||
width: 84px;
|
||||
height: auto;
|
||||
margin-left: 2px;
|
||||
padding: 1px;
|
||||
@include transition(opacity .2s);
|
||||
vertical-align: bottom;
|
||||
opacity: 0.5;
|
||||
@include transition(opacity 0.2s);
|
||||
}
|
||||
}
|
||||
|
||||
@media (max-width: 568px) {
|
||||
footer {
|
||||
.one-third p { margin-bottom: 0; }
|
||||
.two-thirds p { margin-top: -20px; }
|
||||
p { margin-block: 6px }
|
||||
}
|
||||
}
|
||||
|
||||
@@ -444,7 +442,9 @@ article {
|
||||
}
|
||||
|
||||
@media (max-width: 480px) {
|
||||
article ul { padding-left: 20px; }
|
||||
article {
|
||||
ul, ol { padding-left: 20px }
|
||||
}
|
||||
}
|
||||
|
||||
@media (max-width: 568px) {
|
||||
@@ -679,7 +679,8 @@ article h2:first-child { margin-top: 0; }
|
||||
|
||||
.news article + article {
|
||||
margin-top: -6px;
|
||||
padding: 15px 40px;
|
||||
padding-top: 15px;
|
||||
padding-bottom: 15px;
|
||||
border-top: 1px solid #555;
|
||||
border-radius: 0;
|
||||
@include box-shadow(0 -1px 0 #2f2f2f);
|
||||
@@ -687,24 +688,6 @@ article h2:first-child { margin-top: 0; }
|
||||
h2.post-title {
|
||||
margin-bottom: 0.45em;
|
||||
}
|
||||
.post-category {
|
||||
margin-right: 20px;
|
||||
padding-left: 0;
|
||||
width: 150px;
|
||||
box-sizing: border-box;
|
||||
.label {
|
||||
float: right;
|
||||
}
|
||||
}
|
||||
.cell-left, .cell-right {
|
||||
display: inline-block;
|
||||
}
|
||||
.cell-left {
|
||||
max-width: 180px;
|
||||
}
|
||||
.cell-right {
|
||||
width: calc(100% - 130px);
|
||||
}
|
||||
.post-date { margin-left: 0 }
|
||||
}
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user