mirror of
https://github.com/thangisme/notes.git
synced 2024-12-22 17:26:25 -05:00
119 lines
3.5 KiB
Markdown
119 lines
3.5 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>"
|
|
|
|
# Footer last edited timestamp
|
|
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
|
|
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
|
|
|
|
# Footer "Edit this page on GitHub" link text
|
|
gh_edit_link: true # show or hide edit this page link
|
|
gh_edit_link_text: "Edit this page on GitHub."
|
|
gh_edit_repository: "https://github.com/pmarsceill/just-the-docs" # the github URL for your repo
|
|
gh_edit_branch: "master" # the branch that your docs is served from
|
|
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
|
|
```
|
|
|
|
- the "page last modified" data will only display if a page has a key called `last_modified_date`, formatted in some readable date format
|
|
- `last_edit_time_format` uses Ruby's DateTime formatter; see examples and more information [at this link.](https://apidock.com/ruby/DateTime/strftime)
|
|
- `gh_edit_repository` is the URL of the project's GitHub repository
|
|
- `gh_edit_branch` is the branch that the docs site is served from; defaults to `master`
|
|
- `gh_edit_view_mode` is `"tree"` by default, which brings the user to the github page; switch to `"edit"` to bring the user directly into editing mode
|
|
|
|
## 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
|
|
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true by default)
|
|
```
|