mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-03 10:41:23 -06:00
ce32212026
Splitting this out of #1513 to make my life reviewing a bit easier! Note that this does *not* affect our downstream users, just the docs site for this project itself. --------- Co-authored-by: Michael Ball <michael@mball.co>
206 lines
6.6 KiB
YAML
206 lines
6.6 KiB
YAML
# Welcome to Jekyll!
|
|
#
|
|
# This config file is meant for settings that affect your whole site, values
|
|
# which you are expected to set up once and rarely edit after that. If you find
|
|
# yourself editing these this file very often, consider using Jekyll's data files
|
|
# feature for the data you need to update frequently.
|
|
#
|
|
# For technical reasons, this file is *NOT* reloaded automatically when you use
|
|
# 'jekyll serve'. If you change this file, please restart the server process.
|
|
|
|
# Site settings
|
|
# These are used to personalize your new site. If you look in the HTML files,
|
|
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
|
|
# You can create any custom variable you would like, and they will be accessible
|
|
# in the templates via {{ site.myvariable }}.
|
|
title: Just the Docs
|
|
description: A Jekyll theme for documentation
|
|
baseurl: "" # the subpath of your site, e.g. /blog
|
|
url: "https://just-the-docs.com" # the base hostname & protocol for your site, e.g. http://example.com
|
|
repository: just-the-docs/just-the-docs # for github-metadata
|
|
|
|
permalink: pretty
|
|
|
|
defaults:
|
|
- scope:
|
|
path: "docs" # an empty string here means all files in the project
|
|
type: "pages"
|
|
values:
|
|
layout: "default"
|
|
|
|
exclude:
|
|
# from https://github.com/jekyll/jekyll/blob/master/lib/site_template/_config.yml:
|
|
- .sass-cache/
|
|
- .jekyll-cache/
|
|
- gemfiles/
|
|
- Gemfile
|
|
- Gemfile.lock
|
|
- node_modules/
|
|
- vendor/bundle/
|
|
- vendor/cache/
|
|
- vendor/gems/
|
|
- vendor/ruby/
|
|
# specific to the theme website:
|
|
- bin/
|
|
- lib/
|
|
- "*.gemspec"
|
|
- "*.gem"
|
|
- LICENSE.txt
|
|
- package.json
|
|
- package-lock.json
|
|
- Rakefile
|
|
- README.md
|
|
- CODE_OF_CONDUCT.md
|
|
- docker-compose.yml
|
|
- Dockerfile
|
|
# theme test code
|
|
- fixtures/
|
|
|
|
# Set a path/url to a logo that will be displayed instead of the title
|
|
#logo: "/assets/images/just-the-docs.png"
|
|
|
|
# Enable or disable the site search
|
|
# Supports true (default) or false
|
|
search_enabled: true
|
|
search:
|
|
# Split pages into sections that can be searched individually
|
|
# Supports 1 - 6, default: 2
|
|
heading_level: 2
|
|
# Maximum amount of previews per search result
|
|
# Default: 3
|
|
previews: 2
|
|
# Maximum amount of words to display before a matched word in the preview
|
|
# Default: 5
|
|
preview_words_before: 3
|
|
# Maximum amount of words to display after a matched word in the preview
|
|
# Default: 10
|
|
preview_words_after: 3
|
|
# Set the search token separator
|
|
# Default: /[\s\-/]+/
|
|
# Example: enable support for hyphenated search words
|
|
tokenizer_separator: /[\s/]+/
|
|
# Display the relative url in search results
|
|
# Supports true (default) or false
|
|
rel_url: true
|
|
# Enable or disable the search button that appears in the bottom right corner of every page
|
|
# Supports true or false (default)
|
|
button: false
|
|
# Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
|
|
focus_shortcut_key: "k"
|
|
|
|
# For copy button on code
|
|
enable_copy_code_button: true
|
|
|
|
# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in
|
|
mermaid:
|
|
# Version of mermaid library
|
|
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
|
|
version: "9.1.6"
|
|
# Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js
|
|
# See also docs/ui-components/code
|
|
# To load mermaid from a local library, also use the `path` key to specify the location of the library; e.g.
|
|
# for (v10+):
|
|
# path: "/assets/js/mermaid.esm.min.mjs"
|
|
# for (<v10):
|
|
# path: "/assets/js/mermaid.min.js"
|
|
# Note: copy both `mermaid.esm.min.mjs` (v10+) or `mermaid.min.js` (<v10) and the associated `.map` file from the specified version of `mermaid/dist` to `/assets/js/`.
|
|
|
|
# Enable or disable heading anchors
|
|
heading_anchors: true
|
|
|
|
# Aux links for the upper right navigation
|
|
aux_links:
|
|
"Just the Docs on GitHub":
|
|
- "https://github.com/just-the-docs/just-the-docs"
|
|
|
|
# Makes Aux links open in a new tab. Default is false
|
|
aux_links_new_tab: false
|
|
|
|
# Enable or disable the side/mobile menu globally
|
|
# Nav menu can also be selectively enabled or disabled using page variables or the minimal layout
|
|
nav_enabled: true
|
|
|
|
# Sort order for navigation links
|
|
# nav_sort: case_insensitive # default, equivalent to nil
|
|
nav_sort: case_sensitive # Capital letters sorted before lowercase
|
|
|
|
# External navigation links
|
|
nav_external_links:
|
|
- title: Just the Docs on GitHub
|
|
url: https://github.com/just-the-docs/just-the-docs
|
|
|
|
# Show navigation error report
|
|
nav_error_report: true # default is false/nil.
|
|
|
|
liquid:
|
|
error_mode: strict
|
|
strict_filters: true
|
|
|
|
# Footer content
|
|
# appears at the bottom of every page's main content
|
|
|
|
# Back to top link
|
|
back_to_top: true
|
|
back_to_top_text: "Back to top"
|
|
|
|
footer_content: 'Copyright © 2017-2020 Patrick Marsceill. Distributed by an <a href="https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt">MIT license.</a> <a href="https://www.netlify.com/">This site is powered by Netlify.</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/just-the-docs/just-the-docs" # the github URL for your repo
|
|
gh_edit_branch: "main" # the branch that your docs is served from
|
|
# gh_edit_source: docs # the source that your files originate from
|
|
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
|
|
|
|
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
|
|
color_scheme: nil
|
|
|
|
callouts_level: quiet # or loud
|
|
callouts:
|
|
highlight:
|
|
color: yellow
|
|
important:
|
|
title: Important
|
|
color: blue
|
|
new:
|
|
title: New
|
|
color: green
|
|
note:
|
|
title: Note
|
|
color: purple
|
|
warning:
|
|
title: Warning
|
|
color: red
|
|
|
|
# Google Analytics Tracking (optional)
|
|
# Supports a CSV of tracking ID strings (eg. "UA-1234567-89,G-1AB234CDE5")
|
|
# Note: the main Just the Docs site does *not* use Google Analytics.
|
|
# ga_tracking: UA-2709176-10,G-5FG1HLH3XQ
|
|
# ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
|
|
|
|
plugins:
|
|
- jekyll-seo-tag
|
|
- jekyll-github-metadata
|
|
- jekyll-include-cache
|
|
- jekyll-sitemap
|
|
|
|
kramdown:
|
|
syntax_highlighter_opts:
|
|
block:
|
|
line_numbers: false
|
|
|
|
compress_html:
|
|
clippings: all
|
|
comments: all
|
|
endings: all
|
|
startings: []
|
|
blanklines: false
|
|
profile: false
|
|
# ignore:
|
|
# envs: all
|