mirror of
https://github.com/thangisme/notes.git
synced 2024-11-06 21:07:20 -05:00
51 lines
1.2 KiB
Markdown
51 lines
1.2 KiB
Markdown
---
|
|
layout: default
|
|
title: Configuration
|
|
nav_order: 2
|
|
---
|
|
|
|
# Configuration
|
|
|
|
Just the Docs has some specific configuration parameters that can be definied in your Jekyll site's `_config.yml` file.
|
|
|
|
## Search enabled
|
|
|
|
```yml
|
|
# Enable or disable the site search
|
|
search_enabled: true
|
|
```
|
|
|
|
## Aux links
|
|
|
|
```yml
|
|
# Aux links for the upper right navigation
|
|
aux_links:
|
|
"Just the Docs on GitHub":
|
|
- "//github.com/pmarsceill/just-the-docs"
|
|
```
|
|
|
|
## Color scheme
|
|
|
|
```yml
|
|
# 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(){
|
|
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.
|