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.

Welcome to the last Hugo theme you'll probably ever need.

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

Get started with Hugo

1. Install Hugo.

   For Homebrew on Mac:

   $ brew install hugo
   

2. Create a site:

   $ hugo new site yourproject
   

3. 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 server -D

Configure

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

paige:
  analytics:
    chartbeat: # chartbeat.com
      account_id: "123456"
      domain: "example.com"
    clicky: # clicky.com
      account_id: "123456"
    fathom: # usefathom.com
      account_id: "123456"
    finteza: # finteza.com
      account_id: "123456"
      script_url: "https://example.com/script.js"
    hotjar: # hotjar.com
      account_id: "123456"
    matomo: # matomo.org
      account_id: "123456"
      host_url: "https://example.com"
    mixpanel: # mixpanel.com
      token: "123456"
    plausible: # plausible.io
      account_id: "123456"
    woopra: # woopra.com
      domain: "example.com"
    yandex: # metrica.yandex.com
      account_id: "123456"
  bootstrap:
    icons:
      link_href: "https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.2/font/bootstrap-icons.css" # Local or remote file
      link_integrity: "sha384-b6lVK+yci+bfDmaY1u0zE8YYJt0TZxLEAFyYSLHId4xoVvsrQu3INevFKo+Xir8e" # File integrity hash
    script:
      raw: false # Do not copy or process the file; default is false
      script_integrity: "sha384-OERcA2EqjJCMA+/3y+gxIOqMEjwtxJY7qPCqsdltbNJuaOe923+mo//f6V8Qbsw3" # File integrity hash
      script_src: "https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/js/bootstrap.bundle.min.js" # Local or remote file
    style:
      link_href: "https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/css/bootstrap.min.css" # Local or remote file
      link_integrity: "sha384-Zenh87qX5JnK2Jl0vWa8Ck2rdkQ2Bzep5IDxbcnCeuOxjzrPF/et3URy9Bv1WTRi" # File integrity hash
      raw: false # Do not copy or process the file; default is false
  color: "#123456" # Theme color for Safari and Windows; default is "#0d6efd"
  color_scheme: "light" # Use the "light" or "dark" color scheme without automatic switching; default is ""
  comments:
    cactus: # cactus.chat
      account_id: "123456"
    commento: # commento.io
      script_url: "https://example.com/script.js"
    hyvor: # hyvor.com
      account_id: "123456"
    intensedebate: # intensedebate.com
      account_id: "123456"
    isso: # isso-comments.de
      script_url: "https://example.com/script.js"
    remark42: # remark42.com
      host_url: "https://example.com"
      site_id: "123456"
    replybox: # getreplybox.com
      account_id: "123456"
    utterances: # utteranc.es
      github_repo: "example/foo"
  home:
    blurb: "There's a new daddy in town." # Displayed below the greeting; default is ""
    greeting: "You know best" # Displayed below the image; default is ""
    image:
      raw: false # Do not copy or process the file; default is false
      stretch: false # Stretch the image fully horizontally if true; center the image otherwise; default is false
      url: "me.jpg" # A page, site, or remote resource glob; default is ""
  credit:
    data:
      hide: false # Don't credit this project in a data attribute; default is false
    link:
      hide: false # Don't credit this project in the footer; default is false
  katex:
    autorender:
      raw: false # Do not copy or process the file; default is false
      script_integrity: "sha384-+VBxd3r6XgURycqtZ117nYw44OOcIax56Z4dCRWbxyPt0Koah1uHoK0o4+/RRE05" # File integrity hash
      script_src: "https://cdn.jsdelivr.net/npm/katex@0.16.3/dist/contrib/auto-render.min.js" # Local or remote file
    script:
      raw: false # Do not copy or process the file; default is false
      script_integrity: "sha384-97gW6UIJxnlKemYavrqDHSX3SiygeOwIZhwyOKRfSaf0JWKRVj9hLASHgFTzT+0O" # File integrity hash
      script_src: "https://cdn.jsdelivr.net/npm/katex@0.16.3/dist/katex.min.js" # Local or remote file
    style:
      link_href: "https://cdn.jsdelivr.net/npm/katex@0.16.3/dist/katex.min.css" # Local or remote file
      link_integrity: "sha384-Juol1FqnotbkyZUT5Z7gUPjQ9gzlwCENvUZTpQBAPxtusdwFLRy382PSDx5UUJ4/" # File integrity hash
  list:
    authors:
      class: "mb-0 text-center text-secondary" # Default is "mb-0 text-center text-secondary"
      hide: false # Default is false
    content:
      show: false # Default is false
    date:
      class: "mb-0 text-center text-secondary" # Default is "mb-0 text-center text-secondary"
      format: ":date_long" # Default is ":date_long"
      hide: false # Default is false
    date_header:
      class: "h5 text-center" # Month and year header class attribute
      hide: false # Default is false
    description:
      class: "mb-0 text-center" # Default is "mb-0 text-center"
      hide: false # Default is false
    reading_time:
      class: "mb-0 text-center text-secondary" # Default is "mb-0 text-center text-secondary"
      hide: false # Default is false
    section:
      class: "mb-3 w-100" # Default is "mb-3 w-100"
    summary:
      class: "fst-italic mb-0 text-center" # Default is "fst-italic mb-0 text-center"
      hide: false # Default is false
    terms:
      hide: false # Default is false
      inner_class: "badge text-bg-secondary text-decoration-none" # Default is "badge text-bg-secondary text-decoration-none"
      outer_class: "mb-0 text-center" # Default is "mb-0 text-center"
    title:
      class: "mb-0 text-center" # Default is "mb-0 text-center"
      hide: false # Default is false
  math: false # Enable math typesetting; default is false
  header:
    menu:
      breakpoint: "sm" # Bootstrap breakpoint at which to display all menu items; default is "sm"
      style: "pills" # Menu item style; must be "links" or "pills"; default is "pills"
  main:
    metadata:
      authors:
        class: "text-center text-secondary" # Default is "text-center text-secondary"
        hide: false # Default is false
      date:
        class: "text-center text-secondary" # Default is "text-center text-secondary"
        format: ":date_long" # Default is ":date_long"
        hide: false # Default is false
      description:
        class: "lead text-center" # Default is "lead text-center"
        hide: false # Default is false
      max_width: "100ch" # Default is ""
      reading_time:
        class: "text-center text-secondary" # Default is "text-center text-secondary"
        hide: false # Default is false
      section:
        class: "paige-metadata w-100" # Default is "paige-metadata w-100"
      terms:
        hide: false # Default is false
        inner_class: "badge text-bg-secondary text-decoration-none" # Default is "badge text-bg-secondary text-decoration-none"
        outer_class: "text-center" # Default is "text-center"
      title:
        class: "display-5 fw-bold text-center" # Default is "display-5 fw-bold text-center"
        hide: false # Default is false
    table_of_contents:
      class: "border mb-3 pe-3 ps-3 pt-3 rounded" # Default is "border mb-3 pe-3 ps-3 pt-3 rounded"
      hide: false # Default is false
      max_width: "66ch" # Default is ""
    content:
      class: "mw-100 paige-content" # Default is "mw-100 paige-content"
      hide: false # Default is false
      max_width: "66ch" # Default is ""
  rss:
    hide_page: false # Default is false
    managing_editor: "Michael Bluth" # Default is ""
    web_master: "Michael Bluth" # Default is ""
  search:
    hide_page: false # Default is false
  social:
    examplesite:
      bootstrap_icon: example-icon
      name: Example
      url: https://example.com/username

If you set hide_credit_data or hide_credit_link, please credit this project in a post to help others find it.

Optional site parameters:

authors:
  michael_bluth:
    name: "Michael Bluth"
    default: true # Credit this author in pages that have no authors parameter
  george_bluth:
    name: "George Bluth"

Optional page parameters:

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

Layouts

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"
    maxheight="10rem"
    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.

maxheight

Optional. String. CSS value. Maximum total height.

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:

It has the parameters of the paige/figure shortcode.

Code

The paige/code shortcode provides a figure with code.

{{< paige/code
    caption="My caption"
    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:

caption

Optional. String. Markdown. Descriptive text below the code.

lang

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

options

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

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

Image

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

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

Inner content: None.

Parameters:

alt

Optional. String. Plain text. Image alt.

caption

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

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.

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

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"
    maxheight="10rem"
    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"
        maxheight="10rem"
        maxwidth="10rem"
        method="resize"
        options="550x webp picture Lanczos"
        raw=false
        width="10rem"
    />}}
    {{< paige/gallery
        caption="My caption"
        height="10rem"
        image="you.jpg"
        maxheight="10rem"
        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.

maxheight

Optional. String. CSS value. Maximum image height.

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.

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.

Customize

Include

If this file exists in the site	It is included at
partials/paige/body-first.html	The beginning of the body tag
partials/paige/body-last.html	The end of the body tag
partials/paige/footer-first.html	The beginning of the footer tag
partials/paige/footer-last.html	The end of the footer tag
partials/paige/head-first.html	The beginning of the head tag
partials/paige/head-last.html	The end of the head tag
partials/paige/header-first.html	The beginning of the header tag
partials/paige/header-last.html	The end of the header tag
partials/paige/main-first.html	The beginning of the main tag
partials/paige/main-last.html	The end of the main tag

Override

Most code is in partial templates that are included by the default layouts. Elements can be added, changed, or removed easily by overriding the corresponding default layout or partial template.

For example, the default layouts home.html, list.html, single.html, taxonomy.html, and term.html include the partial template paige/article.html. paige/article.html includes the partial templates paige/metadata.html, paige/toc.html, and paige/content.html. To change the page title for those default 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.

Define

These optional CSS classes can be defined how you want:

.paige-draft

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

.paige-expired

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

.paige-future

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

.paige-modified

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

.paige-published

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

.paige-unpublished

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

Design

The HTML author is the page authors, if any.

The HTML description is the page description, if any.

The HTML keywords is a union of the page keywords, tags, and categories, if any.

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, if any, or the site title otherwise.

The HTML body can have a header, a body, and a footer. The header has the menu, if any; the page title, if any; the page description, if any; the page authors, if any; and the page date, if any. The body has the page content, if any. The footer has the copyright notice, if any; and the theme link, if any.

The page 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, if any.

Implementation

Bootstrap 5.3.0-alpha1 CSS and JavaScript and Bootstrap Icons 1.10.3 are used unless overridden.

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

Community

Get started by starring and following the project.

If you find a problem or have a suggestion, please share it by creating an issue. Feedback is encouraged and appreciated.

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

Credits

Photo by Sergey Pesterev.

Project

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