From 3730de18eabe49841ec76e045c1bb901cc255e21 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 10:56:50 -0500 Subject: [PATCH 1/7] Add support for task lists --- _sass/content.scss | 16 ++++++++++++++++ docs/index-test.md | 6 ++++++ 2 files changed, 22 insertions(+) diff --git a/_sass/content.scss b/_sass/content.scss index 4ef15ce..7a41e3a 100644 --- a/_sass/content.scss +++ b/_sass/content.scss @@ -56,6 +56,22 @@ } } + .task-list { + padding-left: 0; + } + + .task-list-item { + display: flex; + align-items: center; + &::before { + content: ""; + } + } + + .task-list-item-checkbox { + margin-right: 0.6em; + } + hr + * { margin-top: 0; } diff --git a/docs/index-test.md b/docs/index-test.md index ab7a1f2..1d0db73 100644 --- a/docs/index-test.md +++ b/docs/index-test.md @@ -94,6 +94,12 @@ end - level 2 item - level 1 item +### And a task list + +- [ ] Hello, this is a TODO item +- [ ] Hello, this is another TODO item +- [x] Goodbye, this item is done + ### Small image ![](https://assets-cdn.github.com/images/icons/emoji/octocat.png) From 45eea0efb69642a451d38157ab03a8cb6a5e9386 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 10:57:07 -0500 Subject: [PATCH 2/7] Add docs for lists --- docs/ui-components/lists.md | 98 +++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 docs/ui-components/lists.md diff --git a/docs/ui-components/lists.md b/docs/ui-components/lists.md new file mode 100644 index 0000000..364316e --- /dev/null +++ b/docs/ui-components/lists.md @@ -0,0 +1,98 @@ +--- +layout: default +title: Lists +parent: UI Components +nav_order: 5 +--- + +# Lists +{:.no_toc} + +## Table of contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +--- + +Most lists can be rendered with pure markdown... + +## Unordered list +
+- Item 1 +- Item 2 +- Item 3 + +_or_ + +* Item 1 +* Item 2 +* Item 3 +
+```markdown +- Item 1 +- Item 2 +- Item 3 + +_or_ + +* Item 1 +* Item 2 +* Item 3 +``` + + +## Ordered list +
+1. Item 1 +1. Item 2 +1. Item 3 +
+ ```markdown +1. Item 1 +1. Item 2 +1. Item 3 + ``` +## Task list + +
+- [ ] hello, this is a todo item +- [ ] hello, this is another todo item +- [x] goodbye, this item is done +
+ ```markdown +- [ ] hello, this is a todo item +- [ ] hello, this is another todo item +- [x] goodbye, this item is done + ``` + +## Definition list + +Definition lists require HTML syntax and aren't supported with the GitHub flavored markdown compiler. + +
+
+
Name
+
Godzilla
+
Born
+
1952
+
Birthplace
+
Japan
+
Color
+
Green
+
+
+```html +
+
Name
+
Godzilla
+
Born
+
1952
+
Birthplace
+
Japan
+
Color
+
Green
+
+``` + From d11e332dc692ba9c61ac0c0796a9c8e4e2431e51 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 11:46:43 -0500 Subject: [PATCH 3/7] Create condition for no search and add config/css --- _config.yml | 3 +++ _includes/head.html | 2 ++ _layouts/default.html | 6 ++++-- _sass/layout.scss | 7 ++++--- _sass/navigation.scss | 2 +- _sass/search.scss | 2 +- assets/js/just-the-docs.js | 4 +++- 7 files changed, 18 insertions(+), 8 deletions(-) diff --git a/_config.yml b/_config.yml index 58d048a..22aef3f 100644 --- a/_config.yml +++ b/_config.yml @@ -21,6 +21,9 @@ baseurl: "/just-the-docs/" # the subpath of your site, e.g. /blog permalink: pretty exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"] +# Enable or disable the site search +search_enabled: true + # Aux links for the upper right navigation aux_links: "Just the Docs on GitHub": diff --git a/_includes/head.html b/_includes/head.html index 8aae2cf..cbd41f9 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -4,7 +4,9 @@ {{ page.title }} - {{ site.title }} + {% if site.search_enabled != nil %} + {% endif %} diff --git a/_layouts/default.html b/_layouts/default.html index fe76346..cc76786 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -16,7 +16,8 @@
-
+
+ {% if site.search_enabled != nil %}
@@ -24,8 +25,9 @@
+ {% endif %} {% if site.aux_links != nil %} -
    +
      {% for link in site.aux_links %}
    • {{ link.first }}
      • {% endfor %} diff --git a/_sass/layout.scss b/_sass/layout.scss index e3c93e4..35b9631 100644 --- a/_sass/layout.scss +++ b/_sass/layout.scss @@ -79,8 +79,6 @@ @include mq(md) { background-color: $white; - border-bottom: $border $border-color; - } .main-content { @@ -88,8 +86,11 @@ @include mq(md) { display: flex; - justify-content: space-between; + justify-content: flex-end; + height: 60px; padding-top: $sp-4; + padding-bottom: $sp-4; + border-bottom: $border $border-color; } } } diff --git a/_sass/navigation.scss b/_sass/navigation.scss index 0c7925c..e5d580b 100644 --- a/_sass/navigation.scss +++ b/_sass/navigation.scss @@ -14,7 +14,7 @@ z-index: 101; height: 60px; padding-top: $sp-4; - box-shadow: inset 0 -1px 0 $border-color; + border-bottom: $border $border-color; } } diff --git a/_sass/search.scss b/_sass/search.scss index 7037080..7e3a802 100644 --- a/_sass/search.scss +++ b/_sass/search.scss @@ -17,7 +17,7 @@ display: block; padding-top: $sp-1; padding-right: 0; - padding-bottom: $sp-4; + padding-bottom: 0; padding-left: 0; margin-bottom: 0; background-color: transparent; diff --git a/assets/js/just-the-docs.js b/assets/js/just-the-docs.js index dd24cfc..3c0a1b5 100644 --- a/assets/js/just-the-docs.js +++ b/assets/js/just-the-docs.js @@ -155,7 +155,9 @@ function initSearch() { function ready(){ toggleNav(); - initSearch(); + if (typeof lunr !== 'undefined') { + initSearch(); + } } // in case the document is already rendered From e41c1701a5cf495f62475cc492c0e4cbeb463410 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 11:47:14 -0500 Subject: [PATCH 4/7] Bump nav order for new docs --- docs/customization.md | 2 +- docs/navigation-structure.md | 2 +- docs/search.md | 2 +- docs/ui-components/code.md | 2 +- docs/ui-components/ui-components.md | 2 +- docs/utilities/utilities.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/customization.md b/docs/customization.md index 6bcb842..b5a4f83 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -1,7 +1,7 @@ --- layout: default title: Customization -nav_order: 5 +nav_order: 6 --- # Customization diff --git a/docs/navigation-structure.md b/docs/navigation-structure.md index 2bce40f..8114321 100644 --- a/docs/navigation-structure.md +++ b/docs/navigation-structure.md @@ -1,7 +1,7 @@ --- layout: default title: Navigation Structure -nav_order: 4 +nav_order: 5 --- # Navigation Structure diff --git a/docs/search.md b/docs/search.md index f585015..8656427 100644 --- a/docs/search.md +++ b/docs/search.md @@ -1,7 +1,7 @@ --- layout: default title: Search -nav_order: 6 +nav_order: 7 --- # Search diff --git a/docs/ui-components/code.md b/docs/ui-components/code.md index c98055c..40faf41 100644 --- a/docs/ui-components/code.md +++ b/docs/ui-components/code.md @@ -2,7 +2,7 @@ layout: default title: Code parent: UI Components -nav_order: 5 +nav_order: 6 --- # Code diff --git a/docs/ui-components/ui-components.md b/docs/ui-components/ui-components.md index 26df511..00e34b8 100644 --- a/docs/ui-components/ui-components.md +++ b/docs/ui-components/ui-components.md @@ -1,7 +1,7 @@ --- layout: default title: UI Components -nav_order: 2 +nav_order: 3 has_children: true parent: UI Components permalink: /ui-components diff --git a/docs/utilities/utilities.md b/docs/utilities/utilities.md index d897142..58cdf01 100644 --- a/docs/utilities/utilities.md +++ b/docs/utilities/utilities.md @@ -1,7 +1,7 @@ --- layout: default title: Utilities -nav_order: 3 +nav_order: 4 parent: Utilities has_children: true permalink: /utilities From c6ca6f61ab99a67e972c12e842ac949b786bbd2c Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 11:47:30 -0500 Subject: [PATCH 5/7] Update docs for search config --- docs/search.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/search.md b/docs/search.md index 8656427..0c9543f 100644 --- a/docs/search.md +++ b/docs/search.md @@ -12,7 +12,9 @@ Just the docs uses [lunr.js](http://lunrjs.com) to add a client-side search inte - Page content - Page URL -## Setup search +## Set up search + +### 1. Generate search index Before you can use search, you must initialize the feature by running this rake command that comes with the `just-the-docs` @@ -41,3 +43,12 @@ your search index. Alternatively, you can create the file manually in the ``` _Note: If you don't run this rake command or create this file manually, search will not work (or it will use the search index data from this docs site, not your site's content)._ + +### 2. Enable search in configuration + +In your site's `_config.yml` enable search: + +```yml +# Enable or disable the site search +search_enabled: true +``` From b98cac862087fd57c9de2275ee9f898f427c5f72 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 11:47:46 -0500 Subject: [PATCH 6/7] Add new configuration docs --- docs/configuration.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/configuration.md diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..c2f867b --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,25 @@ +--- +layout: default +title: Configuration +nav_order: 2 +--- + +# Configuration + +Just the Docs has some specific configuration parameters that can be definied in your Jekyll site's `config.yml` file. + +## Search enabled + +```yml +# Enable or disable the site search +search_enabled: true +``` + +## Aux links + +```yml +# Aux links for the upper right navigation +aux_links: +"Just the Docs on GitHub": + - "//github.com/pmarsceill/just-the-docs" +``` From 32b708cb58bcc2eaa780a97ba1b50d118b5fb623 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Fri, 16 Nov 2018 11:49:29 -0500 Subject: [PATCH 7/7] whitespace --- _sass/content.scss | 1 + 1 file changed, 1 insertion(+) diff --git a/_sass/content.scss b/_sass/content.scss index 7a41e3a..1dd5256 100644 --- a/_sass/content.scss +++ b/_sass/content.scss @@ -63,6 +63,7 @@ .task-list-item { display: flex; align-items: center; + &::before { content: ""; }