From 2b2ebf6033d6fa894928a972f91b32b64411e33c Mon Sep 17 00:00:00 2001 From: Patrick Marsceill <patrick.marsceill@gmail.com> Date: Tue, 13 Aug 2019 17:24:23 -0400 Subject: [PATCH] Lint and docs --- _config.yml | 2 +- _sass/search.scss | 8 ++++---- assets/css/dark-mode-preview.scss | 1 - assets/css/just-the-docs.scss | 1 - docs/configuration.md | 10 ++++++++++ 5 files changed, 15 insertions(+), 7 deletions(-) diff --git a/_config.yml b/_config.yml index 2af82026..46b37fb1 100644 --- a/_config.yml +++ b/_config.yml @@ -48,4 +48,4 @@ compress_html: endings: all startings: [] blank_lines: false - profile: false \ No newline at end of file + profile: false diff --git a/_sass/search.scss b/_sass/search.scss index a8b6a8e1..3eaa24fc 100644 --- a/_sass/search.scss +++ b/_sass/search.scss @@ -17,8 +17,8 @@ .search-input-wrap { display: flex; height: 100%; - background-color: $search-background-color; padding: $sp-2; + background-color: $search-background-color; border-radius: $border-radius; box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08); @@ -27,8 +27,8 @@ padding-right: 0; padding-bottom: 0; padding-left: 0; - border-radius: 0; background-color: $body-background-color; + border-radius: 0; box-shadow: none; } } @@ -70,11 +70,11 @@ .search-results-wrap { position: absolute; - display: none; z-index: 100; + display: none; width: 100%; - border-radius: $border-radius; background: $search-background-color; + border-radius: $border-radius; box-shadow: 0 1px 2px rgba(0, 0, 0, 0.12), 0 3px 10px rgba(0, 0, 0, 0.08); &.active { diff --git a/assets/css/dark-mode-preview.scss b/assets/css/dark-mode-preview.scss index 6f6fbea3..8b77da6a 100644 --- a/assets/css/dark-mode-preview.scss +++ b/assets/css/dark-mode-preview.scss @@ -33,7 +33,6 @@ @import "./search"; @import "./tables"; @import "./code"; -@import "./anchor_headings"; @import "./utilities/utilities"; // diff --git a/assets/css/just-the-docs.scss b/assets/css/just-the-docs.scss index b6d17d59..6a2eefa5 100644 --- a/assets/css/just-the-docs.scss +++ b/assets/css/just-the-docs.scss @@ -41,5 +41,4 @@ @import "./search"; @import "./tables"; @import "./code"; -@import "./anchor_headings"; @import "./utilities/utilities"; diff --git a/docs/configuration.md b/docs/configuration.md index 095fc209..f4646cbd 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -38,6 +38,16 @@ aux_links: - "//github.com/pmarsceill/just-the-docs" ``` +## Heading anchors +```yaml +# Heading anchors appear on hover over h1-h6 tags +# allowing users to deep link to a particular heading +# on a page. +# +# Supprts true (default) or false/nil +heading_anchors: true +``` + ## Color scheme ```yaml -- GitLab