1
0
mirror of https://github.com/thangisme/notes.git synced 2024-10-31 20:47:19 -04:00
notes/docs/configuration.md

51 lines
1.2 KiB
Markdown
Raw Normal View History

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