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 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
• Automatic switching between light and dark color schemes
• Blog
• Bootstrap
• Comments
• Customizable
• Dark color scheme
• E-mail protection
• Facebook sharing
• Header links
• Landing page
• Light color scheme
• Math typesetting
• Menu
• Minimal design
• Multiple authors
• Multiple languages
• RSS with full content
• Responsive
• Right-to-left languages
• SEO
• Safari and Firefox Reader View support
• Search
• Sections
• Single column
• Social links
• Table of contents
• Twitter sharing

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.

Get started with Hugo

1. Install Hugo (the extended version is required).

   For Homebrew on Mac:

   $ brew install hugo
   

2. Install Node.

   For Homebrew on Mac:

   $ brew install node
   

3. Create a site:

   $ hugo new site yourproject
   

4. Create a post:

   $ cd yourproject
   $ hugo new my-post.md
   

See Hugo’s quick start guide for more information.

Install

Option 1: Use a Hugo module

Example config.yaml:

module:
  imports:
  - path: "github.com/willfaught/paige"

Install:

$ cd yourproject
$ hugo mod init github.com/youraccount/yourproject
$ hugo mod get github.com/willfaught/paige

Update:

$ cd yourproject
$ hugo mod get -u

Option 2: Use a Git subtree

Example config.yaml:

theme: "paige"

Install:

$ cd yourproject
$ git subtree add --prefix themes/paige --squash https://github.com/willfaught/paige master

Update:

$ cd yourproject
$ git subtree pull --prefix themes/paige --squash https://github.com/willfaught/paige master

Option 3: Use a Git submodule

Example config.yaml:

theme: "paige"

Install:

$ cd yourproject
$ git submodule add https://github.com/willfaught/paige themes/paige
$ git submodule update --init --recursive --remote

Update:

$ cd yourproject
$ git submodule update --recursive --remote

Option 4: Use a copy

Example config.yaml:

theme: "paige"

Install:

$ cd yourproject
$ git clone https://github.com/willfaught/paige themes/paige
$ rm -rf themes/paige/.git

Update:

$ cd yourproject
$ rm -rf themes/paige
$ git clone https://github.com/willfaught/paige themes/paige
$ rm -rf themes/paige/.git

Run

$ cd yourproject
$ hugo mod npm pack
$ npm install
$ hugo server -D

Configure

Parameters

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

paige:
  analytics:
    chartbeat: # See https://chartbeat.com
      account_id: ""
      domain: ""
    disabled: false # Disable all analytics
    clicky: # See https://clicky.com
      account_id: ""
    fathom: # See https://usefathom.com
      account_id: ""
    finteza: # See https://finteza.com
      account_id: ""
      script_url: ""
    hotjar: # See https://hotjar.com
      account_id: ""
    matomo: # See https://matomo.org
      account_id: ""
      host_url: ""
    mixpanel: # See https://mixpanel.com
      token: ""
    plausible: # See https://plausible.io
      account_id: ""
    woopra: # See https://woopra.com
      domain: ""
    yandex: # See https://metrica.yandex.com
      account_id: ""
  color: "#0d6efd" # Bootstrap primary color; theme color for Safari and Windows
  color_scheme: "" # Always use this color scheme without automatic switching; must be "", "light", or "dark"
  comments:
    cactus: # See https://cactus.chat
      account_id: ""
    commento: # See https://commento.io
      script_url: ""
    disabled: false # Disable all comments
    hyvor: # See https://hyvor.com
      account_id: ""
    intensedebate: # See https://intensedebate.com
      account_id: ""
    isso: # See https://isso-comments.de
      script_url: ""
    remark42: # See https://remark42.com
      host_url: ""
      site_id: ""
    replybox: # See https://getreplybox.com
      account_id: ""
    utterances: # See https://utteranc.es
      github_repo: ""
  date:
    format: ":date_long" # Hugo date format
    source: "published" # Displayed date in single pages; must be "published" or "modified"
  git:
    commit_url_prefix: "" # Example is "https://github.com/willfaught/paige/commit/"
  math: false # Enable math typesetting
  max_width: "" # Maximum width for the whole page
  menu:
    breakpoint: "sm" # Bootstrap breakpoint at which to display all menu items
    style: "pills" # Must be "links" or "pills"
  rss:
    hide_page: false
    managing_editor: ""
    web_master: ""
  search:
    hide_page: false
  section_pages:
    full_pages: false # Display full pages in the list of pages.
  style: "" # CSS included at the end of the stylesheet, before layouts/paige/style-last.css.

The assigned values shown are the default values.

Site parameters

Optional site parameters:

authors:
  will_faught:
    name: "Will Faught"
    default: false # Credit this author in pages that have no authors parameter

Page parameters

Optional page parameters:

authors:
- "will_faught" # Credit the corresponding author in the site parameters
- author: "will_faught" # Credit the corresponding author in the site parameters
- name: "Will Faught" # Credit this author
link: "https://youtu.be/dQw4w9WgXcQ" # The reference for an anchor around the title

Layouts

Home

The paige/home layout provides a home page.

Example content/_index.md:

layout: "paige/home"
paige:
  home:
    blurb: "" # Displayed below the greeting
    greeting: "" # Displayed below the image
    image:
      raw: false # Do not copy or process the file
      stretch: false # Stretch the image fully horizontally if true; center the image otherwise
      url: "" # Local or remote resource glob
  social:
    examplesite:
      bootstrap_icon: "" # Example is "example-icon"
      name: "" # Example is "Example"
      url: "" # Example is "https://example.com/username"

The assigned values shown are the default values.

Search

The paige/search layout provides full site search.

Example config.yaml:

outputs:
  home: ["html", "json", "rss"]

Example content/search.md:

layout: "paige/search"
title: "Search"

Shortcodes

Figure

The paige/figure shortcode provides a figure with content.

{{< paige/figure
    caption="My caption"
    float="left"
    height="10rem"
    horizontal="center"
    maxwidth="10rem"
    number=0
    numbered=false
    vertical="center"
    width="10rem"
>}}
My content
{{< /paige/figure >}}

Inner content: Required. String. Markdown. The content.

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.

Quote

The paige/quote shortcode provides a figure with a quotation.

{{< paige/quote >}}
My content
{{< /paige/quote >}}

Inner content: Required. String. Markdown. The quotation.

Parameters: None.

Code

The paige/code shortcode provides a figure with code.

{{< paige/code lang="html" options="linenos=true" >}}
<!doctype html>
<html lang="en">
<body>
  <p>Test</p>
</body>
</html>
{{< /paige/code >}}

Inner content: Required. String. The code.

Parameters:

lang

Optional. Position 0. String. Chroma language code. Defaults to plaintext. See the codes.

options

Optional. String. Hugo highlight options. See the options.

Image

The paige/image shortcode provides a figure with an image.

{{< paige/image
    alt="My alt" >}}
    height="10rem"
    link="https://github.com/willfaught/paige"
    method="resize"
    options="550x webp picture Lanczos"
    raw=false
    src="me.jpg"
    title="My title"
    width="10rem"
>}}

Inner content: None.

Parameters:

alt

Optional. String. Plain text. Image alt.

height

Optional. String. CSS value. Image height.

link

Optional. String. URL. Image link.

method

Optional. String. Hugo image processing method. Must be crop, fill, fit, or resize. Must be specified with options. See the methods.

options

Optional. String. Hugo image processing options. Must be specified with method. See the options.

raw

Optional. Boolean. Whether to reference an image without copying it. Default is false.

src

Required. Position 0. String. URL. Image source.

title

Optional. String. Plain text. Image title.

width

Optional. String. CSS value. Image width.

Gallery

The paige/gallery shortcode provides a figure with a collection of images.

{{< paige/gallery
    align="center"
    caption="My caption"
    height="10rem"
    images="*.jpg"
    justify="center"
    maxwidth="10rem"
    method="resize"
    options="550x webp picture Lanczos"
    type="list"
    width="10rem"
/>}}

{{< paige/gallery >}}
    {{< paige/gallery
        caption="My caption"
        height="10rem"
        image="me.jpg"
        maxwidth="10rem"
        method="resize"
        options="550x webp picture Lanczos"
        raw=false
        width="10rem"
    />}}
    {{< paige/gallery
        caption="My caption"
        height="10rem"
        image="you.jpg"
        maxwidth="10rem"
        method="resize"
        options="550x webp picture Lanczos"
        raw=false
        width="10rem"
    />}}
{{< /paige/gallery >}}

Inner content: Optional. String. HTML. Must be other uses of this shortcode.

Parameters:

align

Optional. String. Cross axis alignment. Must be baseline, center, end, start, or stretch. Must not be used when nested.

caption

Optional. String. Markdown. Descriptive text below the image or images.

height

Optional. String. CSS value. Image height.

image

Optional. String. Page, site, or remote image glob. Only used in the inner content of this shortcode.

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. Must not be used when nested.

maxwidth

Optional. String. CSS value. Maximum image width.

method

Optional. String. Hugo image processing method. Must be crop, fill, fit, or resize. Default is resize. See the methods.

options

Optional. String. Hugo image processing options. Default is 550x webp picture Lanczos. See the options.

raw

Optional. Boolean. Whether to reference an image without copying it. Default is false.

type

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 grid or list. Default is list.

width

Optional. String. CSS value. Image width.

It has the other parameters of the paige/figure shortcode.

Vimeo

The paige/vimeo shortcode provides a responsive Vimeo video.

{{< paige/vimeo
    autopause=true
    autoplay=false
    background=false
    byline=true
    color="00adef"
    controls=true
    description="My description"
    dnt=false
    fullscreen=true
    keyboard=true
    loop=false
    muted=false
    pip=false
    playsinline=true
    portrait=true
    quality="auto"
    speed=false
    texttrack=false
    time="1m2s"
    title=true
    transparent=true
    video="644036051"
>}}

Inner content: None.

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.

keyboard

Optional. Boolean. Enable keyboard input. Default is true.

loop

Optional. Boolean. Loop the video. Default is false.

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.

It has the parameters of the paige/figure shortcode.

See Vimeo documentation for more detail.

YouTube

The paige/youtube shortcode provides a responsive YouTube video.

{{< paige/youtube
    autoplay=false
    controls=true
    end=20
    fullscreen=true
    list=PL2WkvfelorAFjpzGUWc4OWAWmiJpwL97L
    loop=true
    mute=true
    start=10
    title="My title"
    video="dQw4w9WgXcQ"
>}}

Inner content: None.

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.

list

Optional. String. Playlist ID.

loop

Optional. Boolean. Loop the video.

mute

Optional. Boolean. Mute the video.

start

Optional. Integer. Elapsed seconds. Start the video here.

video

Optional. Position 0. String. Video ID.

It has the parameters of the paige/figure shortcode.

Customize

Include

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 these CSS selectors to extend the default styling:

.paige-article

The page article.

.paige-authors

The page authors.

.paige-content

The page content.

.paige-date

The page date.

.paige-date-header

The date headers in list and term layouts.

.paige-description

The page description.

.paige-draft

Applied to the title of draft pages in the list and term layouts.

.paige-expired

Applied to the title of expired pages in the list and term layouts.

.paige-future

Applied to the title of future pages in the list and term layouts.

.paige-home

Appears with .paige-article for a page with kind "home".

.paige-metadata

The page metadata section.

.paige-modified

Applied to the title of modified pages in the list and term layouts.

.paige-page

A page in the pages in the list and term layouts.

.paige-published

Applied to the title of published pages in the list and term layouts.

.paige-quote

On the root element of the `paige/quote` shortcode.

.paige-section

Appears with .paige-article for a page with kind "section".

.paige-single

Appears with .paige-article for a page with kind "page".

.paige-summary

The page summary.

.paige-reading-time

The page reading time.

.paige-taxonomy

Appears with .paige-article for a page with kind "taxonomy".

.paige-term

Appears with .paige-article for a page with kind "term".

.paige-term

A page term.

.paige-terms

The page terms.

.paige-title

The page title.

.paige-toc

The page table of contents.

.paige-unpublished

Applied to the title of unpublished (draft, expired, future) pages in the list and term layouts.

#paige-copyright

The copyright in the footer.

#paige-credit

The credit in the footer.

#paige-footer

The footer element in the container.

#paige-header

The header element in the container.

#paige-main

The main element in the container.

#paige-pages

The page list in the list and term layouts.

#paige-pagination

The pagination links in the list and term layouts.

#paige-root

The outermost element in the body.

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:

.paige-authors,
.paige-date,
.paige-reading-time,
.paige-terms,
.paige-toc,
#paige-credit,
#paige-pages .paige-authors,
#paige-pages .paige-date-header,
#paige-pages .paige-date,
#paige-pages .paige-summary,
#paige-pages .paige-terms {
    display: none;
}

This is used in the example site.

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
• bootstrap-icons
• katex

Hugo names, HTML names, CSS names, and JavaScript names that begin with “paige” capitalized in any way are reserved.

Credits

Photo by Sergey Pesterev.

Project

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

See Also

• Academic
• Piko
• Introduction
• Color Your World
• TailBliss