mirror of
https://github.com/thangisme/notes.git
synced 2024-12-22 13:06:27 -05:00
124 lines
4.5 KiB
YAML
124 lines
4.5 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: "/just-the-docs" # the subpath of your site, e.g. /blog
|
|
url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
|
|
|
|
permalink: pretty
|
|
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"
|
|
, "docs/tests/"
|
|
]
|
|
|
|
# Regression tests
|
|
# By default, the pages in /docs/tests are excluded when the ste is built.
|
|
# To include them, comment-out the relevant line above.
|
|
# Uncommenting the following line doesn't work - see https://github.com/jekyll/jekyll/issues/4791
|
|
# include: ["docs/tests/"]
|
|
|
|
# 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: 3
|
|
# Maximum amount of words to display before a matched word in the preview
|
|
# Default: 5
|
|
preview_words_before: 5
|
|
# Maximum amount of words to display after a matched word in the preview
|
|
# Default: 10
|
|
preview_words_after: 10
|
|
# 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
|
|
|
|
# Enable or disable heading anchors
|
|
heading_anchors: true
|
|
|
|
# Aux links for the upper right navigation
|
|
aux_links:
|
|
"Just the Docs on GitHub":
|
|
- "//github.com/pmarsceill/just-the-docs"
|
|
|
|
# Makes Aux links open in a new tab. Default is false
|
|
aux_links_new_tab: false
|
|
|
|
# Sort order for navigation links
|
|
# nav_sort: case_insensitive # default, equivalent to nil
|
|
nav_sort: case_sensitive # Capital letters sorted before lowercase
|
|
|
|
# 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/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
|
|
|
|
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
|
|
color_scheme: nil
|
|
|
|
# Google Analytics Tracking (optional)
|
|
# e.g, UA-1234567-89
|
|
ga_tracking: UA-2709176-10
|
|
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
|
|
|
|
plugins:
|
|
- jekyll-seo-tag
|
|
|
|
kramdown:
|
|
syntax_highlighter_opts:
|
|
block:
|
|
line_numbers: false
|
|
|
|
compress_html:
|
|
clippings: all
|
|
comments: all
|
|
endings: all
|
|
startings: []
|
|
blanklines: false
|
|
profile: false
|
|
# ignore:
|
|
# envs: all
|