Compare commits

..

1 Commits

Author SHA1 Message Date
Kevin C. Coram 3d8ff4e305
Document identity, card, and social configurations 2019-12-14 17:42:11 -05:00
1 changed files with 26 additions and 25 deletions

View File

@ -11,7 +11,7 @@ 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
@ -79,7 +79,7 @@ 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
@ -95,7 +95,7 @@ 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
@ -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"