Compare commits
1 Commits
fc2e1705cd
...
3d8ff4e305
Author | SHA1 | Date |
---|---|---|
Kevin C. Coram | 3d8ff4e305 |
51
README.md
51
README.md
|
@ -6,12 +6,12 @@ adding additional HTML5 semantics, a more responsive site design, and
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
Follow the [Hugo Quickstart](https://gohugo.io/getting-started/quick-start/)
|
Follow the [Hugo Quickstart](https://gohugo.io/getting-started/quick-start/)
|
||||||
instructions on how to install Hugo, create a site, and install a theme.
|
instructions on how to install Hugo, create a site, and install a theme.
|
||||||
Installing the theme as a git submodule is the preferred way.
|
Installing the theme as a git submodule is the preferred way.
|
||||||
|
|
||||||
```
|
```
|
||||||
git add submodule https://git.thecorams.net/kevin/semantic-indieweb.git themes/semantic-indieweb
|
git add submodule https://git.thecorams.net/kevin/semantic-indieweb.git themesemantic-indieweb
|
||||||
```
|
```
|
||||||
|
|
||||||
### Example Site
|
### Example Site
|
||||||
|
@ -24,16 +24,16 @@ cd exampleSite
|
||||||
hugo serve [ -D ] --themesDir ../..
|
hugo serve [ -D ] --themesDir ../..
|
||||||
```
|
```
|
||||||
|
|
||||||
Most of the sample posts are intentionally set `draft: true` to allow for
|
Most of the sample posts are intentionally set `draft: true` to allow for
|
||||||
testing few posts vs many posts.
|
testing few posts vs many posts.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
The footer layout file uses Hugo's `markdownify` pipe to display the `copyright`
|
The footer layout file uses Hugo's `markdownify` pipe to display the `copyright`
|
||||||
configuration setting, providing support both for HTML character escape
|
configuration setting, providing support both for HTML character escape
|
||||||
sequences such as `©` as well as markdwn formatting and links.
|
sequences such as `©` as well as markdwn formatting and links.
|
||||||
|
|
||||||
Note: Hugo versions 0.60.0 and up will have restrictions on using embedded HTML,
|
Note: Hugo versions 0.60.0 and up will have restrictions on using embedded HTML,
|
||||||
including escape secquences, unless the Goldmark renderer is configure with
|
including escape secquences, unless the Goldmark renderer is configure with
|
||||||
`unsafe = true`.
|
`unsafe = true`.
|
||||||
|
|
||||||
|
@ -79,25 +79,25 @@ The current set of known types are:
|
||||||
|
|
||||||
- Email
|
- Email
|
||||||
- The `value` should be a valid e-mail address which could be used for
|
- The `value` should be a valid e-mail address which could be used for
|
||||||
IndieAuth authentication
|
- IndieAuth authentication
|
||||||
- GitHub
|
- GitHub
|
||||||
- The `value` should be a valid GitHub user name
|
- The `value` should be a valid GitHub user name
|
||||||
- GitLab
|
- GitLab
|
||||||
- The `value` should be a valid GitLab user name
|
- The `value` should be a valid GitLab user name
|
||||||
- Twitter
|
- Twitter
|
||||||
- The `value` should be a valid Twitter user name
|
- The `value` should be a valid Twitter user name
|
||||||
- MicroBlog
|
- MicroBlog
|
||||||
- The `value` should be a valid MicroBlog user name
|
- The `value` should be a valid MicroBlog user name
|
||||||
- PGP
|
- PGP
|
||||||
- The `value` should be a valid URL to the site owner's public PGP key
|
- The `value` should be a valid URL to the site owner's public PGP key
|
||||||
|
|
||||||
The IndieAuth standard allows the site author to specify which of the
|
The IndieAuth standard allows the site author to specify which of the
|
||||||
`rel="me"` links should be preferred for authentication. If the `authn`
|
`rel="me"` links should be preferred for authentication. If the `authn`
|
||||||
parameter for an identity is set to `true`, the link will be generated
|
parameter for an identity is set to `true`, the link will be generated
|
||||||
as `rel="me authn"`. As explained on
|
as `rel="me authn"`. As explained on
|
||||||
[https://indielogin.com/setup](https://indielogin.com/setup):
|
[https://indielogin.com/setup](https://indielogin.com/setup)
|
||||||
|
|
||||||
> If any of your `rel="me"` links also include `authn` in the list of rels,
|
> If any of your `rel="me"` links also include `authn` in the list of rels,
|
||||||
> then IndieLogin.com will only use the links with `authn`, and will no longer
|
> then IndieLogin.com will only use the links with `authn`, and will no longer
|
||||||
> consider your plain `rel="me"` links as authentication options.
|
> consider your plain `rel="me"` links as authentication options.
|
||||||
|
|
||||||
|
@ -120,10 +120,10 @@ microformats, for integration with IndieWeb-aware sites and tools.
|
||||||
|
|
||||||
#### Social Network Links
|
#### Social Network Links
|
||||||
|
|
||||||
The theme will render a ribbon of icon links to other sites beneath the
|
In addition to the h-card properties, the theme will render a ribbon of
|
||||||
author's location information. The theme comes bundled with
|
icon links to other sites beneath the author's location information. The theme
|
||||||
[Fork Awesome v1.1.7](https://forkaweso.me/Fork-Awesome/). Any of the icons
|
comes bundled with [Fork Awesome v1.1.7](https://forkaweso.me/Fork-Awesome/).
|
||||||
provided by Fork Awesome can easily be used. For example, to add a link to
|
Any of the icons provided can easily be used. For example, to add a link to
|
||||||
one's Twitter profile, add a configuration block that uses the Fork Awesome
|
one's Twitter profile, add a configuration block that uses the Fork Awesome
|
||||||
twitter icon:
|
twitter icon:
|
||||||
|
|
||||||
|
@ -142,6 +142,7 @@ In addition to the `profile` and `icon` pairs, there is also support for e-mail
|
||||||
links and PGP key file links with the PGP fingerprint as a toolip:
|
links and PGP key file links with the PGP fingerprint as a toolip:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
|
|
||||||
[[params.Social]]
|
[[params.Social]]
|
||||||
email = "email@example.com"
|
email = "email@example.com"
|
||||||
icon = "fa fa-envelope-o"
|
icon = "fa fa-envelope-o"
|
||||||
|
@ -206,7 +207,7 @@ If the content pages use `##` as their largest heading, this will result
|
||||||
in document outlines structured as:
|
in document outlines structured as:
|
||||||
|
|
||||||
1. Site Title
|
1. Site Title
|
||||||
1. Site Sub-title
|
1. Site Sub-title
|
||||||
2. Content Title
|
2. Content Title
|
||||||
1. Header from Content
|
1. Header from Content
|
||||||
1. Sub-header from content
|
1. Sub-header from content
|
||||||
|
@ -214,7 +215,7 @@ in document outlines structured as:
|
||||||
|
|
||||||
### Hugo Templating
|
### Hugo Templating
|
||||||
|
|
||||||
The template layout files make heavy use of Hugo's
|
The template layout files make heavy use of Hugo's
|
||||||
[base and block constructs](https://gohugo.io/templates/base/), as can be seen
|
[base and block constructs](https://gohugo.io/templates/base/), as can be seen
|
||||||
in [baseof.html](layouts/_default/baseof.html).
|
in [baseof.html](layouts/_default/baseof.html).
|
||||||
|
|
||||||
|
@ -229,7 +230,7 @@ page.
|
||||||
#### site-header
|
#### site-header
|
||||||
|
|
||||||
This block is for providing a site banner that will appear at the top of every page,
|
This block is for providing a site banner that will appear at the top of every page,
|
||||||
and matches with the primary `<header>...</header>` definition from the semantic
|
and matches with the primary `<header>...</header>` definition from the semantic
|
||||||
organization, above.
|
organization, above.
|
||||||
|
|
||||||
The default site-header block displays the [header.html](layouts/partials/header.html)
|
The default site-header block displays the [header.html](layouts/partials/header.html)
|
||||||
|
@ -248,8 +249,8 @@ partial.
|
||||||
|
|
||||||
This block is for providing a header for the specific page, matching with the
|
This block is for providing a header for the specific page, matching with the
|
||||||
header block inside the `<main>....<\main>` definition from the semantic
|
header block inside the `<main>....<\main>` definition from the semantic
|
||||||
organization. The [list](layouts/_default/list.html) and
|
organization. The [list](layouts/_default/list.html) and
|
||||||
[single](layouts/_default/single.html) templates display the page title as
|
[single](layouts/_default/single.html) templates display the page title as
|
||||||
a `<h1>...</h1>` level header.
|
a `<h1>...</h1>` level header.
|
||||||
|
|
||||||
#### content-menu
|
#### content-menu
|
||||||
|
@ -271,10 +272,10 @@ rendered inside an `<article>...</article>` block element.
|
||||||
|
|
||||||
#### content-footer
|
#### content-footer
|
||||||
|
|
||||||
This block provides a footer for the page, which renders within the
|
This block provides a footer for the page, which renders within the
|
||||||
`<footer></footer>` block at the end of the `<main></main>` section.
|
`<footer></footer>` block at the end of the `<main></main>` section.
|
||||||
|
|
||||||
The default content-footer blocks for the homepage and for list pages
|
The default content-footer blocks for the homepage and for list pages
|
||||||
implement pagination controls to show the content summaries a page at a time.
|
implement pagination controls to show the content summaries a page at a time.
|
||||||
|
|
||||||
The default content-footer block for single pages displays previous and/or
|
The default content-footer block for single pages displays previous and/or
|
||||||
|
@ -299,4 +300,4 @@ partial.
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
- [Indigo Theme](https://github.com/AngeloStavrow/indigo)
|
- [Indigo Theme](https://github.com/AngeloStavrow/indigo)
|
||||||
- Inspiration for implementation of IndieWeb Identity hooks
|
- Inspiration for implementation of IndieWeb Identity hooks
|
Loading…
Reference in New Issue