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.
1024 lines
32 KiB
Markdown
1024 lines
32 KiB
Markdown
# 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" style="margin-bottom: 8px">
|
|
</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 focus and delineate parts of the page.
|
|
The implementation is flexible and extensible.
|
|
It's a versatile canvas that serves most web needs.
|
|
|
|
## Features
|
|
|
|
- Accessibility
|
|
- Analytics
|
|
- Authors
|
|
- Automatic switching between light and dark color schemes
|
|
- Blog
|
|
- Bootstrap
|
|
- Categories
|
|
- Code shortcode
|
|
- Comments
|
|
- Customizable
|
|
- Dark color scheme
|
|
- E-mail protection
|
|
- Facebook sharing
|
|
- Figure shortcode
|
|
- Gallery shortcode
|
|
- Header links
|
|
- Icon shortcode
|
|
- Image shortcode
|
|
- Landing page
|
|
- Languages
|
|
- Light color scheme
|
|
- Math typesetting
|
|
- Menu
|
|
- Minimal design
|
|
- Quote shortcode
|
|
- RSS with full content
|
|
- Responsive
|
|
- Right-to-left languages
|
|
- SEO
|
|
- Safari and Firefox Reader View support
|
|
- Search
|
|
- Sections
|
|
- Series
|
|
- Single column
|
|
- Social links
|
|
- Table of contents
|
|
- Tags
|
|
- 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/) (the extended version, and at least 0.111.3).
|
|
|
|
For Homebrew on Mac:
|
|
|
|
```sh
|
|
$ brew install hugo
|
|
```
|
|
|
|
For Chocolatey on Windows:
|
|
|
|
```sh
|
|
$ choco install hugo-extended
|
|
```
|
|
|
|
For Snap on Linux:
|
|
|
|
```sh
|
|
$ sudo snap install hugo
|
|
```
|
|
|
|
2. [Install Embedded Dart Sass](https://github.com/sass/dart-sass-embedded/releases).
|
|
|
|
For Homebrew on Mac:
|
|
|
|
```sh
|
|
$ brew install sass/sass/dart-sass-embedded
|
|
```
|
|
|
|
For Chocolatey on Windows:
|
|
|
|
```sh
|
|
$ choco install dart-sass-embedded
|
|
```
|
|
|
|
For Snap on Linux:
|
|
|
|
```sh
|
|
$ sudo snap install dart-sass-embedded
|
|
```
|
|
|
|
3. Create a site:
|
|
|
|
```sh
|
|
$ hugo new site yourproject
|
|
```
|
|
|
|
4. Create a post:
|
|
|
|
```sh
|
|
$ cd yourproject
|
|
$ hugo new yourpost.md
|
|
```
|
|
|
|
5. Install the Paige module:
|
|
|
|
```sh
|
|
$ cd yourproject
|
|
$ hugo mod init github.com/youraccount/yourproject
|
|
$ hugo mod get github.com/willfaught/paige
|
|
```
|
|
|
|
6. Import the Paige module:
|
|
|
|
```sh
|
|
$ cd yourproject
|
|
$ cat >>config.toml <<EOF
|
|
[[module.imports]]
|
|
path = "github.com/willfaught/paige"
|
|
EOF
|
|
```
|
|
|
|
7. Build and run the site:
|
|
|
|
```sh
|
|
$ cd yourproject
|
|
$ hugo server -D
|
|
```
|
|
|
|
See [Hugo's quick start guide](https://gohugo.io/getting-started/quick-start/) for more information.
|
|
|
|
## Configure
|
|
|
|
There is a single parameter object with sensible defaults that can be overridden in site or page parameters:
|
|
|
|
```toml
|
|
[paige]
|
|
color = "#0d6efd" # Bootstrap primary color and theme color for Safari and Windows
|
|
math = false # Enable math typesetting
|
|
style = "" # CSS included at the end of the stylesheet, before style-last.css
|
|
|
|
[paige.analytics]
|
|
disable = false # Disable all analytics
|
|
|
|
[paige.analytics.chartbeat] # See https://chartbeat.com
|
|
account_id = ""
|
|
domain = ""
|
|
|
|
[paige.analytics.clicky] # See https://clicky.com
|
|
account_id = ""
|
|
|
|
[paige.analytics.fathom] # See https://usefathom.com
|
|
account_id = ""
|
|
|
|
[paige.analytics.finteza] # See https://finteza.com
|
|
account_id = ""
|
|
script_url = ""
|
|
|
|
[paige.analytics.hotjar] # See https://hotjar.com
|
|
account_id = ""
|
|
|
|
[paige.analytics.matomo] # See https://matomo.org
|
|
account_id = ""
|
|
host_url = ""
|
|
|
|
[paige.analytics.mixpanel] # See https://mixpanel.com
|
|
token = ""
|
|
|
|
[paige.analytics.plausible] # See https://plausible.io
|
|
account_id = ""
|
|
|
|
[paige.analytics.woopra] # See https://woopra.com
|
|
domain = ""
|
|
|
|
[paige.analytics.yandex] # See https://metrica.yandex.com
|
|
account_id = ""
|
|
|
|
[paige.comments]
|
|
disable = false # Disable all comments
|
|
|
|
[paige.comments.cactus] # See https://cactus.chat
|
|
account_id = ""
|
|
|
|
[paige.comments.commento] # See https://commento.io
|
|
script_url = ""
|
|
|
|
[paige.comments.hyvor] # See https://hyvor.com
|
|
account_id = ""
|
|
|
|
[paige.comments.intensedebate] # See https://intensedebate.com
|
|
account_id = ""
|
|
|
|
[paige.comments.isso] # See https://isso-comments.de
|
|
script_url = ""
|
|
|
|
[paige.comments.remark42] # See https://remark42.com
|
|
host_url = ""
|
|
site_id = ""
|
|
|
|
[paige.comments.replybox] # See https://getreplybox.com
|
|
account_id = ""
|
|
|
|
[paige.comments.utterances] # See https://utteranc.es
|
|
github_repo = ""
|
|
|
|
[paige.date]
|
|
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.
|
|
|
|
Optional site parameters:
|
|
|
|
```toml
|
|
[authors.will-faught]
|
|
name = "Will Faught"
|
|
default = false # Credit this author in pages that have no authors parameter
|
|
```
|
|
|
|
Optional page parameters:
|
|
|
|
```toml
|
|
authors = ["will-faught"] # Credit the corresponding author in the site parameters
|
|
link = "https://youtu.be/dQw4w9WgXcQ" # The reference for an anchor around the title
|
|
|
|
[[authors]]
|
|
author = "will-faught" # Credit the corresponding author in the site parameters
|
|
|
|
[[authors]]
|
|
name = "Will Faught" # Credit this author
|
|
|
|
[paige]
|
|
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
|
|
|
|
An optional menu can be configured.
|
|
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.
|
|
|
|
Example configuration in `yoursite/config.toml`:
|
|
|
|
```toml
|
|
[languages.en]
|
|
weight = 10
|
|
|
|
[[languages.en.menu.main]]
|
|
identifier = "home"
|
|
name = "Home"
|
|
url = "/"
|
|
weight = 10
|
|
|
|
[[languages.en.menu.main]]
|
|
identifier = "blog"
|
|
name = "Blog"
|
|
url = "/blog/"
|
|
weight = 20
|
|
|
|
[[languages.en.menu.main]]
|
|
identifier = "tags"
|
|
name = "Tags"
|
|
url = "/tags/"
|
|
weight = 30
|
|
|
|
[[languages.en.menu.main]]
|
|
identifier = "search"
|
|
name = "Search"
|
|
url = "/search/"
|
|
weight = 40
|
|
```
|
|
|
|
## Layouts
|
|
|
|
### Cloud
|
|
|
|
The `paige/cloud` layout provides a link cloud for sub-pages.
|
|
|
|
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/config.toml`:
|
|
|
|
```toml
|
|
[outputs]
|
|
home = ["html", "json", "rss"]
|
|
```
|
|
|
|
Example configuration in `yoursite/content/search.md`:
|
|
|
|
```toml
|
|
layout = "paige/search"
|
|
title = "Search"
|
|
```
|
|
|
|
## Shortcodes
|
|
|
|
### Code
|
|
|
|
The `paige/code` shortcode provides a figure with code.
|
|
|
|
```
|
|
{{< paige/code
|
|
lang=""
|
|
options="" >}}
|
|
|
|
{{< /paige/code >}}
|
|
```
|
|
|
|
Inner content: Required. String. The code.
|
|
|
|
Parameters:
|
|
|
|
<dl>
|
|
<dt><code>lang</code></dt>
|
|
<dd>Optional. Position 0. String. Chroma language code. Defaults to <code>plaintext</code>. See the <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages">codes</a>.</dd>
|
|
<dt><code>options</code></dt>
|
|
<dd>Optional. String. Hugo highlight options. See the <a href="https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode">options</a>.</dd>
|
|
</dl>
|
|
|
|
### Figure
|
|
|
|
The `paige/figure` shortcode provides a figure with content.
|
|
|
|
```
|
|
{{< paige/figure
|
|
caption=""
|
|
float=""
|
|
height=""
|
|
horizontal=""
|
|
maxwidth=""
|
|
number=0
|
|
numbered=false
|
|
vertical=""
|
|
width="" >}}
|
|
|
|
{{< /paige/figure >}}
|
|
```
|
|
|
|
Inner content: Required. String. Markdown. The content.
|
|
|
|
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>
|
|
|
|
### Gallery
|
|
|
|
The `paige/gallery` shortcode provides a figure with a collection of images.
|
|
|
|
```
|
|
{{< paige/gallery
|
|
align=""
|
|
format=""
|
|
height=""
|
|
images=""
|
|
justify=""
|
|
maxheight=""
|
|
maxwidth=""
|
|
method=""
|
|
options=""
|
|
type=""
|
|
width="" >}}
|
|
|
|
{{< /paige/gallery >}}
|
|
```
|
|
|
|
Inner content: Optional. String. HTML.
|
|
|
|
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>format</code></dt>
|
|
<dd>Optional. String. Image format. Must be <code>bmp</code>, <code>gif</code>, <code>jpg</code>, <code>png</code>, <code>tiff</code>, or <code>webp</code>. Must not be used with <code>method</code> or <code>options</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>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>method</code></dt>
|
|
<dd>Optional. String. Hugo image processing method. Must be <code>crop</code>, <code>fill</code>, <code>fit</code>, or <code>resize</code>. Default is <code>resize</code>. See the <a href="https://gohugo.io/content-management/image-processing/#image-processing-methods">methods</a>.</dd>
|
|
<dt><code>options</code></dt>
|
|
<dd>Optional. String. Hugo image processing options. Default is <code>550x webp picture Lanczos</code>. See the <a href="https://gohugo.io/content-management/image-processing/#image-processing-options">options</a>.</dd>
|
|
<dt><code>type</code></dt>
|
|
<dd>Optional. String. Type of layout. Grid and list layouts use the horizontal axis as the main axis, and the vertical axis as the cross axis. Must be <code>grid</code> or <code>list</code>. Default is <code>list</code>.</dd>
|
|
<dt><code>width</code></dt>
|
|
<dd>Optional. String. CSS value. Image width.</dd>
|
|
</dl>
|
|
|
|
### Hero
|
|
|
|
The `paige/hero` shortcode provides a hero section.
|
|
|
|
```
|
|
{{< paige/hero
|
|
alt=""
|
|
header=""
|
|
height=""
|
|
image=""
|
|
imageclass=""
|
|
maxheight=""
|
|
maxwidth=""
|
|
process=""
|
|
title=""
|
|
width="" >}}
|
|
|
|
{{< /paige/hero >}}
|
|
```
|
|
|
|
Inner content: Optional. String. Markdown. The body.
|
|
|
|
Parameters:
|
|
|
|
<dl>
|
|
<dt><code>alt</code></dt>
|
|
<dd>Optional. String. Plain text. Image alt.</dd>
|
|
<dt><code>header</code></dt>
|
|
<dd>Optional. String. Markdown. The header.</dd>
|
|
<dt><code>height</code></dt>
|
|
<dd>Optional. String. CSS value. Image height.</dd>
|
|
<dt><code>image</code></dt>
|
|
<dd>Optional. String. URL. Image source.</dd>
|
|
<dt><code>imageclass</code></dt>
|
|
<dd>Optional. String. Image class.</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 or boolean. If a string, it is the 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. If no method is specified, resize is used. If no image dimensions are given, the originals are used. If a boolean that is true, the Hugo image processing method resize is used, and the default Hugo image processing options are used.</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>
|
|
|
|
### Icon
|
|
|
|
The `paige/icon` shortcode provides a web font icon.
|
|
|
|
```
|
|
{{< paige/icon
|
|
class=""
|
|
name=""
|
|
url="" >}}
|
|
```
|
|
|
|
Inner content: None.
|
|
|
|
Parameters:
|
|
|
|
<dl>
|
|
<dt><code>class</code></dt>
|
|
<dd>Required. Position 0. String. <code><i></code> class. Example is <code>bi bi-github</code>.</dd>
|
|
<dt><code>name</code></dt>
|
|
<dd>Optional. String. The screen reader description. Example is <code>GitHub</code>.</dd>
|
|
<dt><code>url</code></dt>
|
|
<dd>Optional. String. URL. Example is <code>https://github.com/willfaught/paige</code>. E-mails in URLs with a <code>mailto:</code> scheme are protected from web crawlers.</dd>
|
|
</dl>
|
|
|
|
### Image
|
|
|
|
The `paige/image` shortcode provides a figure with an image.
|
|
|
|
```
|
|
{{< paige/image
|
|
alt=""
|
|
breakpoints=false
|
|
densities=""
|
|
height=""
|
|
link=""
|
|
maxheight=""
|
|
maxwidth=""
|
|
process=""
|
|
sizes=""
|
|
src=""
|
|
srcset=""
|
|
title=""
|
|
width="" >}}
|
|
```
|
|
|
|
Inner content: None.
|
|
|
|
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.</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 is the size of the original image. Examples are <code>1x 2x</code>, <code>1x 1.5x 2x 2.5x 3x</code>, <code>0.5x 1.33x 6x 10x</code>. Must not be set with <code>breakpoints</code>, <code>sizes</code>, or <code>srcset</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.</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 or boolean. If a string, it is the 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. If no method is specified, resize is used. If no image dimensions are given, the originals are used. If a boolean that is true, the Hugo image processing method resize is used, and the default Hugo image processing options are used.</dd>
|
|
<dt><code>sizes</code></dt>
|
|
<dd>Optional. String. Image sizes.</dd>
|
|
<dt><code>src</code></dt>
|
|
<dd>Required. Position 0. String. URL. Image source.</dd>
|
|
<dt><code>srcset</code></dt>
|
|
<dd>Optional. String. Image srcset.</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>
|
|
|
|
### Quote
|
|
|
|
The `paige/quote` shortcode provides a figure with a quotation.
|
|
|
|
```
|
|
{{< paige/quote cite="" >}}
|
|
|
|
{{< /paige/quote >}}
|
|
```
|
|
|
|
Inner content: Required. String. Markdown. The quotation.
|
|
|
|
Parameters:
|
|
|
|
<dt><code>cite</code></dt>
|
|
<dd>Optional. String. Plain text. Citation.</dd>
|
|
|
|
### Vimeo
|
|
|
|
The `paige/vimeo` shortcode provides a responsive Vimeo video.
|
|
|
|
```
|
|
{{< paige/vimeo
|
|
autopause=false
|
|
autoplay=false
|
|
background=false
|
|
byline=false
|
|
color=""
|
|
controls=false
|
|
description=""
|
|
dnt=false
|
|
fullscreen=false
|
|
height=""
|
|
keyboard=false
|
|
loop=false
|
|
maxheight=""
|
|
maxwidth=""
|
|
muted=false
|
|
pip=false
|
|
playsinline=false
|
|
portrait=false
|
|
quality=""
|
|
speed=false
|
|
texttrack=false
|
|
time=""
|
|
title=false
|
|
transparent=false
|
|
video=""
|
|
width="" >}}
|
|
```
|
|
|
|
Inner content: None.
|
|
|
|
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>
|
|
|
|
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 responsive YouTube video.
|
|
|
|
```
|
|
{{< paige/youtube
|
|
autoplay=false
|
|
controls=false
|
|
description=""
|
|
end=0
|
|
fullscreen=false
|
|
height=""
|
|
list=""
|
|
loop=false
|
|
maxheight=""
|
|
maxwidth=""
|
|
mute=false
|
|
start=0
|
|
video=""
|
|
width="" >}}
|
|
```
|
|
|
|
Inner content: None.
|
|
|
|
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>
|
|
|
|
## Customize
|
|
|
|
### Include
|
|
|
|
| If this file exists | It is included at |
|
|
| --------------------------------------------------- | ------------------------------- |
|
|
| `yoursite/layouts/partials/paige/body-first.html` | The beginning of the body tag |
|
|
| `yoursite/layouts/partials/paige/body-last.html` | The end of the body tag |
|
|
| `yoursite/layouts/partials/paige/footer-first.html` | The beginning of the footer tag |
|
|
| `yoursite/layouts/partials/paige/footer-last.html` | The end of the footer tag |
|
|
| `yoursite/layouts/partials/paige/head-first.html` | The beginning of the head tag |
|
|
| `yoursite/layouts/partials/paige/head-last.html` | The end of the head tag |
|
|
| `yoursite/layouts/partials/paige/header-first.html` | The beginning of the header tag |
|
|
| `yoursite/layouts/partials/paige/header-last.html` | The end of the header tag |
|
|
| `yoursite/layouts/partials/paige/main-first.html` | The beginning of the main tag |
|
|
| `yoursite/layouts/partials/paige/main-last.html` | The end of the main tag |
|
|
| `yoursite/layouts/partials/paige/style-first.css` | The beginning of the style tag |
|
|
| `yoursite/layouts/partials/paige/style-last.css` | The end of the style tag |
|
|
|
|
### Override
|
|
|
|
Most code is in partials that are included by the layouts.
|
|
Elements can be added, changed, or removed easily by overriding the corresponding layout or partial.
|
|
|
|
For example, the layouts `list.html`, `single.html`, `taxonomy.html`, and `term.html`
|
|
include the partial `paige/article.html`.
|
|
`paige/article.html` includes the partials `paige/metadata.html`, `paige/toc.html`, and `paige/content.html`.
|
|
To change the page title for those layouts, change `paige/metadata.html`.
|
|
To change the page title for `single.html`,
|
|
replace the use of `paige/article.html` in `single.html` with the use of
|
|
`paige/metadata.html`, `paige/toc.html`, and `paige/content.html`,
|
|
then replace that use of `paige/metadata.html` with your own design.
|
|
|
|
### Extend
|
|
|
|
Use CSS selectors to extend the default styling.
|
|
|
|
Page identifiers:
|
|
|
|
<dl>
|
|
<dt><code>#paige-article</code></dt>
|
|
<dd>The article.</dd>
|
|
<dt><code>#paige-authors</code></dt>
|
|
<dd>The authors.</dd>
|
|
<dt><code>#paige-breadcrumbs</code></dt>
|
|
<dd>The breadcrumbs.</dd>
|
|
<dt><code>#paige-collections</code></dt>
|
|
<dd>The collections.</dd>
|
|
<dt><code>#paige-collections-header</code></dt>
|
|
<dd>The collections header.</dd>
|
|
<dt><code>#paige-comments</code></dt>
|
|
<dd>The comments.</dd>
|
|
<dt><code>#paige-content</code></dt>
|
|
<dd>The content.</dd>
|
|
<dt><code>#paige-copyright</code></dt>
|
|
<dd>The copyright.</dd>
|
|
<dt><code>#paige-credit</code></dt>
|
|
<dd>The credit.</dd>
|
|
<dt><code>#paige-date</code></dt>
|
|
<dd>The date.</dd>
|
|
<dt><code>#paige-description</code></dt>
|
|
<dd>The description.</dd>
|
|
<dt><code>#paige-footer</code></dt>
|
|
<dd>The footer.</dd>
|
|
<dt><code>#paige-header</code></dt>
|
|
<dd>The header.</dd>
|
|
<dt><code>#paige-keywords</code></dt>
|
|
<dd>The keywords.</dd>
|
|
<dt><code>#paige-main</code></dt>
|
|
<dd>The main.</dd>
|
|
<dt><code>#paige-menu</code></dt>
|
|
<dd>The menu.</dd>
|
|
<dt><code>#paige-metadata</code></dt>
|
|
<dd>The metadata.</dd>
|
|
<dt><code>#paige-pages</code></dt>
|
|
<dd>The pages.</dd>
|
|
<dt><code>#paige-pages-header</code></dt>
|
|
<dd>The pages header.</dd>
|
|
<dt><code>#paige-pagination</code></dt>
|
|
<dd>The sub-page pagination links.</dd>
|
|
<dt><code>#paige-reading-time</code></dt>
|
|
<dd>The reading time.</dd>
|
|
<dt><code>#paige-root</code></dt>
|
|
<dd>The outermost element in the body.</dd>
|
|
<dt><code>#paige-sections</code></dt>
|
|
<dd>The sections.</dd>
|
|
<dt><code>#paige-sections-header</code></dt>
|
|
<dd>The sections header.</dd>
|
|
<dt><code>#paige-series</code></dt>
|
|
<dd>The series.</dd>
|
|
<dt><code>#paige-title</code></dt>
|
|
<dd>The title.</dd>
|
|
<dt><code>#paige-toc</code></dt>
|
|
<dd>The table of contents.</dd>
|
|
</dl>
|
|
|
|
Page and sub-page classes:
|
|
|
|
<dl>
|
|
<dt><code>.paige-article</code></dt>
|
|
<dd>The article.</dd>
|
|
<dt><code>.paige-authors</code></dt>
|
|
<dd>The authors.</dd>
|
|
<dt><code>.paige-content</code></dt>
|
|
<dd>The content.</dd>
|
|
<dt><code>.paige-date</code></dt>
|
|
<dd>The date.</dd>
|
|
<dt><code>.paige-date-header</code></dt>
|
|
<dd>The date headers.</dd>
|
|
<dt><code>.paige-description</code></dt>
|
|
<dd>The description.</dd>
|
|
<dt><code>.paige-keyword</code></dt>
|
|
<dd>A keyword.</dd>
|
|
<dt><code>.paige-keywords</code></dt>
|
|
<dd>The keywords.</dd>
|
|
<dt><code>.paige-metadata</code></dt>
|
|
<dd>The metadata.</dd>
|
|
<dt><code>.paige-page</code></dt>
|
|
<dd>A page.</dd>
|
|
<dt><code>.paige-reading-time</code></dt>
|
|
<dd>The reading time.</dd>
|
|
<dt><code>.paige-series</code></dt>
|
|
<dd>The series.</dd>
|
|
<dt><code>.paige-summary</code></dt>
|
|
<dd>The summary.</dd>
|
|
<dt><code>.paige-title</code></dt>
|
|
<dd>The title.</dd>
|
|
<dt><code>.paige-toc</code></dt>
|
|
<dd>The table of contents.</dd>
|
|
</dl>
|
|
|
|
Kind classes:
|
|
|
|
<dl>
|
|
<dt><code>.paige-home</code></dt>
|
|
<dd>The container element of pages with kind "home".</dd>
|
|
<dt><code>.paige-list</code></dt>
|
|
<dd>The container element of pages with kind "section".</dd>
|
|
<dt><code>.paige-single</code></dt>
|
|
<dd>The container element of pages with kind "page".</dd>
|
|
<dt><code>.paige-taxonomy</code></dt>
|
|
<dd>The container element of pages with kind "taxonomy".</dd>
|
|
<dt><code>.paige-term</code></dt>
|
|
<dd>The container element of pages with kind "term".</dd>
|
|
</dl>
|
|
|
|
Status classes:
|
|
|
|
<dl>
|
|
<dt><code>.paige-draft</code></dt>
|
|
<dd>The container element of draft pages.</dd>
|
|
<dt><code>.paige-expired</code></dt>
|
|
<dd>The container element of expired pages.</dd>
|
|
<dt><code>.paige-future</code></dt>
|
|
<dd>The container element of future pages.</dd>
|
|
<dt><code>.paige-modified</code></dt>
|
|
<dd>The container element of modified pages.</dd>
|
|
<dt><code>.paige-published</code></dt>
|
|
<dd>The container element of published pages.</dd>
|
|
<dt><code>.paige-unpublished</code></dt>
|
|
<dd>The container element of unpublished pages.</dd>
|
|
</dl>
|
|
|
|
Shortcode classes:
|
|
|
|
<dl>
|
|
<dt><code>.paige-code</code></dt>
|
|
<dd>The container element of <code>paige/code</code> shortcodes.</dd>
|
|
<dt><code>.paige-figure</code></dt>
|
|
<dd>The container element of <code>paige/figure</code> shortcodes.</dd>
|
|
<dt><code>.paige-gallery</code></dt>
|
|
<dd>The container element of <code>paige/gallery</code> shortcodes.</dd>
|
|
<dt><code>.paige-icon</code></dt>
|
|
<dd>The container element of <code>paige/icon</code> shortcodes.</dd>
|
|
<dt><code>.paige-image</code></dt>
|
|
<dd>The container element of <code>paige/image</code> shortcodes.</dd>
|
|
<dt><code>.paige-quote</code></dt>
|
|
<dd>The container element of <code>paige/quote</code> shortcodes.</dd>
|
|
<dt><code>.paige-vimeo</code></dt>
|
|
<dd>The container element of <code>paige/vimeo</code> shortcodes.</dd>
|
|
<dt><code>.paige-youtube</code></dt>
|
|
<dd>The container element of <code>paige/youtube</code> shortcodes.</dd>
|
|
</dl>
|
|
|
|
If you hide `#paige-credit`, please credit this project in a post to help others find it.
|
|
|
|
### Minimal look
|
|
|
|
By default, everything is shown.
|
|
If you want a more minimal look,
|
|
try the following in your `layouts/partials/paige/style-first.css`:
|
|
|
|
```css
|
|
#paige-authors,
|
|
#paige-collections,
|
|
#paige-credit,
|
|
#paige-keywords,
|
|
#paige-reading-time,
|
|
#paige-series,
|
|
#paige-toc,
|
|
.paige-authors,
|
|
.paige-date,
|
|
.paige-keywords,
|
|
.paige-reading-time,
|
|
.paige-series,
|
|
.paige-summary {
|
|
display: none;
|
|
}
|
|
|
|
```
|
|
|
|
## Design
|
|
|
|
The HTML author is the page authors.
|
|
|
|
The HTML description is the page description.
|
|
|
|
The HTML keywords is a union of the page keywords, tags, and categories.
|
|
|
|
The HTML title is the page title, followed by a middle dot, followed by the site title.
|
|
If one is missing, the other is used without the middle dot.
|
|
For the home page, the title is the page title, or the site title otherwise.
|
|
|
|
The HTML body has a header, a body, and a footer.
|
|
The header has the menu.
|
|
The body has the page article.
|
|
The footer has the copyright notice and the theme link.
|
|
The article has the page metadata, table of contents, and content.
|
|
The metadata has the page title, description, terms, authors, date, and reading time.
|
|
|
|
The copyright notice, title, and description can be Markdown. Markup is stripped for HTML and RSS titles.
|
|
|
|
The page title is displayed in an `h1` tag, so page content headers must start with `h2`.
|
|
|
|
The page date is the publish date.
|
|
|
|
## Implementation
|
|
|
|
The following NPM packages are used:
|
|
|
|
- [bootstrap](https://www.npmjs.com/package/bootstrap/v/5.3.0-alpha2)
|
|
- [bootstrap-icons](https://www.npmjs.com/package/bootstrap-icons/v/1.10.3)
|
|
- [katex](https://www.npmjs.com/package/katex/v/0.16.4)
|
|
|
|
Hugo names, HTML names, CSS names, and JavaScript names that begin with "paige" capitalized in any way,
|
|
optionally prefixed with one or more underscores, are reserved.
|
|
|
|
## Credits
|
|
|
|
- Photos by [Lanty](https://unsplash.com/@photos_by_lanty)
|
|
- Photo by [Sergey Pesterev](https://unsplash.com/photos/JV78PVf3gGI)
|
|
|
|
## Project
|
|
|
|
Created by [Will Faught](https://willfaught.com).
|
|
Released under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).
|
|
Hosted at https://github.com/willfaught/paige.
|