From 76d8f0c50cbff7fa5da19e98a6ab4e808c902472 Mon Sep 17 00:00:00 2001 From: Patrick Marsceill Date: Sun, 4 Jun 2017 17:50:01 -0400 Subject: [PATCH] I forget --- _config.yml | 8 +++++++ _layouts/default.html | 40 ++++++++++++++++++++++------------- _sass/layout.scss | 14 ++++++++++-- _sass/navigation.scss | 5 ----- _sass/search.scss | 22 +++++++------------ assets/js/just-the-docs.js | 2 +- docs/ui-components/buttons.md | 3 ++- index.md | 15 ++++--------- just-the-docs.gemspec | 2 +- search-data.json | 11 +++++----- 10 files changed, 67 insertions(+), 55 deletions(-) diff --git a/_config.yml b/_config.yml index 79084a8..60ab6ce 100644 --- a/_config.yml +++ b/_config.yml @@ -25,3 +25,11 @@ sass: permalink: pretty exclude: ["node_modules/", "*.gemspec", "Gemfile", "Gemfile.lock", "package.json", "LICENSE.txt"] + +aux_links: + GitHub: + - "//github.com/pmarsceill/just-the-docs" + "Support link": + - "//google.com/turds" + "Another link": + - "//yahoo.com" diff --git a/_layouts/default.html b/_layouts/default.html index bfeb2de..e8c090e 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -15,24 +15,34 @@
-
-
- - Search +
+
+
+
+ + Search +
+
+
+ {% if site.aux_links != nil %} + + {% endif %}
-
-
+
{% unless page.url == "/" %} - + {% if page.parent != nil and page.parent != page.title %} + + {% endif %} {% endunless %}
{{ content }} diff --git a/_sass/layout.scss b/_sass/layout.scss index 8c07ea0..3124b66 100644 --- a/_sass/layout.scss +++ b/_sass/layout.scss @@ -53,8 +53,7 @@ } } -.main-content, -.search { +.main-content { padding-top: $gutter-spacing-sm; @include container; @@ -73,6 +72,17 @@ } } +.page-header { + border-bottom: $border $border-color; + + @include mq(md) { + .main-content { + display: flex; + justify-content: space-between; + } + } +} + .navigation, .site-title { diff --git a/_sass/navigation.scss b/_sass/navigation.scss index 8a16e9c..9e76e5a 100644 --- a/_sass/navigation.scss +++ b/_sass/navigation.scss @@ -105,13 +105,8 @@ .breadcrumb-nav-list { padding-left: 0; - margin-top: $sp-3; margin-bottom: $sp-3; list-style: none; - - @include mq(md) { - margin-bottom: $sp-5; - } } .breadcrumb-nav-list-item { diff --git a/_sass/search.scss b/_sass/search.scss index df3c3ff..f57e5be 100644 --- a/_sass/search.scss +++ b/_sass/search.scss @@ -8,10 +8,9 @@ @include mq(md) { position: relative; z-index: 99; - display: flex; - justify-content: flex-end; - padding-top: 0; - padding-bottom: 0; + display: block; + padding-top: $sp-1; + padding-bottom: $gutter-spacing / 2; } } @@ -20,22 +19,17 @@ &.active { position: absolute; - top: $sp-10; - right: $gutter-spacing; + top: $sp-1; z-index: 100; display: block; width: 300px; - margin-top: $sp-2; + margin-top: $gutter-spacing; background: $white; box-shadow: 0 1px 3px rgba(0, 0, 0, 0.07), 0 4px 14px rgba(0, 0, 0, 0.05); } } .search-input-wrap { - position: absolute; - top: $sp-7; - right: $gutter-spacing; - z-index: 99; display: flex; background-color: $white; } @@ -46,14 +40,13 @@ padding-bottom: $sp-1; border-top: 0; border-right: 0; - border-bottom: $border $border-color; + border-bottom: 0; border-left: 0; order: 2; &:focus { - border-bottom: $border $grey-lt-300; outline: 0; - box-shadow: 0; + box-shadow: none; + .search-icon { fill: $purple-000; @@ -70,6 +63,7 @@ .search-results-list { padding-left: 0; + margin-top: $sp-1; margin-bottom: $sp-1; list-style: none; @include fs-3; diff --git a/assets/js/just-the-docs.js b/assets/js/just-the-docs.js index 20033ab..ec68f91 100644 --- a/assets/js/just-the-docs.js +++ b/assets/js/just-the-docs.js @@ -30,7 +30,7 @@ function toggleNav(){ function initSearch() { var index = lunr(function () { this.ref('id'); - this.field('title', { boost: 20 }); + this.field('title'); this.field('content'); this.field('url'); }); diff --git a/docs/ui-components/buttons.md b/docs/ui-components/buttons.md index 1184af2..849071d 100644 --- a/docs/ui-components/buttons.md +++ b/docs/ui-components/buttons.md @@ -62,7 +62,8 @@ GitHub flavored markdown does not support the `button` element, so you'll have t ### Button size -Wrap the button in container that uses the [font-size utility classes]({{ site.baseurl }}{% link docs/utilities/utilities.md %}#typography) to scale buttons: +Wrap the button in container that uses the [font-size utility classes]({{ +site.baseurl }}{% link docs/utilities/typography.md %}) to scale buttons:
diff --git a/index.md b/index.md index 36cd3f5..bb0c229 100644 --- a/index.md +++ b/index.md @@ -5,20 +5,13 @@ nav_order: 1 --- -# Focus on writing your docs, instead of building a website for them. +# Focus on writing good documentation {: .fs-9 .mb-md-8 :} -
-
- -
-
- Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub pages. - {: .fs-6 .fw-300 } +Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub pages. +{: .fs-6 .fw-300 } - [Get started now](#getting-started){: .btn .btn-purple .mr-2 } [View it on GitHub](https://github.com/pmarsceill/just-the-docs){: .btn } -
-
+[Get started now](#getting-started){: .btn .btn-purple .mr-2 } [View it on GitHub](https://github.com/pmarsceill/just-the-docs){: .btn } --- diff --git a/just-the-docs.gemspec b/just-the-docs.gemspec index 74e0668..6c8b3be 100644 --- a/just-the-docs.gemspec +++ b/just-the-docs.gemspec @@ -10,7 +10,7 @@ Gem::Specification.new do |spec| spec.homepage = "https://github.com/pmarsceill/just-the-docs" spec.license = "MIT" - spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(assets|_layouts|_includes|_sass|LICENSE|README|search-data.json)}i) } + spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(assets|bin|lib|_layouts|_includes|_sass|LICENSE|README)}i) } spec.add_runtime_dependency "jekyll", "~> 3.3" diff --git a/search-data.json b/search-data.json index 93e3e32..4a71e7c 100644 --- a/search-data.json +++ b/search-data.json @@ -2,9 +2,10 @@ --- { {% for page in site.html_pages %}"{{ forloop.index0 }}": { - "id": "{{ forloop.index0 }}", - "title": "{{ page.title | xml_escape }}", - "content": "{{ page.content | markdownify | strip_html | xml_escape | remove: 'Table of contents' | remove: page.title | strip_newlines | replace: '\', ' '}}", - "url": " {{ page.url | xml_escape }}" - }{% unless forloop.last %},{% endunless %}{% endfor %} + "id": "{{ forloop.index0 }}", + "title": "{{ page.title | xml_escape }}", + "content": "{{ page.content | markdownify | strip_html | xml_escape | remove: 'Table of contents' | remove: page.title | strip_newlines | replace: '\', ' '}}", + "url": "{{ page.url | xml_escape }}" + }{% if forloop.last %}{% else %}, + {% endif %}{% endfor %} }