2017-03-09 18:16:08 +00:00
|
|
|
# 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 }}.
|
2017-03-27 01:09:19 +00:00
|
|
|
title: Just the Docs
|
2017-03-09 18:16:08 +00:00
|
|
|
description: A Jekyll theme for documentation
|
2019-08-14 18:31:50 +00:00
|
|
|
baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog
|
2019-02-02 21:59:20 +00:00
|
|
|
url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
|
2017-03-09 18:16:08 +00:00
|
|
|
|
2017-03-24 13:47:37 +00:00
|
|
|
permalink: pretty
|
2018-12-16 19:29:35 +00:00
|
|
|
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
|
2017-06-04 21:50:01 +00:00
|
|
|
|
2019-08-17 12:46:28 +00:00
|
|
|
# Set a path/url to a logo that will be displayed instead of the title
|
|
|
|
#logo: "/assets/images/just-the-docs.png"
|
|
|
|
|
2018-11-16 16:46:43 +00:00
|
|
|
# Enable or disable the site search
|
|
|
|
search_enabled: true
|
|
|
|
|
2019-09-09 20:29:51 +00:00
|
|
|
# Set the search token separator for hyphenated-word search:
|
|
|
|
search_tokenizer_separator: /[\s/]+/
|
2019-08-29 13:36:13 +00:00
|
|
|
|
2019-08-13 21:23:35 +00:00
|
|
|
# Enable or disable heading anchors
|
|
|
|
heading_anchors: true
|
|
|
|
|
2017-11-08 16:23:05 +00:00
|
|
|
# Aux links for the upper right navigation
|
2017-06-04 21:50:01 +00:00
|
|
|
aux_links:
|
2018-10-23 15:39:30 +00:00
|
|
|
"Just the Docs on GitHub":
|
2017-06-04 21:50:01 +00:00
|
|
|
- "//github.com/pmarsceill/just-the-docs"
|
2018-11-15 20:12:12 +00:00
|
|
|
|
2019-10-02 05:22:34 +00:00
|
|
|
# Makes Aux links open in a new tab. Default is false
|
|
|
|
aux_links_new_tab: false
|
|
|
|
|
2020-04-25 12:53:45 +00:00
|
|
|
# Sort order for navigation links
|
|
|
|
nav_sort: case_insensitive # default, equivalent to nil
|
|
|
|
# nav_sort: case_sensitive # Capital letters sorted before lowercase
|
2019-08-06 19:56:29 +00:00
|
|
|
|
2020-04-24 19:39:44 +00:00
|
|
|
# Footer content
|
2020-04-24 02:38:45 +00:00
|
|
|
# appears at the bottom of every page's main content
|
2020-04-27 16:52:07 +00:00
|
|
|
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>"
|
2019-08-06 19:56:29 +00:00
|
|
|
|
2020-04-24 02:38:45 +00:00
|
|
|
# Footer last edited timestamp
|
2020-04-24 02:43:27 +00:00
|
|
|
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
|
2020-01-12 21:47:05 +00:00
|
|
|
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
|
2020-04-24 02:38:45 +00:00
|
|
|
|
|
|
|
# Footer "Edit this page on GitHub" link text
|
|
|
|
gh_edit_link: true # show or hide edit this page link
|
2020-04-27 17:14:42 +00:00
|
|
|
gh_edit_link_text: "Edit this page on GitHub"
|
2020-01-12 21:47:05 +00:00
|
|
|
gh_edit_repository: "https://github.com/pmarsceill/just-the-docs" # the github URL for your repo
|
2020-04-24 02:32:46 +00:00
|
|
|
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
|
2019-08-06 19:56:29 +00:00
|
|
|
|
2020-04-24 19:39:44 +00:00
|
|
|
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
|
2018-11-18 16:06:59 +00:00
|
|
|
color_scheme: nil
|
2019-02-02 20:32:04 +00:00
|
|
|
|
|
|
|
# Google Analytics Tracking (optional)
|
|
|
|
# e.g, UA-1234567-89
|
|
|
|
ga_tracking: UA-2709176-10
|
2020-04-27 16:51:48 +00:00
|
|
|
ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
|
2019-02-28 07:08:27 +00:00
|
|
|
|
|
|
|
plugins:
|
2019-05-04 19:59:33 +00:00
|
|
|
- jekyll-seo-tag
|
|
|
|
|
|
|
|
compress_html:
|
|
|
|
clippings: all
|
|
|
|
comments: all
|
|
|
|
endings: all
|
|
|
|
startings: []
|
2019-09-09 20:26:32 +00:00
|
|
|
blanklines: false
|
2019-08-13 21:24:23 +00:00
|
|
|
profile: false
|