notes/docs/configuration.md

51 lines
1.2 KiB
Markdown
Raw Normal View History

2018-11-16 16:47:46 +00:00
---
layout: default
title: Configuration
nav_order: 2
---
# Configuration
2019-01-16 01:43:19 +00:00
Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's `_config.yml` file.
2018-11-16 16:47:46 +00:00
## Search enabled
2019-01-16 01:43:19 +00:00
```yaml
2018-11-16 16:47:46 +00:00
# Enable or disable the site search
search_enabled: true
```
## Aux links
2019-01-16 01:43:19 +00:00
```yaml
2018-11-16 16:47:46 +00:00
# Aux links for the upper right navigation
aux_links:
"Just the Docs on GitHub":
2018-11-26 16:26:44 +00:00
- "//github.com/pmarsceill/just-the-docs"
2018-11-16 16:47:46 +00:00
```
2018-11-18 16:07:45 +00:00
## Color scheme
2019-01-16 01:43:19 +00:00
```yaml
2018-11-18 16:07:45 +00:00
# Color scheme currently only supports "dark" or nil (default)
color_scheme: "dark"
```
<button class="btn js-toggle-dark-mode">Preview dark color scheme</button>
<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(){
2019-01-14 19:18:09 +00:00
if (cssFile.getAttribute('href') === originalCssRef) {
cssFile.setAttribute('href', darkModeCssRef)
} else {
cssFile.setAttribute('href', originalCssRef)
}
2018-11-18 16:07:45 +00:00
})
</script>
2019-01-14 19:18:09 +00:00
See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more information.