diff --git a/README.md b/README.md index aa464989..5de6dfdb 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,11 @@ A simple Hugo theme. [Try it out.](https://willfaught.com/paige) ## Design -HTML metadata is embedded automatically. The HTML author is the site -author. The HTML description is the page description. The HTML keywords -is a sorted union of the page keywords, tags, and categories. Enhanced -Facebook and Twitter sharing is enabled. Google Analytics is included at -the bottom of the body, if configured. You must create favicons -yourself. +HTML metadata is set automatically. 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. Enhanced Facebook and +Twitter sharing is enabled. Google Analytics is included at the bottom +of the body, if configured. You must create favicons yourself. 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 @@ -37,41 +36,41 @@ the section menus, 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 site copyright notice, if any. -The page date is the publish date, if it exists; otherwise, it's the -creation date. - -Everything is stacked vertically in one column and aligned to the -center. - -List page items are the page title with the page description underneath, -grouped by month and year, and sorted in descending order. Page list -length is configured in `config.yaml`. - -The section menus in the header are activated if their section matches -the current page. Pages directly under `content` match the section path -`/`. The section menu names, paths, and order are configured in +The section menus are activated if their path matches the current page. +Pages in the directory `content/` match the section path `/`. Pages in +the directory `content/foo/` match the section path `/foo/`. The section +menu identifiers, names, weights, paths, and order are configured in `config.yaml`. -If a page has a `link` parameter, it's used as the reference for an -anchor around the page title, if any. +The page date is the publish date, if any; otherwise, it's the creation +date. -If `partials/head.html` exists in the site, it is included at the end of -the head tag. If `partials/body.html` exists in the site, it is included -at the end of the body tag. +Everything is stacked vertically in one column and aligned to the +center. The home page shows the `blurb`, `description`, `greeting`, and `title` parameters from `content/_index.md`, the `avatar.png` and `cover.png` images at the site root, and linked icons for all the social sites configured in `config.yaml`. -Taxonomy pages are an inline, unordered, sorted list of links to terms. +Single pages use the `link` front matter parameter, if any, as the +reference for an anchor around the page title, if any. + +List and term pages show page titles and descriptions per month and year +in descending order. An empty list has a "Nothing Here" header, and no +body. + +Taxonomy pages list term links in an inline, unordered, sorted list. The 404 page has a "Not Found" header, and no body. -An empty list has a "Nothing Here" header, and no body. +If `partials/head.html` exists in the site, it is included at the end of +the head tag. If `partials/body.html` exists in the site, it is included +at the end of the body tag. -Stock Bootstrap 5.2.2 and Bootstrap Icons 1.10.2 are used for style and -icons. They're loaded from the Bootstrap CDN for every page. +Stock Bootstrap 5.2.2 CSS and JavaScript, and Bootstrap Icons 1.10.2, +are used for style, functionality, and icons. They're loaded from the +Bootstrap CDN for every page. ## Configuration