| layout | default |
|---|---|
| title | Configuration |
| nav_order | 2 |
{: .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 }
{: .no_toc .text-delta }
- TOC {:toc}
View this site's _config.yml file as an example.
# 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 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.
# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
ga_tracking: UA-5555555-55