Convert YAML to TOML in readme

master
Will Faught 2 years ago
parent 38aa8abfc1
commit f5994891ed

@ -163,105 +163,125 @@ See [Hugo's quick start guide](https://gohugo.io/getting-started/quick-start/) f
There is a single parameter object with sensible defaults that can be overridden in site or page parameters: There is a single parameter object with sensible defaults that can be overridden in site or page parameters:
```yaml ```toml
paige: [paige]
analytics: color = "#0d6efd" # Bootstrap primary color; theme color for Safari and Windows
beam: # See https://beamanalytics.io math = false # Enable math typesetting
token: "" style = "" # CSS included at the end of the stylesheet, before style-last.css
chartbeat: # See https://chartbeat.com
account_id: "" [paige.analytics]
domain: "" disabled = false # Disable all analytics
disabled: false # Disable all analytics
clarity: # See https://clarity.microsoft.com [paige.analytics.chartbeat] # See https://chartbeat.com
account_id: "" account_id = ""
clicky: # See https://clicky.com domain = ""
account_id: ""
counter: # See https://counter.dev [paige.analytics.clicky] # See https://clicky.com
account_id: "" account_id = ""
utc_offset: "" # Local UTC offset; examples are "-7", "0", "7"
fathom: # See https://usefathom.com [paige.analytics.fathom] # See https://usefathom.com
account_id: "" account_id = ""
finteza: # See https://finteza.com
account_id: "" [paige.analytics.finteza] # See https://finteza.com
script_url: "" account_id = ""
hotjar: # See https://hotjar.com script_url = ""
account_id: ""
matomo: # See https://matomo.org [paige.analytics.hotjar] # See https://hotjar.com
account_id: "" account_id = ""
host_url: ""
mixpanel: # See https://mixpanel.com [paige.analytics.matomo] # See https://matomo.org
token: "" account_id = ""
pirsch: # See https://pirsch.io host_url = ""
identification_code: ""
plausible: # See https://plausible.io [paige.analytics.mixpanel] # See https://mixpanel.com
account_id: "" token = ""
woopra: # See https://woopra.com
domain: "" [paige.analytics.plausible] # See https://plausible.io
yandex: # See https://metrica.yandex.com account_id = ""
account_id: ""
color: "#0d6efd" # Bootstrap primary color; theme color for Safari and Windows [paige.analytics.woopra] # See https://woopra.com
comments: domain = ""
cactus: # See https://cactus.chat
account_id: "" [paige.analytics.yandex] # See https://metrica.yandex.com
commento: # See https://commento.io account_id = ""
script_url: ""
disabled: false # Disable all comments [paige.comments]
hyvor: # See https://hyvor.com disabled = false # Disable all comments
account_id: ""
intensedebate: # See https://intensedebate.com [paige.comments.cactus] # See https://cactus.chat
account_id: "" account_id = ""
isso: # See https://isso-comments.de
script_url: "" [paige.comments.commento] # See https://commento.io
remark42: # See https://remark42.com script_url = ""
host_url: ""
site_id: "" [paige.comments.hyvor] # See https://hyvor.com
replybox: # See https://getreplybox.com account_id = ""
account_id: ""
utterances: # See https://utteranc.es [paige.comments.intensedebate] # See https://intensedebate.com
github_repo: "" account_id = ""
date:
format: ":date_long" # Hugo date format [paige.comments.isso] # See https://isso-comments.de
source: "published" # Displayed date in single pages; must be "published" or "modified" script_url = ""
git:
commit_url: "" # Example is "https://github.com/willfaught/paige/commit/%s" [paige.comments.remark42] # See https://remark42.com
math: false # Enable math typesetting host_url = ""
menu: site_id = ""
breakpoint: "sm" # Bootstrap breakpoint at which to display all menu items
style: "pills" # Must be "links", "pills", "tabs", or "underline" [paige.comments.replybox] # See https://getreplybox.com
rss: account_id = ""
hide_page: false
managing_editor: "" [paige.comments.utterances] # See https://utteranc.es
web_master: "" github_repo = ""
search:
hide_page: false [paige.date]
style: "" # CSS included at the end of the stylesheet, before style-last.css format = ":date_long" # Hugo date format
source = "published" # Displayed date in single pages; must be "published" or "modified"
[paige.git]
commit_url = "" # Example is "https://github.com/willfaught/paige/commit/%s"
[paige.menu]
breakpoint = "sm" # Bootstrap breakpoint at which to display all menu items
style = "pills" # Must be "links", "pills", "tabs", or "underline"
[paige.rss]
hide_page = false
managing_editor = ""
web_master = ""
[paige.search]
hide_page = false
``` ```
The assigned values shown are the default values. The assigned values shown are the default values.
Optional site parameters: Optional site parameters:
```yaml ```toml
authors: [authors.will-faught]
will-faught: name = "Will Faught"
name: "Will Faught" default = false # Credit this author in pages that have no authors parameter
default: false # Credit this author in pages that have no authors parameter
``` ```
Optional page parameters: Optional page parameters:
```yaml ```toml
authors: authors = ["will-faught"] # Credit the corresponding author in the site parameters
- "will-faught" # Credit the corresponding author in the site parameters link = "https://youtu.be/dQw4w9WgXcQ" # The reference for an anchor around the title
- author: "will-faught" # Credit the corresponding author in the site parameters
- name: "Will Faught" # Credit this author [[authors]]
link: "https://youtu.be/dQw4w9WgXcQ" # The reference for an anchor around the title author = "will-faught" # Credit the corresponding author in the site parameters
paige:
alert: "Alert!" # Markdown displayed before the page body (defaults to primary alert type) [[authors]]
alert: name = "Will Faught" # Credit this author
message: "Alert!" # Markdown displayed before the page body
type: "primary" # Bootstrap alert type [paige]
pin: true # Display this page before the rest alert = "Alert!" # Markdown displayed before the page body (defaults to primary alert type)
pin = true # Display this page before the rest
[paige.alert]
message = "Alert!" # Markdown displayed before the page body
type = "primary" # Bootstrap alert type
``` ```
## Features ## Features
@ -270,30 +290,35 @@ An optional menu can be configured.
The active menu item has a URL that is a prefix of the path of the current page. The active menu item has a URL that is a prefix of the path of the current page.
A menu item with the URL `/` only matches a `/` path. A menu item with the URL `/` only matches a `/` path.
Example `config.yaml`: Example `config.toml`:
```yaml ```toml
languages: [languages.en]
en: weight = 10
menu:
main: [[languages.en.menu.main]]
- identifier: "home" identifier = "home"
name: "Home" name = "Home"
url: "/" url = "/"
weight: 10 weight = 10
- identifier: "blog"
name: "Blog" [[languages.en.menu.main]]
url: "/blog/" identifier = "blog"
weight: 20 name = "Blog"
- identifier: "tags" url = "/blog/"
name: "Tags" weight = 20
url: "/tags/"
weight: 30 [[languages.en.menu.main]]
- identifier: "search" identifier = "tags"
name: "Search" name = "Tags"
url: "/search/" url = "/tags/"
weight: 40 weight = 30
weight: 10
[[languages.en.menu.main]]
identifier = "search"
name = "Search"
url = "/search/"
weight = 40
``` ```
## Layouts ## Layouts
@ -304,26 +329,26 @@ The `paige/cloud` layout provides a link cloud for sub-pages.
Example `content/tags/_index.md`: Example `content/tags/_index.md`:
```yaml ```toml
layout: "paige/cloud" layout = "paige/cloud"
``` ```
### Search ### Search
The `paige/search` layout provides a search page. The `paige/search` layout provides a search page.
Example `config.yaml`: Example `config.toml`:
```yaml ```toml
outputs: [outputs]
home: ["html", "json", "rss"] home = ["html", "json", "rss"]
``` ```
Example `content/search.md`: Example `content/search.md`:
```yaml ```toml
layout: "paige/search" layout = "paige/search"
title: "Search" title = "Search"
``` ```
## Shortcodes ## Shortcodes

Loading…
Cancel
Save