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

Organize, format subpage, page, site config doc

Browse Source
This commit is contained in:
Will Faught
2025-02-08 00:17:16 -08:00
parent 98a59142e3
commit 9ca37cbbcd
1 changed files with 29 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@@ -210,38 +210,46 @@ logo = "" # Example: "/logo.webp"
managing_editor = "" # Example: "example@example.com (John Doe)" managing_editor = "" # Example: "example@example.com (John Doe)"
web_master = "" # Example: "example@example.com (John Doe)" web_master = "" # Example: "example@example.com (John Doe)"
[paige.subpage] [paige.subpage] # Subpages
# Front matter values
disable_authors = false disable_authors = false
disable_collections = false
disable_date = false disable_date = false
disable_description = false disable_description = false
disable_keywords = false disable_keywords = false
disable_pages = false
disable_reading_time = false disable_reading_time = false
disable_sections = false
disable_series = false disable_series = false
disable_summary = false
disable_title = false disable_title = false
[paige.page] # Other values
disable_summary = false
# Kinds
disable_collections = false
disable_pages = false
disable_sections = false
[paige.page] # Pages
# Front matter values
disable_authors = false disable_authors = false
disable_auto_schema = false # Disable the automatic SEO JSON-LD schema generation
disable_date = false disable_date = false
disable_description = false disable_description = false
disable_keywords = false
disable_reading_time = false
disable_series = false
disable_title = false
# Other values
disable_edit = false disable_edit = false
disable_history = false disable_history = false
disable_keywords = false
disable_next = false disable_next = false
disable_prev = false disable_prev = false
disable_reading_time = false
disable_series = false
disable_title = false
disable_toc = false disable_toc = false
# paige.page.base_schema specifies the JSON-LD schema that all page schemas override. # Schema
# base_schema = {} # JSON-LD schema that all page schemas override
# Example: # Example:
#
# [paige.page.base_schema] # [paige.page.base_schema]
# isAccessibleForFree = true # isAccessibleForFree = true
# isFamilyFriendly = true # isFamilyFriendly = true
@@ -249,35 +257,26 @@ disable_toc = false
# "@type" = "Organization" # "@type" = "Organization"
# name = "John Doe" # name = "John Doe"
# url = "https://example.com" # url = "https://example.com"
base_schema = {} disable_auto_schema = false # Disables the automatic JSON-LD schema generation
microdata = {} # Microdata non-property attributes (all except itemprop) for the web page
# paige.page.microdata specifies the SEO microdata non-property attributes (all except itemprop) for the web page.
#
# Example: # Example:
#
# [paige.page.microdata] # [paige.page.microdata]
# itemid = "123" # itemid = "123"
# itemref = "foo" # itemref = "foo"
# itemscope = "" # itemscope = ""
# itemtype = "https://schema.org/Chapter # itemtype = "https://schema.org/Chapter
microdata = {} schemas = [] # Page JSON-LD schemas
# paige.page.schemas is the page JSON-LD schemas.
#
# Examples: # Examples:
#
# [paige.page.schemas] # [paige.page.schemas]
# "@context" = "https://schema.org" # "@context" = "https://schema.org"
# "@type" = "Book" # "@type" = "Book"
# name = "My Book" # name = "My Book"
# url = "https://example.com" # url = "https://example.com"
schemas = []
[paige.site] [paige.site] # Site
# paige.site.base_schema specifies the JSON-LD schema that all site schemas override.
# base_schema = {} # JSON-LD schema that all site schemas override
# Example: # Example:
#
# [paige.site.base_schema] # [paige.site.base_schema]
# isAccessibleForFree = true # isAccessibleForFree = true
# isFamilyFriendly = true # isFamilyFriendly = true
@@ -285,8 +284,6 @@ schemas = []
# "@type" = "Organization" # "@type" = "Organization"
# name = "John Doe" # name = "John Doe"
# url = "https://example.com" # url = "https://example.com"
base_schema = {}
disable_breadcrumbs = false disable_breadcrumbs = false
disable_copyright = false disable_copyright = false
disable_credit = false disable_credit = false
@@ -294,17 +291,13 @@ disable_description = false
disable_license = false disable_license = false
disable_menu = false disable_menu = false
disable_title = false disable_title = false
schemas = [] # Site JSON-LD schemas
# paige.site.schemas is the site JSON-LD schemas.
#
# Examples: # Examples:
#
# [paige.site.schemas] # [paige.site.schemas]
# "@context" = "https://schema.org" # "@context" = "https://schema.org"
# "@type" = "Organization" # "@type" = "Organization"
# name = "Acme" # name = "Acme"
# url = "https://example.com" # url = "https://example.com"
schemas = []
``` ```
The parameter object is accessed in site parameters as `[params.paige]`, and in page parameters as `[paige]`. The parameter object is accessed in site parameters as `[params.paige]`, and in page parameters as `[paige]`.