Paige

Powerful, pliable pixel perfection. An advanced Hugo theme. Try it out.

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 web needs.

Features

Accessibility
Analytics
Atom feed
Authors
Blog
Bootstrap styles and icons
Categories
Code shortcode
Comments
Customizable
Dark color scheme
Email shortcode
Facebook sharing
Figure shortcode
Gallery shortcode
Header links
Icon shortcode
Image pixel densities
Image shortcode
Image size breakpoints
Image thumbnails
Landing page
Languages
Light color scheme
Math typesetting
Menu
Minimal design
Quote shortcode
Responsive
Right-to-left languages
RSS feed
Safari and Firefox Reader View support
Search
Sections
SEO
Series
Single column
Social links
Table of contents
Tab shortcode
Tags
Twitter sharing
Validated with PageSpeed and Validator
Vimeo shortcode
YouTube shortcode

Community

Get started by starring and watching the project.

If you find a problem or have a suggestion, please share it by creating an issue.

If you have a fix or improvement, please share it by creating a pull request.

If you make a customization or alteration, please share it by posting code or screenshots.

If you deploy a site, please share it by posting a link.

Setup

Install Hugo (the extended version, and at least 0.123.0).

For Homebrew on Mac:
```
$ brew install hugo
```
For Chocolatey on Windows:
```
$ choco install hugo-extended
```
For Snap on Linux:
```
$ sudo snap install hugo
```
Install Dart Sass.

For Homebrew on Mac:
```
$ brew install sass/sass/sass
```
For Chocolatey on Windows:
```
$ choco install sass
```
For Snap on Linux:
```
$ sudo snap install dart-sass
```
Create a site:
```
$ hugo new site yoursite
```
Create a post:
```
$ cd yoursite
$ hugo new yourpost.md
```

Install the Paige module:

$ cd yoursite
$ hugo mod init github.com/youraccount/yoursite
$ hugo mod get github.com/willfaught/paige@latest

Import the Paige module:

$ cd yoursite
$ cat >>hugo.toml <<EOF
[[module.imports]]
path = "github.com/willfaught/paige"
EOF

Build and run the site:
```
$ cd yoursite
$ hugo server -D
```

Update the Paige module:

$ cd yoursite
$ hugo mod get github.com/willfaught/paige@latest

See Hugo's installation, getting started, and module guides for more information.

See the minimal look, narrow look, narrow-and-wide look, and menu navigation only sections for common customizations.

Configure

Parameters

There is a single parameter object with sensible defaults that can be overridden in site or page parameters:

[paige]
color = "#0d6efd" # Bootstrap primary color and theme color for Safari and Windows
color_scheme = "auto" # Must be "auto", "dark", or "light"
credit = '<a class="link-secondary text-decoration-none" href="https://github.com/willfaught/paige">Paige Theme</a>'
date_format = ":date_long" # Hugo date format
description = "" # Site description. Appears above the menu, below the site title, if set.
edit = "" # File edit URL. Example: "https://github.com/account/project/edit/master/content/%s".
external_link_new_tab = false # Open external links in new tabs
history = "" # File history URL. Example: "https://github.com/account/project/commits/master/content/%s".
keyword_style = "text" # Must be "text" or "pills"
license = "" # Example: "CC BY 4.0 License", "CC BY-NC 4.0 License", "MIT License"
math = false # Enable math typesetting
menu_style = "links" # Must be "links", "pills", "tabs", or "underline"
title = "" # Site title. Appears above the menu, above the site description, if set.
style = "" # CSS included at the end of the stylesheet, before style-last.css

[paige.alert]
message = "Alert!" # Markdown displayed before the page body
type = "primary" # Bootstrap alert class

[paige.analytics]
disable = false # Disable all analytics

[paige.analytics.beam] # See https://beamanalytics.io
token = ""

[paige.analytics.chartbeat] # See https://chartbeat.com
account_id = ""
domain = ""

[paige.analytics.clarity] # See https://clarity.microsoft.com
account_id = ""

[paige.analytics.clicky] # See https://clicky.com
account_id = ""

[paige.analytics.counter] # See https://counter.dev
account_id = ""
utc_offset = ""

[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.pirsch] # See https://pirsch.io
identification_code = ""

[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
disable_kinds = [] # Page kinds to disable comments for. Examples: ["list"], ["page", "term"].

[paige.comments.cactus] # See https://cactus.chat
site_name = ""

[paige.comments.commento] # See https://commento.io
script_url = ""

[paige.comments.cusdis] # See https://cusdis.com
app_id = ""
host_url = ""

[paige.comments.graphcomment] # See https://graphcomment.com
account_id = ""

[paige.comments.hyvor] # See https://hyvor.com
website = ""

[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
site = ""

[paige.comments.utterances] # See https://utteranc.es
repo = ""
theme = ""

[paige.feed]
disable = false # Exclude the page from feeds
link_to_page = false # Link to the page instead of the front matter link, if present
page_link = "⏎" # If a front matter link is present, and link_to_page is false, then link to the page with this text

[paige.feed.atom]
authors = []
# Example:
# [[paige.feed.atom.authors]]
# email = "example@example.com"
# name = "John Doe"
# url = "https://github.com/account/project"
icon = "" # Example: "/icon.webp"
logo = "" # Example: "/logo.webp"

[paige.feed.rss]
managing_editor = "" # Example: "example@example.com (John Doe)"
web_master = "" # Example: "example@example.com (John Doe)"

[params.paige.list_page]
disable_authors = false
disable_collections = false
disable_date = false
disable_description = false
disable_keywords = false
disable_pages = false
disable_reading_time = false
disable_sections = false
disable_series = false
disable_summary = false
disable_title = false

[params.paige.page]
disable_alert = false
disable_authors = false
disable_date = false
disable_description = false
disable_edit = false
disable_history = false
disable_keywords = false
disable_next = false
disable_prev = false
disable_reading_time = false
disable_series = false
disable_title = false
disable_toc = false

[params.paige.site]
disable_breadcrumbs = false
disable_copyright = false
disable_credit = false
disable_description = false
disable_license = false
disable_menu = false
disable_title = false

[paige.search]
disable = false # Exclude the page from search

The parameter object is accessed in site parameters as [params.paige], and in page parameters as [paige].

The assigned values shown are the default values.

Parameters specific to pages:

link = "" # The reference for an anchor around the title. Example: "https://youtu.be/dQw4w9WgXcQ".

The assigned values shown are the default values.

Parameters specific to menus:

[paige]
disabled = false
divider_above = false
divider_below = false
header_above = ""
header_below = ""

The assigned values shown are the default values.

Taxonomies

Support for authors, categories, series, and tags taxonomies is built in.

Set default to true in the front matter of an author term page for that author to be credited in regular pages that have no authors parameter. A default author must be referenced at least once explicitly in a regular page.

To disable the rendering of author pages, add this to yoursite/hugo.toml:

[[cascade]]
[cascade._target]
path = "{/authors,/authors/**}"
[cascade.build]
render = "never"

The email and url parameters in the front matter of an author term page are used in feeds if present.

Layouts

Cloud

The paige/cloud layout provides a link cloud for sub-pages.

Example configuration in yoursite/content/tags/_index.md:

layout = "paige/cloud"

Search

The paige/search layout provides a search page.

Example configuration in yoursite/hugo.toml:

[outputs]
home = ["atom", "html", "paige-search", "rss"]

Example configuration in yoursite/content/search.md:

layout = "paige/search"
title = "Search"

Shortcodes

Code

The paige/code shortcode provides highlighted code.

{{< paige/code
    lang=""
    options=""
    unescape=false >}}

{{< /paige/code >}}

Parameters:

lang: Optional. Position 0. String. Chroma language code. Default is plaintext.
options: Optional. String. Hugo highlight options.
unescape: Optional. Boolean. Whether to reverse the HTML escaping in the body. Useful for when the request shortcode is used in the body.

Body: Required. String. The code.

Email

The paige/email shortcode hides e-mail addresses from robots.

{{< paige/email
    address="" >}}

{{< /paige/email >}}

Parameters:

address: Required. Position 0. String. The e-mail address.

Body: Required. String. Markdown. The content.

Figure

The paige/figure shortcode provides a figure.

{{< paige/figure
    caption=""
    float=""
    height=""
    horizontal=""
    maxwidth=""
    number=0
    numbered=false
    vertical=""
    width="" >}}

{{< /paige/figure >}}

Parameters:

caption: Optional. Position 0. String. Markdown. Descriptive text below the content.
float: Optional. String. Float to one side of its container. Must be start or end.
height: Optional. String. CSS value. Total height.
horizontal: Optional. String. Horizontal alignment. Must be start, center, or end. Default is center.
maxwidth: Optional. String. CSS value. Maximum total width.
number: Optional. Integer or string. Figure number. Displayed with the caption.
numbered: Optional. Boolean. Number the figure automatically. Displayed with the caption.
vertical: Optional. String. Vertical alignment. Must be start, center, or end. Default is center.
width: Optional. String. CSS value. Total width.

Body: Required. String. Markdown. The content.

Gallery

The paige/gallery shortcode provides an arrangement of images.

{{< paige/gallery
    align=""
    breakpoints=false
    class=""
    densities=""
    fetchpriority=""
    height=""
    images=""
    justify=""
    linked=""
    loading=""
    maxheight=""
    maxwidth=""
    process=""
    style=""
    type=""
    width="" >}}

{{< /paige/gallery >}}

Parameters:

align: Optional. String. Cross axis alignment. Must be baseline, center, end, start, or stretch.
breakpoints: Optional. Boolean. Whether to generate copies of the image sized to each Bootstrap breakpoint. Must not use with densities.
class: Optional. String. Image class. Merged with implementation.
densities: 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 1x 2x, 1x 1.5x 2x 2.5x 3x, and 0.5x 1.33x 6x 10x. Must not use with breakpoints.
fetchpriority: Optional. String. Must be high or low.
height: Optional. String. CSS value. Image height.
images: Optional. Position 0. String. Page, site, or remote images glob. Default is all image page resources.
justify: Optional. String. Main axis space distribution. Must be around, between, center, end, evenly, or start.
linked: Optional. String. Hugo image processing methods and options, 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 unprocessed, it is unprocessed. If it is default, the default options are used.
loading: Optional. String. Must be eager (default) or lazy.
maxheight: Optional. String. CSS value. Maximum image height.
maxwidth: Optional. String. CSS value. Maximum image width.
process: Optional. String. Hugo image processing methods and options, 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 default, the default options are used.
style: Optional. String. CSS. Image style. Merged with implementation.
type: Optional. String. Type of layout. Must be grid or rows (default).
width: Optional. String. CSS value. Image width.

Body: Optional. String. HTML. The images.

Icon

The paige/icon shortcode provides a web font icon.

{{< paige/icon
    class=""
    title=""
    url="" >}}

Parameters:

class: Required. Position 0. String. <i> class. Example: bi bi-github.
title: Optional. String. The screen reader description and anchor title. Example: GitHub.
url: Optional. String. URL. Example: https://github.com/account/project. E-mails in URLs with a mailto: scheme are protected from web crawlers.

Body: None.

Image

The paige/image shortcode provides an image.

{{< paige/image
    alt=""
    breakpoints=false
    class=""
    densities=""
    fetchpriority=""
    height=""
    link=""
    linked=""
    loading=""
    maxheight=""
    maxwidth=""
    process=""
    sizes=""
    src=""
    srcset=""
    style=""
    title=""
    width="" >}}

Parameters:

alt: Optional. String. Plain text. Image alt.
breakpoints: Optional. Boolean. Whether to generate copies of the image sized to each Bootstrap breakpoint. Must not use with densities, sizes, or srcset.
class: Optional. String. Class attribute value.
densities: 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 1x 2x, 1x 1.5x 2x 2.5x 3x, and 0.5x 1.33x 6x 10x. Must not use with breakpoints, sizes, or srcset.
fetchpriority: Optional. String. Must be high or low.
height: Optional. String. CSS value. Image height.
link: Optional. String. URL. Image link. Must not use with linked.
linked: Optional. String. Hugo image processing methods and options, 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 unprocessed, it is unprocessed. If it is default, the default options are used. Must not use with link.
loading: Optional. String. Must be eager (default) or lazy.
maxheight: Optional. String. CSS value. Image maximum height.
maxwidth: Optional. String. CSS value. Image maximum width.
process: Optional. String. Hugo image processing methods and options, 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 default, the default options are used.
sizes: Optional. String. Image sizes. Must not be set with breakpoints or densities.
src: Required. Position 0. String. URL. Image source.
srcset: Optional. String. Image srcset. Must not be set with breakpoints or densities.
style: Optional. String. CSS. Image style. Merged with implementation.
title: Optional. String. Plain text. Image title.
width: Optional. String. CSS value. Image width.

Body: None.

Quote

The paige/quote shortcode provides a quotation.

{{< paige/quote
    cite="" >}}

{{< /paige/quote >}}

Parameters:

cite: Optional. String. Plain text. Citation.

Body: Required. String. Markdown. The quotation.

Request

The paige/request shortcode provides the content for a URL.

{{< paige/request
    method=""
    url="" >}}

Parameters:

method: Optional. String. HTTP method. Default is get.
url: Required. String. URL.

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.

{{< paige/tabs >}}

{{< /paige/tabs >}}

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.

{{< paige/tabs/buttons >}}

{{< /paige/tabs/buttons >}}

Parameters: None.

Body: Required. String. HTML. The tab buttons.

The paige/tabs/button shortcode provides a tab button.

{{< paige/tabs/button >}}

{{< /paige/tabs/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.

{{< paige/tabs/panes >}}

{{< /paige/tabs/panes >}}

Parameters: None.

Body: Required. String. HTML. The tab panes.

The paige/tabs/pane shortcode provides a tab pane.

{{< paige/tabs/pane >}}

{{< /paige/tabs/pane >}}

Parameters: None.

Body: Required. String. Markdown. The tab pane content.

Vimeo

The paige/vimeo shortcode provides a 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="" >}}

Parameters:

autopause: Optional. Boolean. Enable playing more than one Vimeo video on the same page. Default is true.
autoplay: Optional. Boolean. Autoplay the video. Default is false.
background: Optional. Boolean. Autoplay the video. Hide the controls. Loop the video. Mute the video. Default is false.
byline: Optional. Boolean. Show the author. Default is configured per video.
color: Optional. String. Hex code. Control color. Default is 00adef.
controls: Optional. Boolean. Show the controls. Default is true.
description: Optional. String. Plain text. Screen reader content. Default is Vimeo video.
dnt: Optional. Boolean. Do not track session data. Default is false.
fullscreen: Optional. Boolean. Enable full screen. Default is true.
height: Optional. String. CSS value. Video height.
keyboard: Optional. Boolean. Enable keyboard input. Default is true.
loop: Optional. Boolean. Loop the video. Default is false.
maxheight: Optional. String. CSS value. Video maximum height.
maxwidth: Optional. String. CSS value. Video maximum width.
muted: Optional. Boolean. Mute the video. Default is false.
pip: Optional. Boolean. Show the picture-in-picture control. Default is false.
playsinline: Optional. Boolean. Play inline instead of full screen on mobile devices. Default is true.
portrait: Optional. Boolean. Show the author's profile image. Default is configured per video.
quality: Optional. String. The resolution. Must be auto, 240p, 360p, 540p, 720p, 1080p, 2k, or 4k. Default is auto.
speed: Optional. Boolean. Show the speed controls. Default is false.
texttrack: Optional. String. Language code and optionally a locale code (e.g. en, en-US). Use the corresponding subtitles. Default is false.
time: Optional. String. Duration (e.g. 0m, 1m2s). Start time. Default is 0m.
title: Optional. Boolean. Show the title. Default is configured per video.
transparent: Optional. Boolean. Use a transparent background instead of a black one. Default is true.
video: Optional. Position 0. String. Video ID.
width: Optional. String. CSS value. Video width.

Body: None.

See Vimeo documentation for more detail.

YouTube

The paige/youtube shortcode provides a 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="" >}}

Parameters:

autoplay: Optional. Boolean. Automatically play the video.
controls: Optional. Boolean. Show video controls. Default is true.
description: Optional. String. Plain text. Screen reader content. Default is YouTube video.
end: Optional. Integer. Elapsed seconds. Stop the video here.
fullscreen: Optional. Boolean. Enable full screen. Default is true.
height: Optional. String. CSS value. Video height.
list: Optional. String. Playlist ID.
loop: Optional. Boolean. Loop the video.
maxheight: Optional. String. CSS value. Video maximum height.
maxwidth: Optional. String. CSS value. Video maximum width.
mute: Optional. Boolean. Mute the video.
start: Optional. Integer. Elapsed seconds. Start the video here.
video: Optional. Position 0. String. Video ID.
width: Optional. String. CSS value. Video width.

Body: None.

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/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/page-footer-first.html`	The beginning of the page footer tag
`yoursite/layouts/partials/paige/page-footer-last.html`	The end of the page footer tag
`yoursite/layouts/partials/paige/page-header-first.html`	The beginning of the page header tag
`yoursite/layouts/partials/paige/page-header-last.html`	The end of the page header tag
`yoursite/layouts/partials/paige/site-first.html`	The beginning of the main tag
`yoursite/layouts/partials/paige/site-last.html`	The end of the main tag
`yoursite/layouts/partials/paige/site-footer-first.html`	The beginning of the site footer tag
`yoursite/layouts/partials/paige/site-footer-last.html`	The end of the site footer tag
`yoursite/layouts/partials/paige/site-header-first.html`	The beginning of the site header tag
`yoursite/layouts/partials/paige/site-header-last.html`	The end of the site header 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 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/android-chrome-192x192.png
static/android-chrome-512x512.png
static/apple-touch-icon-114x114-precomposed.png
static/apple-touch-icon-114x114.png
static/apple-touch-icon-120x120-precomposed.png
static/apple-touch-icon-120x120.png
static/apple-touch-icon-144x144-precomposed.png
static/apple-touch-icon-144x144.png
static/apple-touch-icon-152x152-precomposed.png
static/apple-touch-icon-152x152.png
static/apple-touch-icon-180x180-precomposed.png
static/apple-touch-icon-180x180.png
static/apple-touch-icon-57x57-precomposed.png
static/apple-touch-icon-57x57.png
static/apple-touch-icon-60x60-precomposed.png
static/apple-touch-icon-60x60.png
static/apple-touch-icon-72x72-precomposed.png
static/apple-touch-icon-72x72.png
static/apple-touch-icon-76x76-precomposed.png
static/apple-touch-icon-76x76.png
static/apple-touch-icon-precomposed.png
static/apple-touch-icon.png
static/favicon-16x16.png
static/favicon-32x32.png
static/favicon.ico
static/favicon.png
static/favicon.svg
static/mstile-144x144.png
static/mstile-150x150.png
static/mstile-310x150.png
static/mstile-310x310.png
static/mstile-70x70.png
static/safari-pinned-tab.svg

You can generate these favicon files here.

To change the syntax highlighting styles, override these files with your own:

layouts/partials/paige/dark.css
layouts/partials/paige/light.css

Extend

Use CSS selectors to extend the default styling.

Page identifiers:

#paige-alert: The page alert.
#paige-authors: The page authors.
#paige-breadcrumbs: The site breadcrumbs.
#paige-collections: The site collection pages.
#paige-collections-header: The site collection pages header.
#paige-comments: The page comments.
#paige-content: The page content.
#paige-copyright: The site copyright.
#paige-credit: The site credit.
#paige-date: The page date.
#paige-edit: The page edit link.
#paige-file: The page edit and history links.
#paige-history: The page history link.
#paige-keywords: The page keywords.
#paige-license: The site license.
#paige-menu: The site menu.
#paige-metadata: The page metadata.
#paige-next: The next page link.
#paige-page-description: The page description.
#paige-page-footer: The page footer that contains the page edit, history, next, and previous links.
#paige-page-header: The page header that contains the page title, description, metadata, and table of contents.
#paige-page-title: The page title.
#paige-pages: The page sub-pages.
#paige-pages-header: The page sub-pages header.
#paige-pagination: The pagination of sub-pages.
#paige-prev: The previous page link.
#paige-reading-time: The page reading time.
#paige-sections: The page section sub-pages.
#paige-sections-header: The page section sub-pages header.
#paige-series: The page series.
#paige-siblings: The page next and previous links.
#paige-site-description: The site description.
#paige-site-footer: The site footer that contains the site copyright, license, and credit.
#paige-site-header: The site header that contains the site title, description, menu, and breadcrumbs.
#paige-site-title: The site title.
#paige-toc: The table of contents.

Page classes:

.paige-keyword: A keyword.
.paige-keyword-category: A category keyword.
.paige-keyword-tag: A tag keyword.
.paige-keywords: The keywords.

Sub-page classes:

.paige-authors: The authors.
.paige-date: The date.
.paige-description: The description.
.paige-metadata: The metadata.
.paige-page: A page.
.paige-reading-time: The reading time.
.paige-series: The series.
.paige-summary: The summary.
.paige-title: The title.

Page kind classes:

.paige-kind-home: The container element of pages with kind "home".
.paige-kind-section: The container element of pages with kind "section".
.paige-kind-page: The container element of pages with kind "page".
.paige-kind-taxonomy: The container element of pages with kind "taxonomy".
.paige-kind-term: The container element of pages with kind "term".

Page status classes:

.paige-draft: The container element of draft pages.
.paige-expired: The container element of expired pages.
.paige-future: The container element of future pages.
.paige-modified: The container element of modified pages.
.paige-published: The container element of published pages.
.paige-unpublished: The container element of unpublished pages.

Shortcode classes:

.paige-code: The container element of paige/code shortcodes.
.paige-email: The container element of paige/email shortcodes.
.paige-figure: The container element of paige/figure shortcodes.
.paige-gallery: The container element of paige/gallery shortcodes.
.paige-icon: The container element of paige/icon shortcodes.
.paige-image: The container element of paige/image shortcodes.
.paige-quote: The container element of paige/quote shortcodes.
.paige-vimeo: The container element of paige/vimeo shortcodes.
.paige-youtube: The container element of paige/youtube shortcodes.

Minimal look

By default, everything is shown. If you want a more minimal look, try the following in yoursite/hugo.toml:

[params.paige.list_page]
disable_authors = true
disable_date = true
disable_keywords = true
disable_reading_time = true
disable_series = true
disable_summary = true

[params.paige.page]
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

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 (40rem), try the following in yoursite/hugo.toml:

[params.paige]
style = """
#paige-content > * { 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 (40rem) for all content except media, try the following in yoursite/hugo.toml:

[params.paige]
style = """
#paige-content > * { margin-left: auto; margin-right: auto; max-width: 40rem; }
#paige-content > img,
#paige-content > .paige-image,
#paige-content > .paige-vimeo,
#paige-content > .paige-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:

[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:

[params.paige.list_page]
disable_collections = true
disable_pages = true
disable_sections = true

Credits

Photos by Lanty
Photo by Sergey Pesterev

Project

Created by Will Faught. Released under the MIT License. Hosted at https://github.com/willfaught/paige.

Name		Name	Last commit message	Last commit date
Latest commit History 1,728 Commits
.github/workflows		.github/workflows
archetypes		archetypes
assets		assets
exampleSite		exampleSite
i18n		i18n
images		images
layouts		layouts
paige		paige
static		static
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
go.mod		go.mod
hugo.toml		hugo.toml
theme.toml		theme.toml

License

willfaught/paige

Folders and files

Latest commit

History

Repository files navigation

Paige

Features

Community

Setup

Configure

Parameters

Menu

Taxonomies

Layouts

Cloud

Search

Shortcodes

Code

Email

Figure

Gallery

Icon

Image

Quote

Request

Tabs

Vimeo

YouTube

Customize

Include

Override

Extend

Minimal look

Narrow look

Narrow-and-wide look

Menu navigation only

Credits

Project

About

Topics

Resources

License

Stars

Watchers

Forks

Used by 187

Contributors 3

Languages