mirror of
https://github.com/thangisme/notes.git
synced 2024-09-07 01:24:15 -04:00
2.5 KiB
2.5 KiB
layout | title | nav_order |
---|---|---|
default | Configuration | 2 |
Configuration
{: .no_toc }
Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's _config.yml file. {: .fs-6 .fw-300 }
Table of contents
{: .no_toc .text-delta }
- TOC {:toc}
View this site's _config.yml file as an example.
Site logo
# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/images/just-the-docs.png"
Search
# Enable or disable the site search
# Supports true (default) or false
search_enabled: true
search:
# Split documents into sections that can be individually searched
# Supports 1 - 6, default: 2
heading_level: 2
# Maximum amount of previews to display
# Default: 3
previews: 3
# Maximum amount of words to display before a matched word in the preview
# Default: 5
preview_words_before: 5
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after: 10
# Include the relative url in the search
# Supports true (default) or false
rel_url: false
# Enable support for hyphenated search words
# Default: /[\s\-/]+/
tokenizer_separator: /[\s/]+/
# Enable or disable the search button
# Supports true or false (default)
button: true
Aux links
# Aux links for the upper right navigation
aux_links:
"Just the Docs on GitHub":
- "//github.com/pmarsceill/just-the-docs"
Heading anchor links
# Heading anchor links appear on hover over h1-h6 tags in page content
# allowing users to deep link to a particular heading on a page.
#
# Supports true (default) or false/nil
heading_anchors: true
Footer content
# Footer content appears at the bottom of every page's main content
footer_content: "Copyright © 2017-2019 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>"
Color scheme
# Color scheme currently only supports "dark" or nil (default)
color_scheme: "dark"
Preview dark color scheme
See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more information.
Google Analytics
# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
ga_tracking: UA-5555555-55