Rockingcool
/
paige-hugo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Use defaults in assignments, other doc clean up

Browse Source
master
Will Faught 2 years ago
parent 0534fef7d2
commit c47d3be282
1 changed files with 123 additions and 123 deletions
Show Stats Download Patch File Download Diff File

246
README.md
Unescape Escape View File

@ -182,173 +182,175 @@ There is a single parameter object with sensible defaults that can be overridden
```yaml ```yaml
paige: paige:
analytics: analytics:
chartbeat: # chartbeat.com chartbeat: # See https://chartbeat.com
account_id: "123456" account_id: "" # Example is "123456"
domain: "example.com" domain: "" # Example is "example.com"
clicky: # clicky.com clicky: # See https://clicky.com
account_id: "123456" account_id: "" # Example is "123456"
fathom: # usefathom.com fathom: # See https://usefathom.com
account_id: "123456" account_id: "" # Example is "123456"
finteza: # finteza.com finteza: # See https://finteza.com
account_id: "123456" account_id: "" # Example is "123456"
script_url: "https://example.com/script.js" script_url: "" # Example is "https://example.com/script.js"
hotjar: # hotjar.com hotjar: # See https://hotjar.com
account_id: "123456" account_id: "" # Example is "123456"
matomo: # matomo.org matomo: # See https://matomo.org
account_id: "123456" account_id: "" # Example is "123456"
host_url: "https://example.com" host_url: "" # Example is "https://example.com"
mixpanel: # mixpanel.com mixpanel: # See https://mixpanel.com
token: "123456" token: "" # Example is "123456"
plausible: # plausible.io plausible: # plausible.io
account_id: "123456" account_id: "" # Example is "123456"
woopra: # woopra.com woopra: # See https://woopra.com
domain: "example.com" domain: "" # Example is "example.com"
yandex: # metrica.yandex.com yandex: # See https://metrica.yandex.com
account_id: "123456" account_id: "" # Example is "123456"
bootstrap: bootstrap: # See https://getbootstrap.com
icons: icons:
link_href: "https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.2/font/bootstrap-icons.css" # Local or remote file link_href: "https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.3/font/bootstrap-icons.css" # Local or remote resource glob
link_integrity: "sha384-b6lVK+yci+bfDmaY1u0zE8YYJt0TZxLEAFyYSLHId4xoVvsrQu3INevFKo+Xir8e" # File integrity hash link_integrity: "sha384-b6lVK+yci+bfDmaY1u0zE8YYJt0TZxLEAFyYSLHId4xoVvsrQu3INevFKo+Xir8e" # Subresource integrity hash
script: script:
raw: false # Do not copy or process the file; default is false raw: false # Do not copy or process the resource
script_integrity: "sha384-OERcA2EqjJCMA+/3y+gxIOqMEjwtxJY7qPCqsdltbNJuaOe923+mo//f6V8Qbsw3" # File integrity hash script_integrity: "sha384-w76AqPfDkMBDXo30jS1Sgez6pr3x5MlQ1ZAGC+nuZB+EYdgRZgiwxhTBTkF7CXvN" # Subresource integrity hash
script_src: "https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/js/bootstrap.bundle.min.js" # Local or remote file script_src: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.bundle.min.js" # Local or remote resource glob
style: style:
link_href: "https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/css/bootstrap.min.css" # Local or remote file link_href: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css" # Local or remote resource glob
link_integrity: "sha384-Zenh87qX5JnK2Jl0vWa8Ck2rdkQ2Bzep5IDxbcnCeuOxjzrPF/et3URy9Bv1WTRi" # File integrity hash link_integrity: "sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" # Subresource integrity hash
raw: false # Do not copy or process the file; default is false raw: false # Do not copy or process the resource
color: "#123456" # Theme color for Safari and Windows; default is "#0d6efd" color: "#0d6efd" # Theme color for Safari and Windows
color_scheme: "light" # Use the "light" or "dark" color scheme without automatic switching; default is "" color_scheme: "" # Always use this color scheme without automatic switching; must be "", "light", or "dark"
comments: comments:
cactus: # cactus.chat cactus: # See https://cactus.chat
account_id: "123456" account_id: "" # Example is "123456"
commento: # commento.io commento: # See https://commento.io
script_url: "https://example.com/script.js" script_url: "" # Example is "https://example.com/script.js"
hyvor: # hyvor.com hyvor: # See https://hyvor.com
account_id: "123456" account_id: "" # Example is "123456"
intensedebate: # intensedebate.com intensedebate: # intensedebate.com
account_id: "123456" account_id: "" # Example is "123456"
isso: # isso-comments.de isso: # See https://isso-comments.de
script_url: "https://example.com/script.js" script_url: "" # Example is "https://example.com/script.js"
remark42: # remark42.com remark42: # See https://remark42.com
host_url: "https://example.com" host_url: "" # Example is "https://example.com"
site_id: "123456" site_id: "" # Example is "123456"
replybox: # getreplybox.com replybox: # See https://getreplybox.com
account_id: "123456" account_id: "" # Example is "123456"
utterances: # utteranc.es utterances: # See https://utteranc.es
github_repo: "example/foo" github_repo: "" # Example is "example/foo"
credit: credit:
data: data:
hide: false # Don't credit this project in a data attribute; default is false hide: false # Don't credit this project in a data attribute
link: link:
hide: false # Don't credit this project in the footer; default is false hide: false # Don't credit this project in the footer
header: header:
menu: menu:
breakpoint: "sm" # Bootstrap breakpoint at which to display all menu items; default is "sm" breakpoint: "sm" # Bootstrap breakpoint at which to display all menu items
style: "pills" # Menu item style; must be "links" or "pills"; default is "pills" style: "pills" # Must be "links" or "pills"
home: home:
blurb: "There's a new daddy in town." # Displayed below the greeting; default is "" blurb: "" # Displayed below the greeting
greeting: "You know best" # Displayed below the image; default is "" greeting: "" # Displayed below the image
image: image:
raw: false # Do not copy or process the file; default is false raw: false # Do not copy or process the file
stretch: false # Stretch the image fully horizontally if true; center the image otherwise; default is false stretch: false # Stretch the image fully horizontally if true; center the image otherwise
url: "me.jpg" # A page, site, or remote resource glob; default is "" url: "" # Local or remote resource glob
katex: katex:
autorender: autorender:
raw: false # Do not copy or process the file; default is false raw: false # Do not copy or process the file
script_integrity: "sha384-+VBxd3r6XgURycqtZ117nYw44OOcIax56Z4dCRWbxyPt0Koah1uHoK0o4+/RRE05" # File integrity hash script_integrity: "sha384-+VBxd3r6XgURycqtZ117nYw44OOcIax56Z4dCRWbxyPt0Koah1uHoK0o4+/RRE05" # Subresource integrity hash
script_src: "https://cdn.jsdelivr.net/npm/katex@0.16.3/dist/contrib/auto-render.min.js" # Local or remote file script_src: "https://cdn.jsdelivr.net/npm/katex@0.16.3/dist/contrib/auto-render.min.js" # Local or remote resource glob
script: script:
raw: false # Do not copy or process the file; default is false raw: false # Do not copy or process the file
script_integrity: "sha384-97gW6UIJxnlKemYavrqDHSX3SiygeOwIZhwyOKRfSaf0JWKRVj9hLASHgFTzT+0O" # File integrity hash script_integrity: "sha384-97gW6UIJxnlKemYavrqDHSX3SiygeOwIZhwyOKRfSaf0JWKRVj9hLASHgFTzT+0O" # Subresource integrity hash
script_src: "https://cdn.jsdelivr.net/npm/katex@0.16.3/dist/katex.min.js" # Local or remote file script_src: "https://cdn.jsdelivr.net/npm/katex@0.16.3/dist/katex.min.js" # Local or remote resource glob
style: style:
link_href: "https://cdn.jsdelivr.net/npm/katex@0.16.3/dist/katex.min.css" # Local or remote file link_href: "https://cdn.jsdelivr.net/npm/katex@0.16.3/dist/katex.min.css" # Local or remote resource glob
link_integrity: "sha384-Juol1FqnotbkyZUT5Z7gUPjQ9gzlwCENvUZTpQBAPxtusdwFLRy382PSDx5UUJ4/" # File integrity hash link_integrity: "sha384-Juol1FqnotbkyZUT5Z7gUPjQ9gzlwCENvUZTpQBAPxtusdwFLRy382PSDx5UUJ4/" # Subresource integrity hash
list: list:
authors: authors:
class: "mb-0 text-center text-secondary" # Default is "mb-0 text-center text-secondary" class: "mb-0 text-center text-secondary"
hide: false # Default is false hide: false
content: content:
show: false # Default is false show: false
date: date:
class: "mb-0 text-center text-secondary" # Default is "mb-0 text-center text-secondary" class: "mb-0 text-center text-secondary"
format: ":date_long" # Default is ":date_long" format: ":date_long" # Hugo date format
hide: false # Default is false hide: false
date_header: date_header:
class: "h5 text-center" # Month and year header class attribute class: "h5 text-center"
hide: false # Default is false hide: false
description: description:
class: "mb-0 text-center" # Default is "mb-0 text-center" class: "mb-0 text-center"
hide: false # Default is false hide: false
pages: pages:
hide: false # Default is false hide: false
reading_time: reading_time:
class: "mb-0 text-center text-secondary" # Default is "mb-0 text-center text-secondary" class: "mb-0 text-center text-secondary"
hide: false # Default is false hide: false
section: section:
class: "mb-3 w-100" # Default is "mb-3 w-100" class: "mb-3 w-100"
summary: summary:
class: "fst-italic mb-0 text-center" # Default is "fst-italic mb-0 text-center" class: "fst-italic mb-0 text-center"
hide: false # Default is false hide: false
terms: terms:
hide: false # Default is false hide: false
inner_class: "badge text-bg-secondary text-decoration-none" # Default is "badge text-bg-secondary text-decoration-none" inner_class: "badge text-bg-secondary text-decoration-none"
outer_class: "mb-0 text-center" # Default is "mb-0 text-center" outer_class: "mb-0 text-center"
title: title:
class: "mb-0 text-center" # Default is "mb-0 text-center" class: "mb-0 text-center"
hide: false # Default is false hide: false
main: main:
metadata: metadata:
authors: authors:
class: "text-center text-secondary" # Default is "text-center text-secondary" class: "text-center text-secondary"
hide: false # Default is false hide: false
date: date:
class: "text-center text-secondary" # Default is "text-center text-secondary" class: "text-center text-secondary"
format: ":date_long" # Default is ":date_long" format: ":date_long" # Hugo date format
hide: false # Default is false hide: false
lastmod: lastmod:
hide: false # Default is false hide: false
description: description:
class: "lead text-center" # Default is "lead text-center" class: "lead text-center"
hide: false # Default is false hide: false
git: git:
commit_url_prefix: "https://github.com/willfaught/paige/commit/" # Default is "" commit_url_prefix: "" # Example is "https://github.com/willfaught/paige/commit/"
max_width: "100ch" # Default is "" max_width: ""
reading_time: reading_time:
class: "text-center text-secondary" # Default is "text-center text-secondary" class: "text-center text-secondary"
hide: false # Default is false hide: false
section: section:
class: "paige-metadata w-100" # Default is "paige-metadata w-100" class: "paige-metadata w-100"
terms: terms:
hide: false # Default is false hide: false
inner_class: "badge text-bg-secondary text-decoration-none" # Default is "badge text-bg-secondary text-decoration-none" inner_class: "badge text-bg-secondary text-decoration-none"
outer_class: "text-center" # Default is "text-center" outer_class: "text-center"
title: title:
class: "display-5 fw-bold text-center" # Default is "display-5 fw-bold text-center" class: "display-5 fw-bold text-center"
hide: false # Default is false hide: false
table_of_contents: table_of_contents:
class: "border mb-3 pe-3 ps-3 pt-3 rounded" # Default is "border mb-3 pe-3 ps-3 pt-3 rounded" class: "border mb-3 pe-3 ps-3 pt-3 rounded"
hide: false # Default is false hide: false
max_width: "66ch" # Default is "" max_width: ""
content: content:
class: "mw-100 paige-content" # Default is "mw-100 paige-content" class: "mw-100 paige-content"
hide: false # Default is false hide: false
max_width: "66ch" # Default is "" max_width: ""
math: false # Enable math typesetting; default is false math: false # Math typesetting
rss: rss:
hide_page: false # Default is false hide_page: false
managing_editor: "Michael Bluth" # Default is "" managing_editor: ""
web_master: "Michael Bluth" # Default is "" web_master: ""
search: search:
hide_page: false # Default is false hide_page: false
social: social:
examplesite: examplesite:
bootstrap_icon: example-icon bootstrap_icon: "" # Example is "example-icon"
name: Example name: "" # Example is "Example"
url: https://example.com/username url: "" # Example is "https://example.com/username"
``` ```
The assigned values shown are the default values.
If you set `paige.credit.data.hide` or `paige.credit.link.hide`, please credit this project in a post to help others find it. If you set `paige.credit.data.hide` or `paige.credit.link.hide`, please credit this project in a post to help others find it.
Optional site parameters: Optional site parameters:
@ -356,10 +358,8 @@ Optional site parameters:
```yaml ```yaml
authors: authors:
michael_bluth: michael_bluth:
name: "Michael Bluth" name: ""
default: true # Credit this author in pages that have no authors parameter default: false # Credit this author in pages that have no authors parameter
george_bluth:
name: "George Bluth"
``` ```
Optional page parameters: Optional page parameters:

Write Preview
Loading…
Cancel
Save