Skip to content

Latest commit

 

History

History
1159 lines (928 loc) · 42.4 KB

README.md

File metadata and controls

1159 lines (928 loc) · 42.4 KB

Paige

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

Screenshot

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

  1. Install Hugo (the extended version, and at least v0.141.0).

    For Homebrew on Mac:

    $ brew install hugo

    For Chocolatey on Windows:

    $ choco install hugo-extended

    For Snap on Linux:

    $ sudo snap install hugo
  2. 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
  3. Create a site:

    $ hugo new site yoursite
  4. Create a post:

    $ cd yoursite
    $ hugo new yourpost.md
  5. Install the Paige module:

    $ cd yoursite
    $ hugo mod init github.com/youraccount/yoursite
    $ hugo mod get github.com/willfaught/paige@latest
  6. Import the Paige module:

    $ cd yoursite
    $ cat >>hugo.toml <<EOF
    [[module.imports]]
    path = "github.com/willfaught/paige"
    EOF
  7. Build and run the site:

    $ cd yoursite
    $ hugo server -D
  8. 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.

Kickoff

By default, everything is enabled, which is likely not what you want. See the minimal look section for ideas of what to disable.

By default, page body content spans its entire container, which spans most of the window. See the narrow look and narrow-and-wide look sections for ideas of how to customize the presentation.

The breadcrumb, collection, and section links are sufficient to browse any site, so you can safely disable the menu. However, in sites with only a handful of sections and no nested sections, the menu alone can be sufficient for all navigation. See the menu navigation only section for how to do that.

To change the favicon, see the override section.

To add analytics, put the code in yoursite/layouts/partials/paige/site-last.html. See the include section.

To add comments, put the code in yoursite/layouts/partials/paige/page-body-last-page.html. See the include section.

Configure

Parameters

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

[paige]

enable_math = false # Enables math typesetting for this page
exclude_feeds = false # Exclude this page from feeds
exclude_search = false # Exclude this page from search
style = "" # CSS included at the end of the stylesheet, before style-last.css, 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 = "[email protected]"
# name = "John Doe"
# url = "https://github.com/account/project"
icon = "" # Example: "/icon.webp"
logo = "" # Example: "/logo.webp"

[paige.feeds.rss]

managing_editor = "" # Example: "[email protected] (John Doe)"
web_master = "" # Example: "[email protected] (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

# 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 if set.
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].

The assigned values shown are the default values unless otherwise specified.

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 author term pages (if the "authors" taxonomy is configured):

[paige.author]
email = "" # Example: [email protected]
name = "" # Example: John Doe
url = "" # Example: https://example.com

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.

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.

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.

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:

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.

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.

Parameters:

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

Body: Required. String. Markdown. The content.

Figure

The paige/figure shortcode provides a 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.

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.

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.

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.

Parameters:

cite
Optional. String. Plain text. Citation.

Body: Required. String. Markdown. The quotation.

Request

The paige/request shortcode provides the content for a 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.

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:

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.

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

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
layouts/partials/paige/style-first.css The beginning of the styles
layouts/partials/paige/style-last.css The ending of the styles

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/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-page-alert
The page alert.
#paige-page-authors
The page authors.
#paige-page-collections
The page collections.
#paige-page-collections-header
The page collections header.
#paige-page-content
The page content.
#paige-page-date
The page date.
#paige-page-description
The page description.
#paige-page-edit
The page edit link.
#paige-page-file
The container of the page edit and history links.
#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 metadata and table of contents.
#paige-page-history
The page history link.
#paige-page-keywords
The page keywords.
#paige-page-metadata
The page metadata.
#paige-page-next
The page next link.
#paige-page-pages
The page pages.
#paige-page-pages-header
The page pages header.
#paige-page-pagination
The pagination of subpages.
#paige-page-prev
The page previous link.
#paige-page-reading-time
The page reading time.
#paige-page-sections
The page sections.
#paige-page-sections-header
The page sections header.
#paige-page-series
The page series.
#paige-page-siblings
The container of the page next and previous links.
#paige-page-title
The page title.
#paige-page-toc
The page table of contents.
#paige-page-word-count
The page word count.

Site identifiers:

#paige-site-breadcrumbs
The site breadcrumbs.
#paige-site-copyright
The site copyright.
#paige-site-credit
The site credit.
#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-license
The site license.
#paige-site-menu
The site menu.
#paige-site-title
The site title.

Page classes:

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

Subpage classes:

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

Page kind classes:

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

Page status classes:

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

Shortcode classes:

.paige-shortcode-code
The container of paige/code shortcodes.
.paige-shortcode-email
The container of paige/email shortcodes.
.paige-shortcode-figure
The container of paige/figure shortcodes.
.paige-shortcode-gallery
The container of paige/gallery shortcodes.
.paige-shortcode-icon
The container of paige/icon shortcodes.
.paige-shortcode-image
The container of paige/image shortcodes.
.paige-shortcode-quote
The container of paige/quote shortcodes.
.paige-shortcode-vimeo
The container of paige/vimeo shortcodes.
.paige-shortcode-youtube
The container 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.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

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

[params.paige]
style = """
#paige-page-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-page-content > * { 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:

[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.pages]
disable_collections = true
disable_pages = true
disable_sections = true

Credits

Project

Created by Will Faught. Licensed under the EUPL. Hosted at https://github.com/willfaught/paige.