1
0
mirror of https://github.com/thangisme/notes.git synced 2025-10-13 06:04:18 -04:00
Files
notes/docs/configuration.md
2019-01-15 20:48:48 -05:00

1.2 KiB

layout, title, nav_order
layout title nav_order
default Configuration 2

Configuration

Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's _config.yml file.

Search enabled

# Enable or disable the site search
search_enabled: true
# Aux links for the upper right navigation
aux_links:
    "Just the Docs on GitHub":
      - "//github.com/pmarsceill/just-the-docs"

Color scheme

# Color scheme currently only supports "dark" or nil (default)
color_scheme: "dark"

Preview dark color scheme

<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') 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.