Skip to content

Instantly share code, notes, and snippets.

@14paxton
Last active August 10, 2023 22:27
Show Gist options
  • Save 14paxton/e0dd671b07d810ab13ae37b6828fe63f to your computer and use it in GitHub Desktop.
Save 14paxton/e0dd671b07d810ab13ae37b6828fe63f to your computer and use it in GitHub Desktop.
github pages yaml
title: Paxton's Notes
description: Coding Notes
theme: just-the-docs
source: .
baseurl: "" # the subpath of your site, e.g. /blog
url: https://paxtonb.com # the base hostname & protocol for your site, e.g. http://example.com
repository: 14paxton.github.io/14paxton.github.io # for github-metadata
gist:
noscript: false
permalink: pretty
aux_links:
Template Repository: https://github.com/14paxton/14paxton.github.io
aux_links_new_tab: true
# Conversion
markdown: kramdown
highlighter: rouge
lsi: false
excerpt_separator: "\n\n"
incremental: false
kramdown:
math_engine: mathjax
#input: Kramdown
#gfm_quirks: [ paragraph_end ]
syntax_highlighter: rouge
syntax_highlighter_opts:
block:
line_numbers: false
auto_ids: true
entity_output: as_char
toc_levels: [ 1, 2, 3, 4, 5, 6 ]
smart_quotes: lsquo,rsquo,ldquo,rdquo
hard_wrap: true
line_width: 240
footnote_nr: 1
show_warnings: true
plugins:
- jekyll-default-layout
- jekyll-github-metadata
- kramdown-parser-gfm
# - kramdown-syntax-coderay
relative_links:
enabled: true
collections: true
################################
# just-the-docs template config
# 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: ""
# 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/14paxton/14paxton.github.io"
gh_edit_branch: "master" # the branch that your docs is served from
gh_edit_source: . # the source that your files originate from
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately
# Enable or disable heading anchors
heading_anchors: true
# For copy button on code
enable_copy_code_button: true
# Color scheme supports "light" (default) and "dark"
color_scheme: dark
#To avoid non-conforming HTML and unsatisfactory layout, HTML compression can be turned off by
#using the following configuration option:
compress_html:
clippings: all
comments: all
endings: all
startings: [ ]
blanklines: false
profile: false
# ignore:
# envs: all
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
# 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: 6
# Maximum amount of previews per search result
# Default: 3
previews: 5
# 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: true
#############################
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment