-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0600906
commit a7e6670
Showing
4 changed files
with
3 additions
and
214 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,141 +1,3 @@ | ||
remote_theme: pmarsceill/just-the-docs | ||
title: Kamaji Documentation | ||
description: A Jekyll theme for documentation | ||
repository: ISSUIUC/ISS_HILSIM # for github-metadata | ||
|
||
permalink: pretty | ||
|
||
# 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 | ||
|
||
# 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: | ||
"Kamaji on GitHub": | ||
- "https://github.com/ISSUIUC/ISS_HILSIM" | ||
|
||
# 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 | ||
|
||
# External navigation links | ||
nav_external_links: | ||
- title: Kamaji on GitHub | ||
url: https://github.com/ISSUIUC/ISS_HILSIM | ||
|
||
# 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 | ||
|
||
|
||
|
||
gh_edit_link: false # show or hide edit this page link | ||
gh_edit_link_text: "Edit this page on GitHub" | ||
gh_edit_repository: "https://github.com/ISSUIUC/ISS_HILSIM" # 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-default-layout | ||
|
||
kramdown: | ||
syntax_highlighter_opts: | ||
block: | ||
line_numbers: false | ||
|
||
compress_html: | ||
clippings: all | ||
comments: all | ||
endings: all | ||
startings: [] | ||
blanklines: false | ||
profile: false | ||
# ignore: | ||
# envs: all | ||
title: Kamaji Docs | ||
description: The documentation site for Kamaji, the ISS Hardware-in-the-loop simulator. | ||
theme: jekyll-theme-cayman |