Compare commits

..

1 Commits

Author SHA1 Message Date
Kevin C. Coram fc2e1705cd
Document identity, card, and social configurations 2019-12-17 21:13:19 -05:00
1 changed files with 25 additions and 26 deletions

View File

@ -6,12 +6,12 @@ adding additional HTML5 semantics, a more responsive site design, and
## 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.
Installing the theme as a git submodule is the preferred way.
```
git add submodule https://git.thecorams.net/kevin/semantic-indieweb.git themesemantic-indieweb
git add submodule https://git.thecorams.net/kevin/semantic-indieweb.git themes/semantic-indieweb
```
### Example Site
@ -24,16 +24,16 @@ cd exampleSite
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.
## 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
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
`unsafe = true`.
@ -79,25 +79,25 @@ The current set of known types are:
- Email
- The `value` should be a valid e-mail address which could be used for
- IndieAuth authentication
IndieAuth authentication
- GitHub
- The `value` should be a valid GitHub user name
- The `value` should be a valid GitHub user name
- GitLab
- The `value` should be a valid GitLab user name
- The `value` should be a valid GitLab user name
- Twitter
- The `value` should be a valid Twitter user name
- The `value` should be a valid Twitter user name
- MicroBlog
- The `value` should be a valid MicroBlog user name
- The `value` should be a valid MicroBlog user name
- PGP
- 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
`rel="me"` links should be preferred for authentication. If the `authn`
parameter for an identity is set to `true`, the link will be generated
as `rel="me authn"`. As explained on
[https://indielogin.com/setup](https://indielogin.com/setup)
as `rel="me authn"`. As explained on
[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
> 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
In addition to the h-card properties, the theme will render a ribbon of
icon links to other sites beneath the author's location information. The theme
comes bundled with [Fork Awesome v1.1.7](https://forkaweso.me/Fork-Awesome/).
Any of the icons provided can easily be used. For example, to add a link to
The theme will render a ribbon of icon links to other sites beneath the
author's location information. The theme comes bundled with
[Fork Awesome v1.1.7](https://forkaweso.me/Fork-Awesome/). Any of the icons
provided by Fork Awesome can easily be used. For example, to add a link to
one's Twitter profile, add a configuration block that uses the Fork Awesome
twitter icon:
@ -142,7 +142,6 @@ 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:
```toml
[[params.Social]]
email = "email@example.com"
icon = "fa fa-envelope-o"
@ -207,7 +206,7 @@ If the content pages use `##` as their largest heading, this will result
in document outlines structured as:
1. Site Title
1. Site Sub-title
1. Site Sub-title
2. Content Title
1. Header from Content
1. Sub-header from content
@ -215,7 +214,7 @@ in document outlines structured as:
### 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
in [baseof.html](layouts/_default/baseof.html).
@ -230,7 +229,7 @@ page.
#### site-header
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.
The default site-header block displays the [header.html](layouts/partials/header.html)
@ -249,8 +248,8 @@ partial.
This block is for providing a header for the specific page, matching with the
header block inside the `<main>....<\main>` definition from the semantic
organization. The [list](layouts/_default/list.html) and
[single](layouts/_default/single.html) templates display the page title as
organization. The [list](layouts/_default/list.html) and
[single](layouts/_default/single.html) templates display the page title as
a `<h1>...</h1>` level header.
#### content-menu
@ -272,10 +271,10 @@ rendered inside an `<article>...</article>` block element.
#### 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.
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.
The default content-footer block for single pages displays previous and/or
@ -300,4 +299,4 @@ partial.
## Acknowledgements
- [Indigo Theme](https://github.com/AngeloStavrow/indigo)
- Inspiration for implementation of IndieWeb Identity hooks
- Inspiration for implementation of IndieWeb Identity hooks