Document identity, card, and social configurations

README.md

@@ -1,10 +1,8 @@
-# A Basic Hugo Theme
+# A Hugo Theme Using HTML5 Semantics and IndieWeb Integration
 
-While the official documentation about Hugo [Templates](https://gohugo.io/templates/) 
+This theme is a fork of [My Basic Theme](https://git.thecorams.net/kevin/basic-theme),
-does provide all of the pieces to get started creating a theme, it doesn't
+adding additional HTML5 semantics, a more responsive site design, and
-necessarily put them together in one, easy-to-see-together place. This theme
+[IndieWeb](https://indieweb.org/) [microformats](http://microformats.org/wiki/Main_Page).
-attempts to pull all of the necessary pieces together into a theme that can be
-used as a starting point to create more sophisticated themes.
 
 ## Getting Started
 
@@ -13,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.
 
 ```
-git add submodule https://git.thecorams.net/kevin/basic-theme.git themes/basic-theme
+git add submodule https://git.thecorams.net/kevin/semantic-indieweb.git themes/semantic-indieweb
 ```
 
 ### Example Site
@@ -31,9 +29,6 @@ testing few posts vs many posts.
 
 ## Configuration
 
-As a very basic theme, there is very little to be configured via the `config.toml` 
-file.
-
 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.
@@ -63,6 +58,100 @@ homepage.
 
 ```
 
+### IndieWeb / IndieAuth Identities
+
+The theme includes support for adding `rel="me"` links to the HTML head of
+every page. Such links help tie together the sites one owns, as well as
+provide support for [IndieAuth](https://www.w3.org/TR/indieauth/)
+authentication.
+
+These links can be configured by including one or more `params.Identity`
+blocks:
+
+```toml
+  [[params.Identity]]
+    type = "some-type"
+    value = "identity"
+    authn = false
+```
+
+The current set of known types are:
+
+- Email
+  - The `value` should be a valid e-mail address which could be used for
+    IndieAuth authentication
+- GitHub
+  - The `value` should be a valid GitHub user name
+- GitLab
+  - The `value` should be a valid GitLab user name
+- Twitter
+  - The `value` should be a valid Twitter user name
+- MicroBlog
+  - 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):
+
+> 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.
+
+### IndieWeb h-card
+
+The theme includes a "card" for displaying the site author's photo (or a logo
+image for the site), the author's name, and the author's rough location. The
+data in the card is marked up with [h-card](http://microformats.org/wiki/h-card)
+microformats, for integration with IndieWeb-aware sites and tools.
+
+```toml
+  # Configuration Parameters for IndieWeb h-card
+  [params.Card]
+    Author = "Site Author Name"
+    Photo = "images/picture-o.svg"
+    Locality = "City/Town/Village"
+    Region = "State/County/Province"
+    Country = "Country Name"
+```
+
+#### Social Network Links
+
+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:
+
+```toml
+  [[params.Social]]
+    profile = "https://twitter.com/twitter-user-name"
+    icon = "fa fa-twitter"
+```
+
+The icon/font library being used can be overriden by creating a site-specific
+`icons.html` partial. Font Awesome, Fork Awesome, Fontello, and many other
+icon/font libraries all support embedding an icon using similar CSS class names,
+which can be used in the `icon = "...."` configuration.
+
+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"
+
+  [[params.Social]]
+    publicKey = "pgp_key_file.txt"
+    fingerprint = "AAAA BBBB CCCC DDDD"
+    icon = "fa fa-key"
+```
+
 ## Theme Organization
 
 ### Semantic Content Organization