Compare commits

...

83 Commits

Author SHA1 Message Date
Patrick Marsceill
492471b15f Merge branch 'master' into v0.2.7-release 2019-09-10 12:37:07 -04:00
Patrick Marsceill
efe5918871 Update base.scss 2019-09-10 12:36:54 -04:00
Patrick Marsceill
56e8119665 Update _lists.scss 2019-09-10 12:32:43 -04:00
Patrick Marsceill
8dbe7209b9 Update _lists.scss 2019-09-10 12:30:00 -04:00
Patrick Marsceill
72741e9498 Update _lists.scss 2019-09-10 12:26:46 -04:00
Patrick Marsceill
5391eb0a13 Update _lists.scss 2019-09-10 12:25:26 -04:00
Patrick Marsceill
20c7b97b3e Update index.md 2019-09-10 12:19:29 -04:00
Patrick Marsceill
1476259d9b Merge branch 'master' into v0.2.7-release 2019-09-10 12:05:54 -04:00
Patrick Marsceill
00c96ac2de Merge pull request #215 from pmarsceill/dependabot/npm_and_yarn/primer/css-12.7.0
Bump @primer/css from 12.6.0 to 12.7.0
2019-09-10 12:05:38 -04:00
Patrick Marsceill
f2ce1b33c1 Merge pull request #214 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-8.0.0
Bump stylelint-config-primer from 7.0.1 to 8.0.0
2019-09-10 12:05:14 -04:00
Patrick Marsceill
afbb385042 Merge pull request #213 from pmarsceill/dependabot/npm_and_yarn/mixin-deep-1.3.2
[Security] Bump mixin-deep from 1.3.1 to 1.3.2
2019-09-10 12:04:46 -04:00
Patrick Marsceill
35da800e88 Update index.md 2019-09-10 12:03:51 -04:00
Patrick Marsceill
54d9738dd1 Update README.md 2019-09-10 11:39:30 -04:00
Patrick Marsceill
c5e53d90c9 Update customization.md 2019-09-10 11:36:48 -04:00
Patrick Marsceill
01a3c35c98 Update search.rake 2019-09-10 11:29:10 -04:00
Patrick Marsceill
b49829c784 Update search.md 2019-09-10 11:26:14 -04:00
Patrick Marsceill
95bdc51a0a Update dark-mode-preview.js 2019-09-10 11:20:26 -04:00
dependabot-preview[bot]
1cca7a8e88 Bump @primer/css from 12.6.0 to 12.7.0
Bumps [@primer/css](https://github.com/primer/css) from 12.6.0 to 12.7.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v12.6.0...v12.7.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-10 10:59:08 +00:00
dependabot-preview[bot]
2c73d71c1b Bump stylelint-config-primer from 7.0.1 to 8.0.0
Bumps [stylelint-config-primer](https://github.com/primer/stylelint-config-primer) from 7.0.1 to 8.0.0.
- [Release notes](https://github.com/primer/stylelint-config-primer/releases)
- [Changelog](https://github.com/primer/stylelint-config-primer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/stylelint-config-primer/compare/v7.0.1...v8.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-10 10:58:37 +00:00
dependabot-preview[bot]
722717a0d1 [Security] Bump mixin-deep from 1.3.1 to 1.3.2
Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2. **This update includes a security fix.**
- [Release notes](https://github.com/jonschlinkert/mixin-deep/releases)
- [Commits](https://github.com/jonschlinkert/mixin-deep/compare/1.3.1...1.3.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-10 10:57:42 +00:00
Patrick Marsceill
41187ed9b6 Merge pull request #205 from pdmosses/mathjax
Fix blank_lines var to blanklines in config.yml
2019-09-09 16:33:12 -04:00
Patrick Marsceill
3ae06cd59b Update search.md 2019-09-09 16:32:53 -04:00
Patrick Marsceill
7804642c50 Update search.md 2019-09-09 16:32:24 -04:00
Patrick Marsceill
b44ebe6cb3 Merge branch 'v0.2.7-release' into mathjax 2019-09-09 16:30:59 -04:00
Patrick Marsceill
423b8c9f46 Update _config.yml 2019-09-09 16:29:51 -04:00
Peter Mosses
a7285b9e30 Replace blank_lines by blanklines. 2019-09-09 22:26:32 +02:00
Peter Mosses
119a0b241e Revert "Mathjax support added"
This reverts commit 7220197a1f.
2019-09-09 22:22:22 +02:00
Patrick Marsceill
ff106641b0 syntax error 2019-09-09 16:09:05 -04:00
Patrick Marsceill
900639b02c Merge pull request #153 from jacobherrington/change-theme-button-text
Change button copy on theme preview
2019-09-09 16:06:33 -04:00
Patrick Marsceill
dbac62127a Merge branch 'v0.2.7-release' into change-theme-button-text 2019-09-09 16:06:21 -04:00
Patrick Marsceill
850a8fe256 Merge pull request #203 from pdmosses/search-config
Search config
2019-09-09 16:00:11 -04:00
Patrick Marsceill
44d689b994 Lint 2019-09-09 15:55:31 -04:00
Patrick Marsceill
9616dcf761 Update just-the-docs.js 2019-09-09 15:50:48 -04:00
Peter Mosses
1564ca4511 Update configuration.md
Added documentation for `search_tokenizer_separator`.
2019-09-09 21:50:05 +02:00
Patrick Marsceill
e124e10914 Merge pull request #200 from pmarsceill/dependabot/npm_and_yarn/mixin-deep-1.3.2
[Security] Bump mixin-deep from 1.3.1 to 1.3.2
2019-09-09 15:45:09 -04:00
Patrick Marsceill
757be1631c Merge pull request #208 from pmarsceill/dependabot/npm_and_yarn/primer/css-12.7.0
Bump @primer/css from 12.6.0 to 12.7.0
2019-09-09 15:43:46 -04:00
Patrick Marsceill
3b42ec2762 Merge pull request #206 from iamcarrico/allow-for-overrides
Allow for custom overrides by the user
2019-09-09 15:35:31 -04:00
Patrick Marsceill
a98bba778c Merge pull request #141 from ghabs/patch-1
Fix trailing comma bug in search-data.json
2019-09-09 15:32:26 -04:00
Patrick Marsceill
3ecdb59b48 Merge branch 'v0.2.7-release' into patch-1 2019-09-09 15:32:08 -04:00
Patrick Marsceill
843233c6b2 Merge pull request #187 from SgtSilvio/improvement/site-logo
Improvement/site logo
2019-09-09 15:10:55 -04:00
Patrick Marsceill
d3cbc83285 Merge pull request #188 from pdmosses/master
Update nav.html to eliminate generation of undisplayed elements
2019-09-09 15:09:22 -04:00
Patrick Marsceill
f960695bb7 Merge pull request #183 from SgtSilvio/improvement/heading-anchors
Improve heading anchors
2019-09-09 15:07:04 -04:00
Patrick Marsceill
34eaf8b16d Merge pull request #181 from m3nu/master
Recommend using index.md as parent page for sections
2019-09-09 15:05:12 -04:00
Patrick Marsceill
ea9affe25f Merge pull request #98 from stefanoborini/simplify-template
Introduces the possibility for a summary in the table of contents
2019-09-09 15:01:05 -04:00
Patrick Marsceill
d3f6e5907b Merge branch 'master' into simplify-template 2019-09-09 15:00:40 -04:00
dependabot-preview[bot]
3d0240ff0b Bump @primer/css from 12.6.0 to 12.7.0
Bumps [@primer/css](https://github.com/primer/css) from 12.6.0 to 12.7.0.
- [Release notes](https://github.com/primer/css/releases)
- [Changelog](https://github.com/primer/css/blob/master/CHANGELOG.md)
- [Commits](https://github.com/primer/css/compare/v12.6.0...v12.7.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-09-06 10:34:12 +00:00
Ian Carrico
1aee233e1f Add in some docs 2019-09-04 09:04:10 -04:00
Ian Carrico
47b7991805 Allow for custom overrides by the user 2019-09-04 08:55:11 -04:00
Peter Mosses
7220197a1f Mathjax support added
Mathjax config options added.
`compress_html` config option changed,
Mathjax script loaded by head when `page.mathjax` is truthy.
Documentation and test page added.
See also issue #198.
2019-08-31 23:19:03 +02:00
Peter Mosses
4e65041849 Revert "Add configuration option search_tokenizer_separator"
This reverts commit 50cdf076b4.
2019-08-31 16:52:41 +02:00
Peter Mosses
50cdf076b4 Add configuration option search_tokenizer_separator
The default is for hyphens to separate tokens in search terms: `gem-based` is equivalent to `gem based`.

This adds `search_tokenizer_separator` as a site configuation option, to support search for hyphenated words.
2019-08-29 15:36:13 +02:00
Peter Mosses
ed492bf40e Revert "Update .gitignore"
This reverts commit 13ef185010.
2019-08-29 14:45:09 +02:00
Peter Mosses
690d0b5e8a Revert "Update nav.html"
This reverts commit 0cfc0f0357.
2019-08-29 14:42:47 +02:00
Peter Mosses
5b74b44230 Revert "Optional delay of grandchildren link display"
This reverts commit 8ac545a5eb.
2019-08-29 14:42:23 +02:00
Peter Mosses
8a1e09ec5a Revert "Update nav.html"
This reverts commit c282e4b0a7.
2019-08-29 14:42:10 +02:00
Peter Mosses
cfbc7f41df Revert "Revert "Update nav.html""
This reverts commit 5d58a66301.
2019-08-29 14:41:21 +02:00
Peter Mosses
5e72b7db67 Revert "Revert "Optional delay of grandchildren link display""
This reverts commit 89f79138c3.
2019-08-29 14:41:09 +02:00
Peter Mosses
3af59176f4 Revert "Update nav.html"
This reverts commit 209ac7be7d.
2019-08-29 14:40:38 +02:00
Peter Mosses
13ef185010 Update .gitignore 2019-08-29 14:32:24 +02:00
dependabot-preview[bot]
7382a9a379 [Security] Bump mixin-deep from 1.3.1 to 1.3.2
Bumps [mixin-deep](https://github.com/jonschlinkert/mixin-deep) from 1.3.1 to 1.3.2. **This update includes a security fix.**
- [Release notes](https://github.com/jonschlinkert/mixin-deep/releases)
- [Commits](https://github.com/jonschlinkert/mixin-deep/compare/1.3.1...1.3.2)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
2019-08-27 19:28:29 +00:00
Peter Mosses
209ac7be7d Update nav.html
Restrict navigation to display only direct children.
2019-08-22 21:45:09 +02:00
Peter Mosses
89f79138c3 Revert "Optional delay of grandchildren link display"
This reverts commit 8ac545a5eb.
2019-08-22 21:37:11 +02:00
Peter Mosses
5d58a66301 Revert "Update nav.html"
This reverts commit c282e4b0a7.
2019-08-22 07:58:09 +02:00
Peter Mosses
c282e4b0a7 Update nav.html
Separating new PR from #188, since indpendent.
2019-08-21 13:57:07 +02:00
Peter Mosses
8ac545a5eb Optional delay of grandchildren link display
The current default is that when a grandparent is selected, the links to its
children *and all its grandchildren* are displayed in the navigation menu.
Setting `grandchildren_branch: true` in `_config.yml` delays the display of links
to grandchildren until their parent is selected.
2019-08-21 13:49:07 +02:00
Silvio Giebl
91760ee8c9 Added documentation for logo variable 2019-08-17 14:46:28 +02:00
Silvio Giebl
132cecfea3 Added logo variable to _config.yml which can be set to a path/url
Automatically replaces the title with a logo
2019-08-17 14:32:25 +02:00
Peter Mosses
0cfc0f0357 Update nav.html
A `navigation-list-child-list` is not displayed unless the enclosing `navigation-list-item` is `active`, so it needs to be generated only when `page.url == node.url or page.parent == node.title or page.grand_parent == node.title`.
2019-08-16 13:32:24 +02:00
Silvio Giebl
6a46a4797e Improved site header for logo
(cherry picked from commit 97d1c663ef566ffe20fb1ec217fd2d8c1a8a2382)
2019-08-15 22:01:51 +02:00
Silvio Giebl
89a331ee85 Improved site header for logo
(cherry picked from commit 468bf8368783309e69fdcaa91f7eb5b1e05d96aa)
2019-08-15 22:01:51 +02:00
Silvio Giebl
d4b79e2eac Improved site header for logo
(cherry picked from commit 2a5c38907488b998af75e9a1ef2499428b8f1a78)
2019-08-15 22:01:51 +02:00
Silvio Giebl
fdf4726320 Anchor headings are now displayed on hover, not only on heading hover,
Deduplicated anchor heading svg,
Anchor heading svg is now centered for heading
2019-08-15 14:18:40 +02:00
Manu
de37d60720 Recommend using index.md as parent page for sections
Using `index.md` as name for the parent page within a section allows lazy developers
to skip defining `permalink`. This is already working and this PR just updates the documentation.
2019-08-15 09:38:44 +08:00
Patrick Marsceill
418cf1d640 Merge pull request #175 from pmarsceill/v0.2.6-release
v0.2.6 release
2019-08-14 17:22:17 -04:00
jacobherrington
eabe7b2585 Change button copy on theme preview
This commit makes the dark mode preview feel a little more interactive
and it also pulls some duplicated code into one file so that people like
me aren't stumped when they are looking at the wrong page!
2019-06-21 18:19:49 -05:00
Ben Goldhaber
c8a8ce3314 Fix trailing comma bug in search-data.json
If you exclude the last page in the site.html_pages through exclude_true you end up violating the assumption in the for loop that the last page won't have a trailing comma. This breaks the json data that is served to the front end.

I removed the forloop.last check and instead assign a temporary variable to check for the first non-excluded page, and then add the comma before the next non-excluded entry.
2019-06-04 18:02:56 -07:00
Stefano Borini
2328407405 Removed indentation 2019-03-09 18:02:35 +00:00
Stefano Borini
b82b1a86d3 Shorter version that I assume should work. 2019-03-09 18:00:37 +00:00
Stefano Borini
c520591234 Merge pull request #2 from stefanoborini/adding-summary-for-toc-2
Adding summary for toc - 2
2019-03-09 17:50:28 +00:00
Stefano Borini
0b0b2e8555 Separating the summary from the link 2019-03-09 17:45:05 +00:00
Stefano Borini
26766a5984 Merge pull request #1 from stefanoborini/adding-summary-for-toc
Adding summary for toc
2019-03-09 17:27:26 +00:00
Stefano Borini
eec213daa1 Renamed excerpt to summary 2019-03-09 17:19:41 +00:00
Stefano Borini
c796485d92 Adds the possibility to specify a brief summary of a child page 2019-03-09 17:18:28 +00:00
22 changed files with 234 additions and 113 deletions

View File

@@ -4,7 +4,7 @@
<br><br> <br><br>
<p align="center"> <p align="center">
<h1 align="center">Just the Docs</h1> <h1 align="center">Just the Docs</h1>
<p align="center">A modern, high customizable, responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p> <p align="center">A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
<p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs/">See it in action!</a></strong></p> <p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs/">See it in action!</a></strong></p>
<br><br><br> <br><br><br>
</p> </p>

View File

@@ -21,9 +21,15 @@ url: "https://pmarsceill.github.io" # the base hostname & protocol for your site
permalink: pretty permalink: pretty
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"] exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
# Set a path/url to a logo that will be displayed instead of the title
#logo: "/assets/images/just-the-docs.png"
# Enable or disable the site search # Enable or disable the site search
search_enabled: true search_enabled: true
# Set the search token separator for hyphenated-word search:
search_tokenizer_separator: /[\s/]+/
# Enable or disable heading anchors # Enable or disable heading anchors
heading_anchors: true heading_anchors: true
@@ -50,5 +56,5 @@ compress_html:
comments: all comments: all
endings: all endings: all
startings: [] startings: []
blank_lines: false blanklines: false
profile: false profile: false

View File

@@ -1 +1,5 @@
{{ site.title }} {% if site.logo %}
<div class="site-logo"></div>
{% else %}
{{ site.title }}
{% endif %}

View File

@@ -7,6 +7,12 @@ layout: table_wrappers
<html lang="{{ site.lang | default: "en-US" }}"> <html lang="{{ site.lang | default: "en-US" }}">
{% include head.html %} {% include head.html %}
<body> <body>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="link" viewBox="0 0 16 16">
<title>Link</title>
<path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<div class="page-wrap"> <div class="page-wrap">
<div class="side-bar"> <div class="side-bar">
@@ -60,7 +66,7 @@ layout: table_wrappers
{% endunless %} {% endunless %}
<div id="main-content" class="page-content" role="main"> <div id="main-content" class="page-content" role="main">
{% if site.heading_anchors != false %} {% if site.heading_anchors != false %}
{% include vendor/anchor_headings.html html=content beforeHeading = "true" anchorBody="<svg class=\"d-inline-block v-align-middle\" viewBox=\"0 0 16 16\" version=\"1.1\" width=\"18\" height=\"18\" aria-hidden=\"true\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg>" anchorClass="anchor-heading" %} {% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#link\"></use></svg>" anchorClass="anchor-heading" %}
{% else %} {% else %}
{{ content }} {{ content }}
{% endif %} {% endif %}
@@ -73,7 +79,7 @@ layout: table_wrappers
{% for child in children_list %} {% for child in children_list %}
{% if child.parent == page.title and child.title != page.title %} {% if child.parent == page.title and child.title != page.title %}
<li> <li>
<a href="{{ child.url | absolute_url }}">{{ child.title }}</a> <a href="{{ child.url | absolute_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
</li> </li>
{% endif %} {% endif %}
{% endfor %} {% endfor %}

View File

@@ -88,7 +88,8 @@ code {
line-height: $body-line-height; line-height: $body-line-height;
} }
figure { figure,
pre {
margin: 0; margin: 0;
} }

View File

@@ -116,26 +116,37 @@
.anchor-heading { .anchor-heading {
position: absolute; position: absolute;
right: -$sp-3; right: -$sp-4;
width: $sp-5; width: $sp-5;
height: 100%; height: 100%;
padding-right: $sp-1;
padding-left: $sp-1;
overflow: visible; overflow: visible;
fill: $link-color;
visibility: hidden;
@include mq(md) { @include mq(md) {
right: auto; right: auto;
left: -$sp-5; left: -$sp-5;
} }
svg {
display: inline-block;
width: 100%;
height: 100%;
fill: $link-color;
visibility: hidden;
}
} }
.anchor-heading:hover,
h1:hover > .anchor-heading, h1:hover > .anchor-heading,
h2:hover > .anchor-heading, h2:hover > .anchor-heading,
h3:hover > .anchor-heading, h3:hover > .anchor-heading,
h4:hover > .anchor-heading, h4:hover > .anchor-heading,
h5:hover > .anchor-heading, h5:hover > .anchor-heading,
h6:hover > .anchor-heading { h6:hover > .anchor-heading {
visibility: visible; svg {
visibility: visible;
}
} }
h1, h1,

View File

@@ -125,12 +125,12 @@
.site-header { .site-header {
display: flex; display: flex;
min-height: $header-height;
align-items: center; align-items: center;
@include mq(md) { @include mq(md) {
z-index: 101; z-index: 101;
height: $header-height; height: $header-height;
min-height: $header-height;
max-height: $header-height; max-height: $header-height;
border-bottom: $border $border-color; border-bottom: $border $border-color;
} }
@@ -142,10 +142,26 @@
display: flex; display: flex;
height: 100%; height: 100%;
align-items: center; align-items: center;
padding-top: $gutter-spacing-sm; padding-top: $sp-3;
padding-bottom: $gutter-spacing-sm; padding-bottom: $sp-3;
color: $body-heading-color; color: $body-heading-color;
@include fs-6; @include fs-6;
@include mq(md) {
padding-top: $sp-2;
padding-bottom: $sp-2;
}
}
@if variable-exists(logo) {
.site-logo {
width: 100%;
height: 100%;
background-image: url($logo);
background-repeat: no-repeat;
background-position: left center;
background-size: contain;
}
} }
.menu-button { .menu-button {

3
_sass/overrides.scss Normal file
View File

@@ -0,0 +1,3 @@
//
// Custom overrides from a user.
//

View File

@@ -2,10 +2,16 @@
// Utility classes for lists // Utility classes for lists
// //
// stylelint-disable primer/selector-no-utility, primer/no-override // stylelint-disable primer/selector-no-utility, primer/no-override, selector-max-type
.list-style-none { .list-style-none {
padding: 0 !important; padding: 0 !important;
margin: 0 !important; margin: 0 !important;
list-style: none !important; list-style: none !important;
li {
&::before {
display: none !important;
}
}
} }

View File

@@ -3,6 +3,10 @@
# only Main files contain this front matter, not partials. # only Main files contain this front matter, not partials.
--- ---
{% if site.logo %}
$logo: "{{ site.logo | absolute_url }}";
{% endif %}
// //
// Import external dependencies // Import external dependencies
// //

View File

@@ -3,6 +3,10 @@
# only Main files contain this front matter, not partials. # only Main files contain this front matter, not partials.
--- ---
{% if site.logo %}
$logo: "{{ site.logo | absolute_url }}";
{% endif %}
// //
// Import external dependencies // Import external dependencies
// //
@@ -42,3 +46,4 @@
@import "./tables"; @import "./tables";
@import "./code"; @import "./code";
@import "./utilities/utilities"; @import "./utilities/utilities";
@import "./overrides";

View File

@@ -0,0 +1,23 @@
document.addEventListener("DOMContentLoaded", function(){
const toggleDarkMode = document.querySelector('.js-toggle-dark-mode')
const cssFile = document.querySelector('[rel="stylesheet"]')
const originalCssRef = cssFile.getAttribute('href')
const darkModeCssRef = originalCssRef.replace('just-the-docs.css', 'dark-mode-preview.css')
const buttonCopy = ['Return to the light side', 'Preview dark color scheme']
const updateButtonText = function(toggleDarkMode) {
toggleDarkMode.textContent === buttonCopy[0] ?
toggleDarkMode.textContent = buttonCopy[1] :
toggleDarkMode.textContent = buttonCopy[0]
}
jtd.addEvent(toggleDarkMode, 'click', function(){
if (cssFile.getAttribute('href') === originalCssRef) {
cssFile.setAttribute('href', darkModeCssRef)
updateButtonText(toggleDarkMode)
} else {
cssFile.setAttribute('href', originalCssRef)
updateButtonText(toggleDarkMode)
}
})
})

View File

@@ -52,8 +52,13 @@ function initSearch() {
if (request.status >= 200 && request.status < 400) { if (request.status >= 200 && request.status < 400) {
// Success! // Success!
var data = JSON.parse(request.responseText); var data = JSON.parse(request.responseText);
{% if site.search_tokenizer_separator != nil %}
lunr.tokenizer.separator = {{ site.search_tokenizer_separator }}
{% else %}
lunr.tokenizer.separator = /[\s\-/]+/ lunr.tokenizer.separator = /[\s\-/]+/
{% endif %}
var index = lunr(function () { var index = lunr(function () {
this.ref('id'); this.ref('id');
this.field('title', { boost: 200 }); this.field('title', { boost: 200 });

View File

@@ -1,11 +1,12 @@
--- ---
--- ---
{ {
{% for page in site.html_pages %}{% if page.search_exclude != true %}"{{ forloop.index0 }}": { {% assign comma = false %}
{% for page in site.html_pages %}{% if page.search_exclude != true %}{% if comma == true%},{% endif %}"{{ forloop.index0 }}": {
"title": "{{ page.title | replace: '&amp;', '&' }}", "title": "{{ page.title | replace: '&amp;', '&' }}",
"content": "{{ page.content | markdownify | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '</ul', ' . </ul' | replace: '</tr', ' . </tr' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | strip_html | escape_once | remove: 'Table of contents' | remove: '```' | remove: '---' | replace: '\', ' ' | replace: ' . . . ', ' . ' | replace: ' . . ', ' . ' | normalize_whitespace }}", "content": "{{ page.content | markdownify | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '</ul', ' . </ul' | replace: '</tr', ' . </tr' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | strip_html | escape_once | remove: 'Table of contents' | remove: '```' | remove: '---' | replace: '\', ' ' | replace: ' . . . ', ' . ' | replace: ' . . ', ' . ' | normalize_whitespace }}",
"url": "{{ page.url | absolute_url }}", "url": "{{ page.url | absolute_url }}",
"relUrl": "{{ page.url }}" "relUrl": "{{ page.url }}"
}{% unless forloop.last %},{% endunless %} }{% assign comma = true %}
{% endif %}{% endfor %} {% endif %}{% endfor %}
} }

View File

@@ -22,12 +22,23 @@ Just the Docs has some specific configuration parameters that can be defined in
View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example. View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example.
## Search enabled ## Site logo
```yaml
# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/images/just-the-docs.png"
```
## Search
```yaml ```yaml
# Enable or disable the site search # Enable or disable the site search
# Support true (default) or false # Supports true (default) or false
search_enabled: true search_enabled: true
# Enable support for hyphenated search words:
search_tokenizer_separator: /[\s/]+/
``` ```
## Aux links ## Aux links
@@ -35,18 +46,17 @@ search_enabled: true
```yaml ```yaml
# Aux links for the upper right navigation # Aux links for the upper right navigation
aux_links: aux_links:
"Just the Docs on GitHub": "Just the Docs on GitHub":
- "//github.com/pmarsceill/just-the-docs" - "//github.com/pmarsceill/just-the-docs"
``` ```
## Heading anchor links ## Heading anchor links
```yaml ```yaml
# Heading anchor links appear on hover over h1-h6 tags # Heading anchor links appear on hover over h1-h6 tags in page content
# in page content allowing users to deep link to a particular # allowing users to deep link to a particular heading on a page.
# heading on a page.
# #
# Supprts true (default) or false/nil # Supports true (default) or false/nil
heading_anchors: true heading_anchors: true
``` ```
@@ -65,20 +75,7 @@ color_scheme: "dark"
``` ```
<button class="btn js-toggle-dark-mode">Preview dark color scheme</button> <button class="btn js-toggle-dark-mode">Preview dark color scheme</button>
<script> <script type="text/javascript" src="{{ "/assets/js/dark-mode-preview.js" | absolute_url }}"></script>
const toggleDarkMode = document.querySelector('.js-toggle-dark-mode');
const cssFile = document.querySelector('[rel="stylesheet"]');
const originalCssRef = cssFile.getAttribute('href');
const darkModeCssRef = originalCssRef.replace('just-the-docs.css', 'dark-mode-preview.css');
jtd.addEvent(toggleDarkMode, 'click', function(){
if (cssFile.getAttribute('href') === originalCssRef) {
cssFile.setAttribute('href', darkModeCssRef);
} else {
cssFile.setAttribute('href', originalCssRef);
}
})
</script>
See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more information. See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more information.

View File

@@ -34,20 +34,7 @@ color_scheme: "dark"
``` ```
<button class="btn js-toggle-dark-mode">Preview dark color scheme</button> <button class="btn js-toggle-dark-mode">Preview dark color scheme</button>
<script> <script type="text/javascript" src="{{ "/assets/js/dark-mode-preview.js" | absolute_url }}"></script>
const toggleDarkMode = document.querySelector('.js-toggle-dark-mode');
const cssFile = document.querySelector('[rel="stylesheet"]');
const originalCssRef = cssFile.getAttribute('href');
const darkModeCssRef = originalCssRef.replace('just-the-docs.css', 'dark-mode-preview.css');
jtd.addEvent(toggleDarkMode, 'click', function(){
if (cssFile.getAttribute('href') === originalCssRef) {
cssFile.setAttribute('href', darkModeCssRef);
} else {
cssFile.setAttribute('href', originalCssRef);
}
})
</script>
## Specific visual customization ## Specific visual customization
@@ -69,3 +56,20 @@ $link-color: $blue-000;
``` ```
_Note:_ Editing the variables directly in `_sass/support/variables.scss` is not recommended and can cause other dependencies to fail. _Note:_ Editing the variables directly in `_sass/support/variables.scss` is not recommended and can cause other dependencies to fail.
## Override styles
For styles that aren't defined as a variables, you may want to modify specific CSS classes. To add your own CSS overrides at the end of the cascade, edit `_sass/overrides.scss`. This will allow for all overrides to be kept in a single file, and for any upstream changes to still be applied.
For example, if you'd like to add your own styles for printing a page, you could add the following styles.
#### Example
{: .no_toc }
```scss
// Print-only styles.
@media print {
.side-bar, .page-header { display: none; }
.main-content { max-width: auto; margin: 1em;}
}
```

View File

@@ -67,7 +67,7 @@ Sometimes you will want to create a page with many children (a section). First,
| |
|-- docs |-- docs
| |-- ui-components | |-- ui-components
| | |-- ui-components.md (parent page) | | |-- index.md (parent page)
| | |-- buttons.md | | |-- buttons.md
| | |-- code.md | | |-- code.md
| | |-- labels.md | | |-- labels.md
@@ -75,7 +75,7 @@ Sometimes you will want to create a page with many children (a section). First,
| | +-- typography.md | | +-- typography.md
| | | |
| |-- utilities | |-- utilities
| | |-- utilities.md (parent page) | | |-- index.md (parent page)
| | |-- color.md | | |-- color.md
| | |-- layout.md | | |-- layout.md
| | |-- responsive-modifiers.md | | |-- responsive-modifiers.md
@@ -88,9 +88,8 @@ Sometimes you will want to create a page with many children (a section). First,
+-- .. +-- ..
``` ```
On the parent pages, add 2 YAML front matter parameters: On the parent pages, add this YAML front matter parameter:
- `has_children: true` (tells us that this is a parent page) - `has_children: true` (tells us that this is a parent page)
- `permalink:` set this to the site directory that contains the child pages
#### Example #### Example
{: .no_toc } {: .no_toc }
@@ -101,7 +100,6 @@ layout: default
title: UI Components title: UI Components
nav_order: 2 nav_order: 2
has_children: true has_children: true
permalink: /docs/ui-components
--- ---
``` ```
@@ -140,7 +138,6 @@ title: UI Components
nav_order: 2 nav_order: 2
has_children: true has_children: true
has_toc: false has_toc: false
permalink: /docs/ui-components
--- ---
``` ```

View File

@@ -37,13 +37,13 @@ This command creates the `search-data.json` file that Jekyll uses to create your
{% raw %}--- {% raw %}---
--- ---
{ {
{% for page in site.html_pages %}{% if page.search_exclude != true %}"{{ forloop.index0 }}": { {% assign comma = false %}
"id": "{{ forloop.index0 }}", {% for page in site.html_pages %}{% if page.search_exclude != true %}{% if comma == true%},{% endif %}"{{ forloop.index0 }}": {
"title": "{{ page.title | replace: '&amp;', '&' }}", "title": "{{ page.title | replace: '&amp;', '&' }}",
"content": "{{ page.content | markdownify | strip_html | escape_once | remove: 'Table of contents' | remove: '```' | remove: '---' | replace: '\', ' ' | normalize_whitespace }}", "content": "{{ page.content | markdownify | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '</ul', ' . </ul' | replace: '</tr', ' . </tr' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | strip_html | escape_once | remove: 'Table of contents' | remove: '```' | remove: '---' | replace: '\', ' ' | replace: ' . . . ', ' . ' | replace: ' . . ', ' . ' | normalize_whitespace }}",
"url": "{{ page.url | absolute_url }}", "url": "{{ page.url | absolute_url }}",
"relUrl": "{{ page.url }}" "relUrl": "{{ page.url }}"
}{% unless forloop.last %},{% endunless %} }{% assign comma = true %}
{% endif %}{% endfor %} {% endif %}{% endfor %}
}{% endraw %} }{% endraw %}
``` ```
@@ -59,6 +59,15 @@ In your site's `_config.yml`, enable search:
search_enabled: true search_enabled: true
``` ```
The default is for hyphens to separate tokens in search terms:
`gem-based` is equivalent to `gem based`, matching either word.
To allow search for hyphenated words:
```yaml
# Set the search token separator
search_tokenizer_separator: /[\s/]+/
```
## Hiding pages from search ## Hiding pages from search
Sometimes you might have a page that you don't want to be indexed for the search nor to show up in search results, e.g, a 404 page. To exclude a page from search, add the `search_exclude: true` parameter to the page's YAML front matter: Sometimes you might have a page that you don't want to be indexed for the search nor to show up in search results, e.g, a 404 page. To exclude a page from search, add the `search_exclude: true` parameter to the page's YAML front matter:

View File

@@ -20,7 +20,7 @@ Just the Docs gives your documentation a jumpstart with a responsive Jekyll them
### Dependencies ### Dependencies
Just the Docs is built for [Jekyll](https://jekyllrb.com), a static site generator. View the [quick start guide](https://jekyllrb.com/docs/) for more information. Just the Docs requires no special Jekyll plugins and can run on GitHub Pages' standard Jekyll compiler. Just the Docs is built for [Jekyll](https://jekyllrb.com), a static site generator. View the [quick start guide](https://jekyllrb.com/docs/) for more information. Just the Docs requires no special plugins and can run on GitHub Pages' standard Jekyll compiler. The [Jekyll SEO Tag plugin](https://github.com/jekyll/jekyll-seo-tag) is included by default (no need to run any special installation) to inject SEO and open graph metadata on docs pages. For information on how to configure SEO and open graph metadata visit the [Jekyll SEO Tag usage guide](https://jekyll.github.io/jekyll-seo-tag/usage/).
### Quick start: Use as a GitHub Pages remote theme ### Quick start: Use as a GitHub Pages remote theme
@@ -79,6 +79,16 @@ Just the Docs is distributed by an [MIT license](https://github.com/pmarsceill/j
When contributing to this repository, please first discuss the change you wish to make via issue, When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in [our GitHub repo](https://github.com/pmarsceill/just-the-docs#contributing). email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in [our GitHub repo](https://github.com/pmarsceill/just-the-docs#contributing).
#### Thank you to the contributors of Just the Docs!
<ul class="list-style-none">
{% for contributor in site.github.contributors %}
<li class="d-inline-block mr-1">
<a href="{{ contributor.html_url }}"><img src="{{ contributor.avatar_url }}" width="32" height="32" alt="{{ contributor.login }}"/></a>
</li>
{% endfor %}
</ul>
### Code of Conduct ### Code of Conduct
Just the Docs is committed to fostering a welcoming community. Just the Docs is committed to fostering a welcoming community.

View File

@@ -4,7 +4,7 @@ namespace :search do
puts 'Creating search data json file...' puts 'Creating search data json file...'
mkdir_p 'assets/js' mkdir_p 'assets/js'
touch 'assets/js/search-data.json' touch 'assets/js/search-data.json'
content = %Q[{{ page.content | markdownify | strip_html | escape_once | remove: 'Table of contents' | remove: '```' | remove: '---' | replace: '\\', ' ' | normalize_whitespace }}] content = %Q[{{ page.content | markdownify | replace: '</h', ' . </h' | replace: '<hr', ' . <hr' | replace: '</p', ' . </p' | replace: '</ul', ' . </ul' | replace: '</tr', ' . </tr' | replace: '</li', ' | </li' | replace: '</td', ' | </td' | strip_html | escape_once | remove: 'Table of contents' | remove: '```' | remove: '---' | replace: '\', ' ' | replace: ' . . . ', ' . ' | replace: ' . . ', ' . ' | normalize_whitespace }}]
puts 'Done.' puts 'Done.'
puts 'Generating content...' puts 'Generating content...'
@@ -12,13 +12,13 @@ namespace :search do
f.puts '--- f.puts '---
--- ---
{ {
{% for page in site.html_pages %}{% if page.search_exclude != true %}"{{ forloop.index0 }}": { {% assign comma = false %}
"id": "{{ forloop.index0 }}", {% for page in site.html_pages %}{% if page.search_exclude != true %}{% if comma == true%},{% endif %}"{{ forloop.index0 }}": {
"title": "{{ page.title | replace: \'&amp;\', \'&\' }}", "title": "{{ page.title | replace: '&amp;', '&' }}",
"content": "'+content+'", "content": "'+content+'",
"url": "{{ page.url | absolute_url }}", "url": "{{ page.url | absolute_url }}",
"relUrl": "{{ page.url }}" "relUrl": "{{ page.url }}"
}{% unless forloop.last %},{% endunless %} }{% assign comma = true %}
{% endif %}{% endfor %} {% endif %}{% endfor %}
}' }'
end end

95
package-lock.json generated
View File

@@ -1,6 +1,6 @@
{ {
"name": "just-the-docs", "name": "just-the-docs",
"version": "0.2.5", "version": "0.2.6",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {
@@ -177,11 +177,11 @@
"dev": true "dev": true
}, },
"@primer/css": { "@primer/css": {
"version": "12.6.0", "version": "12.7.0",
"resolved": "https://registry.npmjs.org/@primer/css/-/css-12.6.0.tgz", "resolved": "https://registry.npmjs.org/@primer/css/-/css-12.7.0.tgz",
"integrity": "sha512-GzQr/MPCbTlgvAd4bEXy4RA5cZvz7k/wkCzG7sOmjB9g9EtGnkzmLz6aS58EBRJsxfe6QU/iZ2/N/66/Bn5eZA==", "integrity": "sha512-EVqfwX1jxKWQoV9IxxCJQG7HlyKefdkYTJdnDV43Rr1cyidUTkQN9W0uMuN+RD9cmAzip/40b2E+7gsvsFDmBA==",
"requires": { "requires": {
"@primer/octicons": "9.1.1" "@primer/octicons": "^9.1.1"
} }
}, },
"@primer/octicons": { "@primer/octicons": {
@@ -548,14 +548,22 @@
} }
}, },
"browserslist": { "browserslist": {
"version": "4.5.6", "version": "4.7.0",
"resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.5.6.tgz", "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.7.0.tgz",
"integrity": "sha512-o/hPOtbU9oX507lIqon+UvPYqpx3mHc8cV3QemSBTXwkG8gSQSK6UKvXcE/DcleU3+A59XTUHyCvZ5qGy8xVAg==", "integrity": "sha512-9rGNDtnj+HaahxiVV38Gn8n8Lr8REKsel68v1sPFfIGEK6uSXTY3h9acgiT1dZVtOOUtifo/Dn8daDQ5dUgVsA==",
"dev": true, "dev": true,
"requires": { "requires": {
"caniuse-lite": "^1.0.30000963", "caniuse-lite": "^1.0.30000989",
"electron-to-chromium": "^1.3.127", "electron-to-chromium": "^1.3.247",
"node-releases": "^1.1.17" "node-releases": "^1.1.29"
},
"dependencies": {
"electron-to-chromium": {
"version": "1.3.254",
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.254.tgz",
"integrity": "sha512-7I5/OkgR6JKy6RFLJeru0kc0RMmmMu1UnkHBKInFKRrg1/4EQKIqOaUqITSww/SZ1LqWwp1qc/LLoIGy449eYw==",
"dev": true
}
} }
}, },
"cache-base": { "cache-base": {
@@ -629,9 +637,9 @@
"dev": true "dev": true
}, },
"caniuse-lite": { "caniuse-lite": {
"version": "1.0.30000963", "version": "1.0.30000989",
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30000963.tgz", "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30000989.tgz",
"integrity": "sha512-n4HUiullc7Lw0LyzpeLa2ffP8KxFBGdxqD/8G3bSL6oB758hZ2UE2CVK+tQN958tJIi0/tfpjAc67aAtoHgnrQ==", "integrity": "sha512-vrMcvSuMz16YY6GSVZ0dWDTJP8jqk3iFQ/Aq5iqblPwxSVVZI+zxDyTX0VPqtQsDnfdrBDcsmhgTEOh5R8Lbpw==",
"dev": true "dev": true
}, },
"ccount": { "ccount": {
@@ -1083,9 +1091,9 @@
} }
}, },
"cssesc": { "cssesc": {
"version": "2.0.0", "version": "3.0.0",
"resolved": "https://registry.npmjs.org/cssesc/-/cssesc-2.0.0.tgz", "resolved": "https://registry.npmjs.org/cssesc/-/cssesc-3.0.0.tgz",
"integrity": "sha512-MsCAG1z9lPdoO/IUMLSBWBSVxVtJ1395VGIQ+Fc2gNdkQ1hNDnQdw3YhA71WJCBW1vdwA0cAnk/DnW6bqoEUYg==", "integrity": "sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==",
"dev": true "dev": true
}, },
"currently-unhandled": { "currently-unhandled": {
@@ -2776,9 +2784,9 @@
} }
}, },
"mixin-deep": { "mixin-deep": {
"version": "1.3.1", "version": "1.3.2",
"resolved": "https://registry.npmjs.org/mixin-deep/-/mixin-deep-1.3.1.tgz", "resolved": "https://registry.npmjs.org/mixin-deep/-/mixin-deep-1.3.2.tgz",
"integrity": "sha512-8ZItLHeEgaqEvd5lYBXfm4EZSFCX29Jb9K+lAHhDKzReKBQKj3R+7NOF6tjqYi9t4oI8VUfaWITJQm86wnXGNQ==", "integrity": "sha512-WRoDn//mXBiJ1H40rqa3vH0toePwSsGb45iInWlTySa+Uu4k3tYUSxa2v1KqAiLtvlrSzaExqS1gtk96A9zvEA==",
"dev": true, "dev": true,
"requires": { "requires": {
"for-in": "^1.0.2", "for-in": "^1.0.2",
@@ -2849,9 +2857,9 @@
"dev": true "dev": true
}, },
"node-releases": { "node-releases": {
"version": "1.1.17", "version": "1.1.30",
"resolved": "https://registry.npmjs.org/node-releases/-/node-releases-1.1.17.tgz", "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-1.1.30.tgz",
"integrity": "sha512-/SCjetyta1m7YXLgtACZGDYJdCSIBAWorDWkGCGZlydP2Ll7J48l7j/JxNYZ+xsgSPbWfdulVS/aY+GdjUsQ7Q==", "integrity": "sha512-BHcr1g6NeUH12IL+X3Flvs4IOnl1TL0JczUhEZjDE+FXXPQcVCNr8NEPb01zqGxzhTpdyJL5GXemaCW7aw6Khw==",
"dev": true, "dev": true,
"requires": { "requires": {
"semver": "^5.3.0" "semver": "^5.3.0"
@@ -4299,15 +4307,14 @@
} }
}, },
"stylelint-config-primer": { "stylelint-config-primer": {
"version": "7.0.1", "version": "8.0.0",
"resolved": "https://registry.npmjs.org/stylelint-config-primer/-/stylelint-config-primer-7.0.1.tgz", "resolved": "https://registry.npmjs.org/stylelint-config-primer/-/stylelint-config-primer-8.0.0.tgz",
"integrity": "sha512-yuKUU/0Z490FOp4gEGOebdXOcc0T0Kx07qygXImNZp4xisTkDabSEFUxfj8SzLybe08pPyuTFoJeCD65jXExuQ==", "integrity": "sha512-PRhlYe/6x1H9Lbfr/j/RFGT3vnUGmpvTATl01TVsy43tEAZVELzQRfSdgg18WuegJo3LSRkgM8rxbz0eX3Ucdw==",
"dev": true, "dev": true,
"requires": { "requires": {
"stylelint-no-unsupported-browser-features": "^1.0.0", "stylelint-no-unsupported-browser-features": "^1.0.0",
"stylelint-order": "^2.0.0", "stylelint-order": "^2.0.0",
"stylelint-scss": "3.5.2", "stylelint-scss": "^3.10.0"
"stylelint-selector-no-utility": "4.0.0"
} }
}, },
"stylelint-no-unsupported-browser-features": { "stylelint-no-unsupported-browser-features": {
@@ -4356,28 +4363,34 @@
} }
}, },
"stylelint-scss": { "stylelint-scss": {
"version": "3.5.2", "version": "3.10.1",
"resolved": "https://registry.npmjs.org/stylelint-scss/-/stylelint-scss-3.5.2.tgz", "resolved": "https://registry.npmjs.org/stylelint-scss/-/stylelint-scss-3.10.1.tgz",
"integrity": "sha512-HL95s8Q6wihbJe7c7z6rL9GHVHOF3H3tXkVmGutitwn14LYR52JYMwCkcifqlf4nRsvXrUDaoH6OHOdilifyjw==", "integrity": "sha512-YnzYmcLd5DGGsjfoj44gArjo3TWhMWjS/ytfu+1HKtToZae5ditZOXHBmrgitsHvNk9mzp5WO3/PjA5IO1GpUw==",
"dev": true, "dev": true,
"requires": { "requires": {
"lodash": "^4.17.11", "lodash": "^4.17.15",
"postcss-media-query-parser": "^0.2.3", "postcss-media-query-parser": "^0.2.3",
"postcss-resolve-nested-selector": "^0.1.1", "postcss-resolve-nested-selector": "^0.1.1",
"postcss-selector-parser": "^5.0.0", "postcss-selector-parser": "^6.0.2",
"postcss-value-parser": "^3.3.1" "postcss-value-parser": "^4.0.2"
}, },
"dependencies": { "dependencies": {
"postcss-selector-parser": { "postcss-selector-parser": {
"version": "5.0.0", "version": "6.0.2",
"resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-5.0.0.tgz", "resolved": "https://registry.npmjs.org/postcss-selector-parser/-/postcss-selector-parser-6.0.2.tgz",
"integrity": "sha512-w+zLE5Jhg6Liz8+rQOWEAwtwkyqpfnmsinXjXg6cY7YIONZZtgvE0v2O0uhQBs0peNomOJwWRKt6JBfTdTd3OQ==", "integrity": "sha512-36P2QR59jDTOAiIkqEprfJDsoNrvwFei3eCqKd1Y0tUsBimsq39BLp7RD+JWny3WgB1zGhJX8XVePwm9k4wdBg==",
"dev": true, "dev": true,
"requires": { "requires": {
"cssesc": "^2.0.0", "cssesc": "^3.0.0",
"indexes-of": "^1.0.1", "indexes-of": "^1.0.1",
"uniq": "^1.0.1" "uniq": "^1.0.1"
} }
},
"postcss-value-parser": {
"version": "4.0.2",
"resolved": "https://registry.npmjs.org/postcss-value-parser/-/postcss-value-parser-4.0.2.tgz",
"integrity": "sha512-LmeoohTpp/K4UiyQCwuGWlONxXamGzCMtFxLq4W1nZVGIQLYvMCJx3yAF9qyyuFpflABI9yVdtJAqbihOsCsJQ==",
"dev": true
} }
} }
}, },
@@ -5824,9 +5837,9 @@
} }
}, },
"p-limit": { "p-limit": {
"version": "2.2.0", "version": "2.2.1",
"resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.0.tgz", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz",
"integrity": "sha512-pZbTJpoUsCzV48Mc9Nh51VbwO0X9cuPFE8gYwx9BTCt9SF8/b7Zljd2fVgOxhIF/HDTKgpVzs+GPhyKfjLLFRQ==", "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==",
"dev": true, "dev": true,
"requires": { "requires": {
"p-try": "^2.0.0" "p-try": "^2.0.0"

View File

@@ -7,11 +7,11 @@
"bugs": "https://github.com/pmarsceill/just-the-docs/issues", "bugs": "https://github.com/pmarsceill/just-the-docs/issues",
"devDependencies": { "devDependencies": {
"stylelint": "^10.0.1", "stylelint": "^10.0.1",
"stylelint-config-primer": "^7.0.1", "stylelint-config-primer": "^8.0.0",
"stylelint-selector-no-utility": "^4.0.0" "stylelint-selector-no-utility": "^4.0.0"
}, },
"dependencies": { "dependencies": {
"@primer/css": "^12.6.0" "@primer/css": "^12.7.0"
}, },
"scripts": { "scripts": {
"test": "stylelint '**/*.scss'" "test": "stylelint '**/*.scss'"