mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-17 00:22:24 -06:00
100 lines
2.1 KiB
Markdown
100 lines
2.1 KiB
Markdown
---
|
|
layout: default
|
|
title: Configuration
|
|
nav_order: 2
|
|
---
|
|
|
|
# Configuration
|
|
{: .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 }
|
|
|
|
## Table of contents
|
|
{: .no_toc .text-delta }
|
|
|
|
1. TOC
|
|
{:toc}
|
|
|
|
---
|
|
|
|
|
|
View this site's [_config.yml](https://github.com/pmarsceill/just-the-docs/tree/master/_config.yml) file as an example.
|
|
|
|
## Site logo
|
|
|
|
```yaml
|
|
# Set a path/url to a logo that will be displayed instead of the title
|
|
logo: "/assets/images/just-the-docs.png"
|
|
```
|
|
|
|
## Search
|
|
|
|
```yaml
|
|
# Enable or disable the site search
|
|
# Supports true (default) or false
|
|
search_enabled: true
|
|
|
|
# Enable support for hyphenated search words:
|
|
search_tokenizer_separator: /[\s/]+/
|
|
```
|
|
|
|
## Aux links
|
|
|
|
```yaml
|
|
# Aux links for the upper right navigation
|
|
aux_links:
|
|
"Just the Docs on GitHub":
|
|
- "//github.com/pmarsceill/just-the-docs"
|
|
```
|
|
|
|
## Heading anchor links
|
|
|
|
```yaml
|
|
# Heading anchor links appear on hover over h1-h6 tags in page content
|
|
# allowing users to deep link to a particular heading on a page.
|
|
#
|
|
# Supports true (default) or false
|
|
heading_anchors: true
|
|
```
|
|
|
|
## Footer content
|
|
|
|
```yaml
|
|
# Footer content appears at the bottom of every page's main content
|
|
footer_content: "Copyright © 2017-2019 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>"
|
|
```
|
|
|
|
## Color scheme
|
|
|
|
```yaml
|
|
# Color scheme supports "light" (default) and "dark"
|
|
color_scheme: dark
|
|
```
|
|
<button class="btn js-toggle-dark-mode">Preview dark color scheme</button>
|
|
|
|
<script>
|
|
const toggleDarkMode = document.querySelector('.js-toggle-dark-mode');
|
|
|
|
jtd.addEvent(toggleDarkMode, 'click', function(){
|
|
if (jtd.getTheme() === 'dark') {
|
|
jtd.setTheme('light');
|
|
toggleDarkMode.textContent = 'Preview dark color scheme';
|
|
} else {
|
|
jtd.setTheme('dark');
|
|
toggleDarkMode.textContent = 'Return to the light side';
|
|
}
|
|
});
|
|
</script>
|
|
|
|
See [Customization]({{ site.baseurl }}{% link docs/customization.md %}) for more information.
|
|
|
|
## Google Analytics
|
|
|
|
```yaml
|
|
# Google Analytics Tracking (optional)
|
|
# e.g, UA-1234567-89
|
|
ga_tracking: UA-5555555-55
|
|
```
|