Rockingcool
/
paige-hugo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
myFork
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '8219b9fe0c'
${ noResults }
paige-hugo/README.md

1134 lines
42 KiB
Markdown
Raw Blame History Unescape Escape

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Paige
Powerful, pliable pixel perfection.
An advanced Hugo theme.
[Try it out.](https://willfaught.com/paige)
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/willfaught/paige/raw/master/images/screenshot-dark.jpg">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/willfaught/paige/raw/master/images/screenshot.jpg">
<img alt="Screenshot" src="https://github.com/willfaught/paige/raw/master/images/screenshot.jpg">
</picture>
Paige is designed to put your content front and center,
avoiding the typical clutter.
The look is seamless and smooth,
scalable and readable,
portable and efficient.
The layout is minimal and responsive,
using verticality and white space to delineate and highlight each part of the page.
The implementation is flexible and extensible.
It’s a versatile canvas that serves most needs.
## Features
- Accessibility
- Atom feeds
- Authors
- Blog
- Bootstrap styles and icons
- Breadcrumbs
- Categories
- Code shortcode
- Customizable
- Dark color scheme
- Email shortcode
- Facebook sharing
- Figure shortcode
- Gallery shortcode
- Icon shortcode
- Image pixel densities
- Image shortcode
- Image size breakpoints
- Image thumbnails
- Internationalization
- Landing page
- Light color scheme
- Localizations
- Math typesetting
- Menu
- Minimal design
- Quote shortcode
- Responsive
- Right-to-left languages
- RSS feeds
- Safari and Firefox Reader View support
- Search
- Sections
- SEO
- Series
- Single column
- Table of contents
- Tab shortcode
- Tags
- Title links
- Twitter sharing
- Validated with [PageSpeed](https://pagespeed.web.dev/report?url=https%3A%2F%2Fwillfaught.com%2Fpaige%2F&form_factor=desktop) and [Validator](https://validator.w3.org/nu/?doc=https%3A%2F%2Fwillfaught.com%2Fpaige%2F)
- Vimeo shortcode
- YouTube shortcode
## Community
Get started by [starring](https://github.com/willfaught/paige/stargazers)
and [watching](https://github.com/willfaught/paige/watchers) the project.
If you find a problem or have a suggestion,
please share it by [creating an issue](https://github.com/willfaught/paige/issues/new).
If you have a fix or improvement,
please share it by [creating a pull request](https://github.com/willfaught/paige/compare).
If you make a customization or alteration,
please share it by [posting code or screenshots](https://github.com/willfaught/paige/discussions/8).
If you deploy a site,
please share it by [posting a link](https://github.com/willfaught/paige/discussions/12).
## Setup
1. Install [Hugo](https://gohugo.io/installation/) and [Dart Sass](https://github.com/sass/dart-sass):
For Homebrew on Mac:
```sh
$ brew install hugo sass/sass/sass
```
For Chocolatey on Windows:
```sh
$ choco install hugo-extended sass
```
For Snap on Linux:
```sh
$ sudo snap install hugo
```
Hugo must be the extended version, and at least version v0.141.0.
2. Create a site:
```sh
$ hugo new site yoursite
```
3. Create a post:
```sh
$ cd yoursite
$ hugo new yourpost.md
```
4. Configure your module:
```sh
$ cd yoursite
$ hugo mod init github.com/youraccount/yoursite
$ cat >>hugo.toml <<EOF
[markup.highlight]
noclasses = false
style = "github"
EOF
```
5. Configure the Paige module:
```sh
$ cd yoursite
$ hugo mod get github.com/willfaught/paige@latest
$ cat >>hugo.toml <<EOF
[[module.imports]]
path = "github.com/willfaught/paige"
EOF
```
6. Build and run the site for development:
```sh
$ cd yoursite
$ hugo server --buildDrafts
```
7. Build the site for production:
```sh
$ cd yoursite
$ hugo --environment production --minify
```
8. Update the Paige module:
```sh
$ cd yoursite
$ hugo mod get github.com/willfaught/paige@latest
```
Paige uses [Semantic Versioning](https://semver.org).
The current major version is 0.
From time to time, breaking changes are made.
When you update Paige, you must test your site.
See Hugo's [installation](https://gohugo.io/installation/),
[getting started](https://gohugo.io/getting-started/),
and [module](https://gohugo.io/hugo-modules/) guides for more information.
## Kickoff
By default, everything is enabled, which is likely not what you want.
See the [minimal look](#minimal-look) section for ideas of what to disable.
By default, the page body spans its entire container, which spans most of the window.
See the [narrow look](#narrow-look) and [narrow-and-wide look](#narrow-and-wide-look) sections
for ideas of how to customize the presentation.
The breadcrumb, collection, section, and page links are sufficient to browse any site,
so you can safely disable the menu.
However, for sites with only a couple handfuls of sections and pages at the root level,
and without nested sections,
the menu alone can be sufficient for all navigation.
See the [menu navigation only](#menu-navigation-only) section for how to do that.
To change the favicon, see the [override](#override) section.
To add analytics, put the code in `yoursite/layouts/partials/paige/site-last.html`.
See the [include](#include) section.
To add comments, put the code in `yoursite/layouts/partials/paige/page-body-last-page.html`.
See the [include](#include) section.
## Configure
### Parameters
There is a single parameter object with sensible defaults that can be overridden in site or page parameters:
```toml
[paige]
enable_math = false # Enables math typesetting for this page
exclude_feeds = false # Excludes this page from feeds
exclude_search = false # Excludes this page from search
style = "" # CSS included in a stylesheet for this page
[paige.alert]
message = "" # Markdown displayed before the page body for this page
type = "primary" # Bootstrap alert class for this page
[paige.feeds]
disable_link = false # Disables using the link parameter for the page URL
page_link = "⏎" # Link to the page with this text if the link parameter is set and disable_link is false
[paige.feeds.atom]
authors = []
# Example:
# [[paige.feeds.atom.authors]]
# email = "example@example.com"
# name = "John Doe"
# url = "https://github.com/account/project"
icon = "" # Example: "/icon.webp"
logo = "" # Example: "/logo.webp"
[paige.feeds.rss]
managing_editor = "" # Example: "example@example.com (John Doe)"
web_master = "" # Example: "example@example.com (John Doe)"
[paige.pages]
# Content
disable_authors = false
disable_collections = false
disable_date = false
disable_description = false
disable_edit = false
disable_history = false
disable_keywords = false
disable_next = false
disable_pages = false
disable_prev = false
disable_reading_time = false
disable_sections = false
disable_series = false
disable_title = false
disable_toc = false
disable_word_count = false
# Presentation
full_width = false # Whether the page body fills the page width
# Schema
base_schema = {} # JSON-LD schema that all page schemas override
# Example:
# [paige.pages.base_schema]
# isAccessibleForFree = true
# isFamilyFriendly = true
# [paige.pages.base_schema.publisher]
# "@type" = "Organization"
# name = "John Doe"
# url = "https://example.com"
disable_auto_schema = false # Disables the automatic JSON-LD schema generation
microdata = {} # Microdata non-property attributes (all except itemprop) for the web page
# Example:
# [paige.pages.microdata]
# itemid = "foo"
# itemref = "bar"
# itemscope = ""
# itemtype = "https://schema.org/Chapter
schemas = [] # JSON-LD schemas
# Example:
# [[paige.pages.schemas]]
# "@context" = "https://schema.org"
# "@type" = "Book"
# name = "My Book"
# url = "https://example.com"
[paige.site]
# Behavior
date_format = ":date_long" # Hugo date format
external_link_new_tab = false # Open external links in new tabs
# Content
disable_copyright = false
disable_credit = false
disable_description = false
disable_license = false
disable_title = false
# Navigation
disable_breadcrumbs = false
disable_menu = false
# Presentation
color = "#0d6efd" # Bootstrap primary color and theme color for Safari and Windows
color_scheme = "auto" # Must be "auto", "dark", or "light"
keyword_style = "text" # Must be "text" or "pills"
menu_style = "links" # Must be "links", "pills", "tabs", or "underline"
# Repository
edit_url = "" # Example: "https://github.com/account/project/edit/master/content/%s"
history_url = "" # Example: "https://github.com/account/project/commits/master/content/%s"
# Schema
base_schema = {} # JSON-LD schema that all site schemas override
# Example:
# [paige.site.base_schema]
# isAccessibleForFree = true
# isFamilyFriendly = true
# [paige.site.base_schema.publisher]
# "@type" = "Organization"
# name = "John Doe"
# url = "https://example.com"
schemas = [] # JSON-LD schemas
# Example:
# [[paige.site.schemas]]
# "@context" = "https://schema.org"
# "@type" = "Organization"
# name = "Acme"
# url = "https://example.com"
# Values
credit = '<a class="link-secondary text-decoration-none" href="https://github.com/willfaught/paige">Paige Theme</a>'
description = "" # Site description. Appears above the menu and below the site title. Used in feeds.
license = "" # Example: "CC BY 4.0 License"
[paige.subpages]
disable_authors = false
disable_date = false
disable_description = false
disable_keywords = false
disable_reading_time = false
disable_series = false
disable_summary = false
disable_title = false
disable_word_count = false
```
The parameter object is accessed in site parameters as `[params.paige]`, and in page parameters as `[paige]`.
Parameters for pages:
```toml
id = "" # Unique URI used in feeds. Defaults to a tag URN with the relative permalink.
link = "" # URL for an anchor around the title. Example: "https://youtu.be/dQw4w9WgXcQ".
```
Parameters for terms of the authors taxonomy:
```toml
[paige.author]
default = false # Whether to attribute pages without explicit authors to this author
email = "" # Used in feeds. Example: "example@example.com".
name = "" # Used in feeds. Example: "John Doe".
url = "" # Used in Atom feeds. Example: "https://example.com".
```
Parameters for menus:
```toml
[paige]
disabled = false
divider_above = false
divider_below = false
header_above = "" # Example: "My Header"
header_below = "" # Example: "My Other Header"
```
The assigned values shown are the default values unless otherwise specified.
### Menu
The menu can be configured using the `main` menu.
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.
If you intend for the menu to be sufficient for all navigation,
see [how to hide other navigation features](#menu-navigation-only).
### Taxonomies
Support for authors, categories, series, and tags taxonomies is built in.
A default author must be referenced in the authors parameter of at least one page.
To disable the rendering of the authors taxonomy, add this to `yoursite/hugo.toml`:
```toml
[[cascade]]
[cascade._target]
path = "{/authors,/authors/**}"
[cascade.build]
render = "never"
```
### SEO
The `author`, `description`, and `keywords` meta tags are generated from the page parameters.
The keywords are the page parameters `keywords`, `categories`, and `tags`.
A JSON-LD script is generated from the page parameters,
which can be disabled with `paige.pages.disable_auto_schema`.
Arbitrary schemas can be specified for the site with `paige.site.schemas`
or for pages with `paige.pages.schemas`, at the site or page level.
A base schema can be specified for site schemas with `paige.site.base_schema`,
and for page schemas with `paige.pages.base_schema`.
HTML microdata is generated from the page parameters
if the non-property attributes are specified in `paige.pages.microdata`.
## Layouts
### Cloud
The `paige/cloud` layout provides a link cloud for subpages.
Example configuration in `yoursite/content/tags/_index.md`:
```toml
layout = "paige/cloud"
```
### Search
The `paige/search` layout provides a search page.
Example configuration in `yoursite/hugo.toml`:
```toml
[outputs]
home = ["atom", "html", "paige-search", "rss"]
```
Example configuration in `yoursite/content/search.md`:
```toml
layout = "paige/search"
title = "Search"
```
## Shortcodes
### Code
The `paige/code` shortcode provides highlighted code.
Parameters:
<dl>
<dt><code>lang</code></dt>
<dd>Optional. Position 0. String. Chroma <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages">language code</a>. Default is <code>"plaintext"</code>.</dd>
<dt><code>options</code></dt>
<dd>Optional. String. Hugo <a href="https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode">highlight options</a>.</dd>
<dt><code>unescape</code></dt>
<dd>Optional. Boolean. Whether to reverse the HTML escaping in the body. Useful for when the request shortcode is used in the body.</dd>
</dl>
Body: Required. String. The code.
### Email
The `paige/email` shortcode hides e-mail addresses from robots.
Parameters:
<dl>
<dt><code>address</code></dt>
<dd>Required. Position 0. String. The e-mail address.</dd>
</dl>
Body: Required. String. Markdown. The content.
### Figure
The `paige/figure` shortcode provides a figure.
Parameters:
<dl>
<dt><code>caption</code></dt>
<dd>Optional. Position 0. String. Markdown. Descriptive text below the content.</dd>
<dt><code>float</code></dt>
<dd>Optional. String. Float to one side of its container. Must be <code>"start"</code> or <code>"end"</code>.</dd>
<dt><code>height</code></dt>
<dd>Optional. String. CSS value. Total height.</dd>
<dt><code>horizontal</code></dt>
<dd>Optional. String. Horizontal alignment. Must be <code>"start"</code>, <code>"center"</code>, or <code>"end"</code>. Default is <code>"center"</code>.</dd>
<dt><code>maxwidth</code></dt>
<dd>Optional. String. CSS value. Maximum total width.</dd>
<dt><code>number</code></dt>
<dd>Optional. Integer or string. Figure number. Displayed with the caption.</dd>
<dt><code>numbered</code></dt>
<dd>Optional. Boolean. Number the figure automatically. Displayed with the caption.</dd>
<dt><code>vertical</code></dt>
<dd>Optional. String. Vertical alignment. Must be <code>"start"</code>, <code>"center"</code>, or <code>"end"</code>. Default is <code>"center"</code>.</dd>
<dt><code>width</code></dt>
<dd>Optional. String. CSS value. Total width.</dd>
</dl>
Body: Required. String. Markdown. The content.
### Gallery
The `paige/gallery` shortcode provides an arrangement of images.
Parameters:
<dl>
<dt><code>align</code></dt>
<dd>Optional. String. Cross axis alignment. Must be <code>"baseline"</code>, <code>"center"</code>, <code>"end"</code>, <code>"start"</code>, or <code>"stretch"</code>.</dd>
<dt><code>breakpoints</code></dt>
<dd>Optional. Boolean. Whether to generate copies of the image sized to each Bootstrap breakpoint. Must not use with <code>densities</code>. Only applies to raster images.</dd>
<dt><code>class</code></dt>
<dd>Optional. String. Image class. Merged with implementation classes.</dd>
<dt><code>densities</code></dt>
<dd>Optional. String. Float numbers suffixed with an "x", delimited by spaces. The pixel densities of the image to generate. There must be at least two. The largest density matches the original image. Examples are <code>"1x 2x"</code>, <code>"1x 1.5x 2x 2.5x 3x"</code>, and <code>"0.5x 1.33x 6x 10x"</code>. Must not use with <code>breakpoints</code>. Only applies to raster images.</dd>
<dt><code>fetchpriority</code></dt>
<dd>Optional. String. Must be <code>"high"</code> or <code>"low"</code>.</dd>
<dt><code>height</code></dt>
<dd>Optional. String. CSS value. Image height.</dd>
<dt><code>images</code></dt>
<dd>Optional. Position 0. String. Page, site, or remote images glob. Default is all image page resources.</dd>
<dt><code>justify</code></dt>
<dd>Optional. String. Main axis space distribution. Must be <code>"around"</code>, <code>"between"</code>, <code>"center"</code>, <code>"end"</code>, <code>"evenly"</code>, or <code>"start"</code>.</dd>
<dt><code>linked</code></dt>
<dd>Optional. Boolean or string. Wraps the image in an anchor. If it is a string, it is Hugo image processing <a href="https://gohugo.io/content-management/image-processing/#image-processing-methods">methods</a> and <a href="https://gohugo.io/content-management/image-processing/#image-processing-options">options</a>, mixed together, for the linked image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is <code>default</code>, the <a href="https://gohugo.io/content-management/image-processing/#processing-options">default options</a> are used. If it is a Boolean, it is unprocessed. Must be a Boolean for vector images.</dd>
<dt><code>loading</code></dt>
<dd>Optional. String. Must be <code>"eager"</code> (default) or <code>"lazy"</code>.</dd>
<dt><code>maxheight</code></dt>
<dd>Optional. String. CSS value. Maximum image height.</dd>
<dt><code>maxwidth</code></dt>
<dd>Optional. String. CSS value. Maximum image width.</dd>
<dt><code>process</code></dt>
<dd>Optional. String. Hugo image processing <a href="https://gohugo.io/content-management/image-processing/#image-processing-methods">methods</a> and <a href="https://gohugo.io/content-management/image-processing/#image-processing-options">options</a>, mixed together, for the displayed image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is <code>"default"</code>, the <a href="https://gohugo.io/content-management/image-processing/#processing-options">default options</a> are used. Only applies to raster images.</dd>
<dt><code>style</code></dt>
<dd>Optional. String. CSS. Image style. Merged with implementation styles.</dd>
<dt><code>type</code></dt>
<dd>Optional. String. Type of layout. Must be <code>"grid"</code> or <code>"rows"</code> (default).</dd>
<dt><code>width</code></dt>
<dd>Optional. String. CSS value. Image width.</dd>
</dl>
Body: Optional. String. HTML. The images.
### Icon
The `paige/icon` shortcode provides a web font icon.
Parameters:
<dl>
<dt><code>class</code></dt>
<dd>Required. Position 0. String. Container class. Example: <code>"bi bi-github"</code>.</dd>
<dt><code>title</code></dt>
<dd>Optional. String. The screen reader description and anchor title. Example: <code>"GitHub"</code>.</dd>
<dt><code>url</code></dt>
<dd>Optional. String. URL. Example: <code>"https://github.com/account/project"</code>. E-mails in URLs with a <code>mailto:</code> scheme are protected from web crawlers.</dd>
</dl>
Body: None.
### Image
The `paige/image` shortcode provides an image.
Parameters:
<dl>
<dt><code>alt</code></dt>
<dd>Optional. String. Plain text. Image alt.</dd>
<dt><code>breakpoints</code></dt>
<dd>Optional. Boolean. Whether to generate copies of the image sized to each Bootstrap breakpoint. Must not use with <code>densities</code>, <code>sizes</code>, or <code>srcset</code>. Only applies to raster images.</dd>
<dt><code>class</code></dt>
<dd>Optional. String. Class attribute value.</dd>
<dt><code>densities</code></dt>
<dd>Optional. String. Float numbers suffixed with an "x", delimited by spaces. The pixel densities of the image to generate. There must be at least two. The largest density matches the original image. Examples are <code>"1x 2x"</code>, <code>"1x 1.5x 2x 2.5x 3x"</code>, and <code>"0.5x 1.33x 6x 10x"</code>. Must not use with <code>breakpoints</code>, <code>sizes</code>, or <code>srcset</code>. Only applies to raster images.</dd>
<dt><code>fetchpriority</code></dt>
<dd>Optional. String. Must be <code>"high"</code> or <code>"low"</code>.</dd>
<dt><code>height</code></dt>
<dd>Optional. String. CSS value. Image height.</dd>
<dt><code>link</code></dt>
<dd>Optional. String. URL. Image link. Must not use with <code>linked</code>.</dd>
<dt><code>linked</code></dt>
<dd>Optional. Boolean or string. Wraps the image in an anchor. If it is a string, it is Hugo image processing <a href="https://gohugo.io/content-management/image-processing/#image-processing-methods">methods</a> and <a href="https://gohugo.io/content-management/image-processing/#image-processing-options">options</a>, mixed together, for the linked image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is <code>"default"</code>, the <a href="https://gohugo.io/content-management/image-processing/#processing-options">default options</a> are used. If it is a Boolean, it is unprocessed. Must be a Boolean for vector images. Must not use with <code>link</code>.</dd>
<dt><code>loading</code></dt>
<dd>Optional. String. Must be <code>"eager"</code> (default) or <code>"lazy"</code>.</dd>
<dt><code>maxheight</code></dt>
<dd>Optional. String. CSS value. Image maximum height.</dd>
<dt><code>maxwidth</code></dt>
<dd>Optional. String. CSS value. Image maximum width.</dd>
<dt><code>process</code></dt>
<dd>Optional. String. Hugo image processing <a href="https://gohugo.io/content-management/image-processing/#image-processing-methods">methods</a> and <a href="https://gohugo.io/content-management/image-processing/#image-processing-options">options</a>, mixed together, for the displayed image. If no method is specified, resize is used. If no image dimensions are specified, the originals are used. If it is <code>"default"</code>, the <a href="https://gohugo.io/content-management/image-processing/#processing-options">default options</a> are used. Only applies to raster images.</dd>
<dt><code>sizes</code></dt>
<dd>Optional. String. Image <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes">sizes</a>. Must not use with <code>breakpoints</code> or <code>densities</code>.</dd>
<dt><code>src</code></dt>
<dd>Required. Position 0. String. URL. Image source.</dd>
<dt><code>srcset</code></dt>
<dd>Optional. String. Image <a href="https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/srcset">srcset</a>. Must not use with <code>breakpoints</code> or <code>densities</code>.</dd>
<dt><code>style</code></dt>
<dd>Optional. String. CSS. Image style. Merged with implementation styles.</dd>
<dt><code>title</code></dt>
<dd>Optional. String. Plain text. Image title.</dd>
<dt><code>width</code></dt>
<dd>Optional. String. CSS value. Image width.</dd>
</dl>
Body: None.
### Quote
The `paige/quote` shortcode provides a quotation.
Parameters:
<dl>
<dt><code>cite</code></dt>
<dd>Optional. String. Markdown. Citation.</dd>
</dl>
Body: Required. String. Markdown. The quotation.
### Request
The `paige/request` shortcode provides the content for a URL.
Parameters:
<dl>
<dt><code>method</code></dt>
<dd>Optional. String. HTTP method. Default is <code>"get"</code>.</dd>
<dt><code>url</code></dt>
<dd>Required. String. URL.</dd>
</dl>
Body: None.
### Tabs
The `paige/tabs` shortcode provides tab buttons and tab panes.
It must contain one `paige/tabs/buttons` shortcode, and then one `paige/tabs/panes` shortcode.
Parameters: None.
Body: Required. String. HTML. The tab buttons and tab panes.
The `paige/tabs/buttons` shortcode provides tab buttons.
It must contain one or more `paige/tabs/button` shortcodes.
Each `paige/tabs/button` shortcode corresponds to the `paige/tabs/pane` shortcode in the same position.
Parameters: None.
Body: Required. String. HTML. The tab buttons.
The `paige/tabs/button` shortcode provides a tab button.
Parameters: None.
Body: Required. String. Markdown. The tab button content.
The `paige/tabs/panes` shortcode provides tab panes.
It must contain one or more `paige/tabs/pane` shortcodes.
Each `paige/tabs/pane` shortcode corresponds to the `paige/tabs/button` shortcode in the same position.
Parameters: None.
Body: Required. String. HTML. The tab panes.
The `paige/tabs/pane` shortcode provides a tab pane.
Parameters: None.
Body: Required. String. Markdown. The tab pane content.
### Vimeo
The `paige/vimeo` shortcode provides a Vimeo video.
Parameters:
<dl>
<dt><code>autopause</code></dt>
<dd>Optional. Boolean. Enable playing more than one Vimeo video on the same page. Default is <code>true</code>.</dd>
<dt><code>autoplay</code></dt>
<dd>Optional. Boolean. Autoplay the video. Default is <code>false</code>.</dd>
<dt><code>background</code></dt>
<dd>Optional. Boolean. Autoplay the video. Hide the controls. Loop the video. Mute the video. Default is <code>false</code>.</dd>
<dt><code>byline</code></dt>
<dd>Optional. Boolean. Show the author. Default is configured per video.</dd>
<dt><code>color</code></dt>
<dd>Optional. String. Hex code. Control color. Default is <code>"00adef"</code>.</dd>
<dt><code>controls</code></dt>
<dd>Optional. Boolean. Show the controls. Default is <code>true</code>.</dd>
<dt><code>description</code></dt>
<dd>Optional. String. Plain text. Screen reader content. Default is <code>"Vimeo video"</code>.</dd>
<dt><code>dnt</code></dt>
<dd>Optional. Boolean. Do not track session data. Default is <code>false</code>.</dd>
<dt><code>fullscreen</code></dt>
<dd>Optional. Boolean. Enable full screen. Default is <code>true</code>.</dd>
<dt><code>height</code></dt>
<dd>Optional. String. CSS value. Video height.</dd>
<dt><code>keyboard</code></dt>
<dd>Optional. Boolean. Enable keyboard input. Default is <code>true</code>.</dd>
<dt><code>loop</code></dt>
<dd>Optional. Boolean. Loop the video. Default is <code>false</code>.</dd>
<dt><code>maxheight</code></dt>
<dd>Optional. String. CSS value. Video maximum height.</dd>
<dt><code>maxwidth</code></dt>
<dd>Optional. String. CSS value. Video maximum width.</dd>
<dt><code>muted</code></dt>
<dd>Optional. Boolean. Mute the video. Default is <code>false</code>.</dd>
<dt><code>pip</code></dt>
<dd>Optional. Boolean. Show the picture-in-picture control. Default is <code>false</code>.</dd>
<dt><code>playsinline</code></dt>
<dd>Optional. Boolean. Play inline instead of full screen on mobile devices. Default is <code>true</code>.</dd>
<dt><code>portrait</code></dt>
<dd>Optional. Boolean. Show the author's profile image. Default is configured per video.</dd>
<dt><code>quality</code></dt>
<dd>Optional. String. The resolution. Must be <code>"auto"</code>, <code>"240p"</code>, <code>"360p"</code>, <code>"540p"</code>, <code>"720p"</code>, <code>"1080p"</code>, <code>"2k"</code>, or <code>"4k"</code>. Default is <code>"auto"</code>.</dd>
<dt><code>speed</code></dt>
<dd>Optional. Boolean. Show the speed controls. Default is <code>false</code>.</dd>
<dt><code>texttrack</code></dt>
<dd>Optional. String. Language code and optionally a locale code (e.g. <code>"en"</code>, <code>"en-US"</code>). Use the corresponding subtitles. Default is <code>false</code>.</dd>
<dt><code>time</code></dt>
<dd>Optional. String. Duration (e.g. <code>"0m"</code>, <code>"1m2s"</code>). Start time. Default is <code>"0m"</code>.</dd>
<dt><code>title</code></dt>
<dd>Optional. Boolean. Show the title. Default is configured per video.</dd>
<dt><code>transparent</code></dt>
<dd>Optional. Boolean. Use a transparent background instead of a black one. Default is <code>true</code>.</dd>
<dt><code>video</code></dt>
<dd>Optional. Position 0. String. Video ID.</dd>
<dt><code>width</code></dt>
<dd>Optional. String. CSS value. Video width.</dd>
</dl>
Body: None.
See [Vimeo documentation](https://vimeo.zendesk.com/hc/en-us/articles/360001494447-Player-parameters-overview) for more detail.
### YouTube
The `paige/youtube` shortcode provides a YouTube video.
Parameters:
<dl>
<dt><code>autoplay</code></dt>
<dd>Optional. Boolean. Automatically play the video.</dd>
<dt><code>controls</code></dt>
<dd>Optional. Boolean. Show video controls. Default is <code>true</code>.</dd>
<dt><code>description</code></dt>
<dd>Optional. String. Plain text. Screen reader content. Default is <code>"YouTube video"</code>.</dd>
<dt><code>end</code></dt>
<dd>Optional. Integer. Elapsed seconds. Stop the video here.</dd>
<dt><code>fullscreen</code></dt>
<dd>Optional. Boolean. Enable full screen. Default is <code>true</code>.</dd>
<dt><code>height</code></dt>
<dd>Optional. String. CSS value. Video height.</dd>
<dt><code>list</code></dt>
<dd>Optional. String. Playlist ID.</dd>
<dt><code>loop</code></dt>
<dd>Optional. Boolean. Loop the video.</dd>
<dt><code>maxheight</code></dt>
<dd>Optional. String. CSS value. Video maximum height.</dd>
<dt><code>maxwidth</code></dt>
<dd>Optional. String. CSS value. Video maximum width.</dd>
<dt><code>mute</code></dt>
<dd>Optional. Boolean. Mute the video.</dd>
<dt><code>start</code></dt>
<dd>Optional. Integer. Elapsed seconds. Start the video here.</dd>
<dt><code>video</code></dt>
<dd>Optional. Position 0. String. Video ID.</dd>
<dt><code>width</code></dt>
<dd>Optional. String. CSS value. Video width.</dd>
</dl>
Body: None.
## Customize
### Include
Files can be included in many places in HTML.
| If this file exists in your site | It is included at |
| ------------------------------------------------| ---------------------------------|
| `layouts/partials/paige/body-first.html` | The beginning of the body |
| `layouts/partials/paige/body-last.html` | The ending of the body |
| `layouts/partials/paige/head-first.html` | The beginning of the head |
| `layouts/partials/paige/head-last.html` | The ending of the head |
| `layouts/partials/paige/page-body-first.html` | The beginning of the page body |
| `layouts/partials/paige/page-body-last.html` | The ending of the page body |
| `layouts/partials/paige/page-first.html` | The beginning of the page |
| `layouts/partials/paige/page-footer-first.html` | The beginning of the page footer |
| `layouts/partials/paige/page-footer-last.html` | The ending of the page footer |
| `layouts/partials/paige/page-header-first.html` | The beginning of the page header |
| `layouts/partials/paige/page-header-last.html` | The ending of the page header |
| `layouts/partials/paige/page-last.html` | The ending of the page |
| `layouts/partials/paige/site-first.html` | The beginning of the site |
| `layouts/partials/paige/site-footer-first.html` | The beginning of the site footer |
| `layouts/partials/paige/site-footer-last.html` | The ending of the site footer |
| `layouts/partials/paige/site-header-first.html` | The beginning of the site header |
| `layouts/partials/paige/site-header-last.html` | The ending of the site header |
| `layouts/partials/paige/site-last.html` | The ending of the site |
There are kind variants of include files that are included only when the file kind matches the page kind.
| If this file exists in your site | It is included when |
| -----------------------------------------------| ----------------------------|
| `layouts/partials/paige/[PLACE]-home.html` | The page kind is "home" |
| `layouts/partials/paige/[PLACE]-page.html` | The page kind is "page" |
| `layouts/partials/paige/[PLACE]-section.html` | The page kind is "section" |
| `layouts/partials/paige/[PLACE]-taxonomy.html` | The page kind is "taxonomy" |
| `layouts/partials/paige/[PLACE]-term.html` | The page kind is "term" |
Above, the place placeholder must be "body-first", "body-last", "head-first", etc.
Kind variants are included right after their counterpart non-kind variant.
The argument for the templates is the page.
### Override
Most code is in partial templates that the layout templates use.
Code can be added, changed, or removed easily by overriding the corresponding layout or partial template.
For example, `layouts/_default/list.html` and `layouts/_default/single.html` include `layouts/partial/paige/page.html`.
`layouts/partial/paige/page.html` includes `layouts/partial/paige/page-header.html`.
To change the page title for those layout templates, change `layouts/partial/paige/page-header.html`.
To change the page title for `layouts/_default/single.html` only,
replace the inclusion of `layouts/partial/paige/page.html` in `layouts/_default/single.html` with its content,
then in that, replace the inclusion of `layouts/partial/paige/page-header.html` with its content,
then in that, change the page title.
To change the favicon, override these files:
- `static/apple-touch-icon.png`
- `static/favicon-96x96.png`
- `static/favicon.ico`
- `static/favicon.svg`
- `static/web-app-manifest-192x192.png`
- `static/web-app-manifest-512x512.png`
You can generate these favicon files [here](https://realfavicongenerator.net).
To change the syntax highlighting styles, override these files [with your own](https://gohugo.io/content-management/syntax-highlighting/#generate-syntax-highlighter-css):
- `layouts/partials/paige/dark.css`
- `layouts/partials/paige/light.css`
### Extend
Use CSS selectors to extend the default styling.
Page identifiers:
<dl>
<dt><code>#paige-page-alert</code></dt>
<dd>The page alert.</dd>
<dt><code>#paige-page-authors</code></dt>
<dd>The page authors.</dd>
<dt><code>#paige-page-collections</code></dt>
<dd>The page collections.</dd>
<dt><code>#paige-page-collections-header</code></dt>
<dd>The page collections header.</dd>
<dt><code>#paige-page-content</code></dt>
<dd>The page content.</dd>
<dt><code>#paige-page-date</code></dt>
<dd>The page date.</dd>
<dt><code>#paige-page-description</code></dt>
<dd>The page description.</dd>
<dt><code>#paige-page-edit</code></dt>
<dd>The page edit link.</dd>
<dt><code>#paige-page-file</code></dt>
<dd>The container of the page edit and history links.</dd>
<dt><code>#paige-page-footer</code></dt>
<dd>The page footer that contains the page edit, history, next, and previous links.</dd>
<dt><code>#paige-page-header</code></dt>
<dd>The page header that contains the page metadata and table of contents.</dd>
<dt><code>#paige-page-history</code></dt>
<dd>The page history link.</dd>
<dt><code>#paige-page-keywords</code></dt>
<dd>The page keywords.</dd>
<dt><code>#paige-page-next</code></dt>
<dd>The page next link.</dd>
<dt><code>#paige-page-pages</code></dt>
<dd>The page pages.</dd>
<dt><code>#paige-page-pages-header</code></dt>
<dd>The page pages header.</dd>
<dt><code>#paige-page-pagination</code></dt>
<dd>The pagination of subpages.</dd>
<dt><code>#paige-page-prev</code></dt>
<dd>The page previous link.</dd>
<dt><code>#paige-page-reading-time</code></dt>
<dd>The page reading time.</dd>
<dt><code>#paige-page-sections</code></dt>
<dd>The page sections.</dd>
<dt><code>#paige-page-sections-header</code></dt>
<dd>The page sections header.</dd>
<dt><code>#paige-page-series</code></dt>
<dd>The page series.</dd>
<dt><code>#paige-page-siblings</code></dt>
<dd>The container of the page next and previous links.</dd>
<dt><code>#paige-page-title</code></dt>
<dd>The page title.</dd>
<dt><code>#paige-page-toc</code></dt>
<dd>The page table of contents.</dd>
<dt><code>#paige-page-word-count</code></dt>
<dd>The page word count.</dd>
</dl>
Site identifiers:
<dl>
<dt><code>#paige-site-breadcrumbs</code></dt>
<dd>The site breadcrumbs.</dd>
<dt><code>#paige-site-copyright</code></dt>
<dd>The site copyright.</dd>
<dt><code>#paige-site-credit</code></dt>
<dd>The site credit.</dd>
<dt><code>#paige-site-description</code></dt>
<dd>The site description.</dd>
<dt><code>#paige-site-footer</code></dt>
<dd>The site footer that contains the site copyright, license, and credit.</dd>
<dt><code>#paige-site-header</code></dt>
<dd>The site header that contains the site title, description, menu, and breadcrumbs.</dd>
<dt><code>#paige-site-license</code></dt>
<dd>The site license.</dd>
<dt><code>#paige-site-menu</code></dt>
<dd>The site menu.</dd>
<dt><code>#paige-site-title</code></dt>
<dd>The site title.</dd>
</dl>
Page classes:
<dl>
<dt><code>.paige-page-keyword-category</code></dt>
<dd>A page category keyword.</dd>
<dt><code>.paige-page-keyword-tag</code></dt>
<dd>A page tag keyword.</dd>
<dt><code>.paige-page-keywords</code></dt>
<dd>The page keywords.</dd>
</dl>
Subpage classes:
<dl>
<dt><code>.paige-page</code></dt>
<dd>A page.</dd>
<dt><code>.paige-page-authors</code></dt>
<dd>The page authors.</dd>
<dt><code>.paige-page-date</code></dt>
<dd>The page date.</dd>
<dt><code>.paige-page-description</code></dt>
<dd>The page description.</dd>
<dt><code>.paige-page-reading-time</code></dt>
<dd>The page reading time.</dd>
<dt><code>.paige-page-series</code></dt>
<dd>The page series.</dd>
<dt><code>.paige-page-summary</code></dt>
<dd>The page summary.</dd>
<dt><code>.paige-page-title</code></dt>
<dd>The page title.</dd>
<dt><code>.paige-page-word-count</code></dt>
<dd>The page word count.</dd>
</dl>
Page kind classes:
<dl>
<dt><code>.paige-kind-home</code></dt>
<dd>The container of pages with kind "home".</dd>
<dt><code>.paige-kind-section</code></dt>
<dd>The container of pages with kind "section".</dd>
<dt><code>.paige-kind-page</code></dt>
<dd>The container of pages with kind "page".</dd>
<dt><code>.paige-kind-taxonomy</code></dt>
<dd>The container of pages with kind "taxonomy".</dd>
<dt><code>.paige-kind-term</code></dt>
<dd>The container of pages with kind "term".</dd>
</dl>
Page status classes:
<dl>
<dt><code>.paige-status-draft</code></dt>
<dd>The container of draft pages.</dd>
<dt><code>.paige-status-expired</code></dt>
<dd>The container of expired pages.</dd>
<dt><code>.paige-status-future</code></dt>
<dd>The container of future pages.</dd>
<dt><code>.paige-status-modified</code></dt>
<dd>The container of modified pages.</dd>
<dt><code>.paige-status-published</code></dt>
<dd>The container of published pages.</dd>
<dt><code>.paige-status-unpublished</code></dt>
<dd>The container of unpublished pages.</dd>
</dl>
Shortcode classes:
<dl>
<dt><code>.paige-shortcode-code</code></dt>
<dd>The container of <code>paige/code</code> shortcodes.</dd>
<dt><code>.paige-shortcode-email</code></dt>
<dd>The container of <code>paige/email</code> shortcodes.</dd>
<dt><code>.paige-shortcode-figure</code></dt>
<dd>The container of <code>paige/figure</code> shortcodes.</dd>
<dt><code>.paige-shortcode-gallery</code></dt>
<dd>The container of <code>paige/gallery</code> shortcodes.</dd>
<dt><code>.paige-shortcode-icon</code></dt>
<dd>The container of <code>paige/icon</code> shortcodes.</dd>
<dt><code>.paige-shortcode-image</code></dt>
<dd>The container of <code>paige/image</code> shortcodes.</dd>
<dt><code>.paige-shortcode-quote</code></dt>
<dd>The container of <code>paige/quote</code> shortcodes.</dd>
<dt><code>.paige-shortcode-vimeo</code></dt>
<dd>The container of <code>paige/vimeo</code> shortcodes.</dd>
<dt><code>.paige-shortcode-youtube</code></dt>
<dd>The container of <code>paige/youtube</code> shortcodes.</dd>
</dl>
### Minimal look
By default, everything is shown.
If you want a more minimal look, try the following parameter values:
```toml
[paige.pages]
disable_authors = true
disable_date = true
disable_keywords = true
disable_next = true
disable_prev = true
disable_reading_time = true
disable_series = true
disable_toc = true
disable_word_count = true
[paige.subpages]
disable_authors = true
disable_date = true
disable_keywords = true
disable_reading_time = true
disable_series = true
disable_summary = true
disable_word_count = true
```
### Narrow look
By default, the content expands to fill the whole window.
This can result in very long lines, depending on the window width.
To use [the recommended line length of 66 characters](https://en.wikipedia.org/wiki/Line_length#Printed_text) (40rem),
try the following in `yoursite/hugo.toml`:
```toml
[params.paige]
style = """
#paige-page-content,
#paige-page-pages > * { margin-left: auto; margin-right: auto; max-width: 40rem; }
"""
```
### Narrow-and-wide look
By default, the content expands to fill the whole window.
This can result in very long lines, depending on the window width.
To use [the recommended line length of 66 characters](https://en.wikipedia.org/wiki/Line_length#Printed_text) (40rem)
for all content except media,
try the following in `yoursite/hugo.toml`:
```toml
[params.paige]
style = """
#paige-page-content,
#paige-page-pages > * { margin-left: auto; margin-right: auto; max-width: 40rem; }
#paige-page-content > img,
#paige-page-content > .paige-shortcode-image,
#paige-page-content > .paige-shortcode-vimeo,
#paige-page-content > .paige-shortcode-youtube { max-width: 100%; }
"""
```
### Menu navigation only
If you configure a menu, and intend for it to be sufficient for all navigation,
you should hide the breadcrumbs on every page,
and hide the collection, section, and page lists on the home page if you use the default home page layout.
To hide the breadcrumbs on every page,
try the following in `yoursite/hugo.toml`:
```toml
[params.paige.site]
disable_breadcrumbs = true
```
To hide the collection, section, and page lists on the home page,
try the following in `yoursite/content/_index.md`:
```toml
[params.paige.pages]
disable_collections = true
disable_pages = true
disable_sections = true
```
## Credits
- Photos by [Lanty](https://unsplash.com/@photos_by_lanty)
- Photo by [Sergey Pesterev](https://unsplash.com/photos/JV78PVf3gGI)
## Project
Copyright 2022 [Will Faught](https://willfaught.com).
Licensed under the [EUPL](https://spdx.org/licenses/EUPL-1.2.html).
Hosted at https://github.com/willfaught/paige.
Reference in New Issue View Git Blame Copy Permalink