mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-16 08:02:24 -06:00
7220197a1f
Mathjax config options added. `compress_html` config option changed, Mathjax script loaded by head when `page.mathjax` is truthy. Documentation and test page added. See also issue #198.
102 lines
2.4 KiB
Markdown
102 lines
2.4 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.
|
|
|
|
## Search enabled
|
|
|
|
```yaml
|
|
# Enable or disable the site search
|
|
# Support true (default) or false
|
|
search_enabled: true
|
|
```
|
|
|
|
## 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.
|
|
#
|
|
# Supprts true (default) or false/nil
|
|
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 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');
|
|
|
|
jtd.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
|
|
|
|
```yaml
|
|
# Google Analytics Tracking (optional)
|
|
# e.g, UA-1234567-89
|
|
ga_tracking: UA-5555555-55
|
|
```
|
|
|
|
## Mathjax
|
|
|
|
```yaml
|
|
compress_html:
|
|
blanklines: true # required for Mathjax
|
|
mathjax:
|
|
source: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS_CHTML
|
|
config: 'MathJax.Hub.Config({ TeX: { equationNumbers: { autoNumber: "AMS" } } })'
|
|
```
|