You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
134 lines
4.2 KiB
Markdown
134 lines
4.2 KiB
Markdown
# paige
|
|
|
|
A simple Hugo theme. [Try it out.](https://willfaught.com/paige)
|
|
|
|
## Screenshots
|
|
|
|
Home page:
|
|
|
|
<img src="https://github.com/willfaught/paige/raw/master/images/home1.jpg">
|
|
|
|
<img src="https://github.com/willfaught/paige/raw/master/images/home2.jpg">
|
|
|
|
Single page:
|
|
|
|
<img src="https://github.com/willfaught/paige/raw/master/images/single.jpg">
|
|
|
|
List page:
|
|
|
|
<img src="https://github.com/willfaught/paige/raw/master/images/list.jpg">
|
|
|
|
Taxonomy page:
|
|
|
|
<img src="https://github.com/willfaught/paige/raw/master/images/taxonomy.jpg">
|
|
|
|
Term page:
|
|
|
|
<img src="https://github.com/willfaught/paige/raw/master/images/term.jpg">
|
|
|
|
404 page:
|
|
|
|
<img src="https://github.com/willfaught/paige/raw/master/images/404.jpg">
|
|
|
|
Search page:
|
|
|
|
<img src="https://github.com/willfaught/paige/raw/master/images/search.jpg">
|
|
|
|
## Features
|
|
|
|
- Accessibility
|
|
- Blog
|
|
- Bootstrap
|
|
- Customizable
|
|
- Facebook sharing
|
|
- Google Analytics
|
|
- Header links
|
|
- Landing page
|
|
- Light color scheme
|
|
- Math typesetting
|
|
- Menus
|
|
- Minimal design
|
|
- RSS with full content
|
|
- Responsive
|
|
- Safari and Firefox Reader View support
|
|
- Search
|
|
- Sections
|
|
- Single column
|
|
- Social links
|
|
- Twitter sharing
|
|
|
|
## Design
|
|
|
|
The HTML author is the site author.
|
|
|
|
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. If both are the same for the home page, the title is the page
|
|
title.
|
|
|
|
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;
|
|
and the page date, if any. The body has the page content, if any. The
|
|
footer has the copyright notice, if any.
|
|
|
|
A menu item is highlighted if its path is a prefix of the path of the
|
|
current page. For example, the menu item path `/foo/` matches the pages
|
|
`content/foo/_index.md`, `content/foo/bar.md`, and
|
|
`content/foo/bar/_index.md`. The menu item path `/` only matches the
|
|
page `content/_index.md`.
|
|
|
|
The menu is configured with `menu.main` in `config.yaml`.
|
|
|
|
To show full pages instead of just the page title and description in a
|
|
list page, set the list page parameter `paigeshowfullpages` to true.
|
|
|
|
The page date is the publish date, if any; otherwise, it's the creation
|
|
date. To change the date format displayed, set the site parameter
|
|
`paigedateformat` to a Hugo date format.
|
|
|
|
The home page body has the `stretch`, `center`, `greeting`, and `blurb`
|
|
parameters from `content/_index.md`, if any; the page content, if any;
|
|
and linked icons for the social sites configured in `config.yaml`, if
|
|
any. `stretch` is an image that is stretched fully horizontally with
|
|
`background-position: center` and `background-size: cover`. `center` is
|
|
an image that is centered.
|
|
|
|
Single pages use the `link` page parameter, if any, as the reference for
|
|
an anchor around the page title, if any. If the page or site parameter
|
|
`math` is set to true, math typesetting is enabled with KaTeX.
|
|
|
|
The `paige-search` layout provides full site search. It requires setting
|
|
`outputs.home` to `["html", "json", "rss"]` in `config.yaml`.
|
|
|
|
Set page parameter `excluderss` to true to exclude it from RSS. Doing so
|
|
for a list page excludes the entire directory.
|
|
|
|
Set page parameter `excludesearch` to true to exclude it from search.
|
|
|
|
If `partials/paige-head-last.html` exists in the site, it is included at
|
|
the end of the head tag. If `partials/paige-body-last.html` exists in
|
|
the site, it is included at the end of the body tag.
|
|
|
|
To hide the theme link, set the site parameter `paigehidethemelink` to
|
|
true. To hide the theme comment, set the site parameter
|
|
`paigehidethemecomment` to true. If you hide either of these, please
|
|
credit this project in a post so others may find it.
|
|
|
|
Bootstrap 5.2.2 CSS and JavaScript and Bootstrap Icons 1.10.2 are loaded
|
|
from the Bootstrap CDN for every page. To load local assets instead, set
|
|
the site parameters `paigebootstrapcss`, `paigebootstrapicons`, and
|
|
`paigebootstrapjs` to the asset paths.
|
|
|
|
## Configuration
|
|
|
|
See the example site directory for an example configuration.
|
|
|
|
## Credits
|
|
|
|
- Center photo by [Yuvraj Singh](https://unsplash.com/photos/ljziSm0DXg8)
|
|
- Stretch photo by [Sergey Pesterev](https://unsplash.com/photos/JV78PVf3gGI)
|