d3c3nt

commit 630e912922aa747b72163a52df8a14e7d7da7630
parent 32ba41897bb9472ee49429ea6decab696e7f8d1d
Author: FIGBERT <figbert@figbert.com>
Date:   Thu, 23 Dec 2021 16:07:49 -0800

Rewrite config documentation

Diffstat:
M
config.toml
 | 
2
+-
M
content/config.md
 | 
41
+++++++++++++++++++++++++----------------
M
templates/index.html
 | 
2
+-

3 files changed, 27 insertions(+), 18 deletions(-)
diff --git a/config.toml b/config.toml
@@ -21,5 +21,5 @@ minify_html = true
     { name = "CONFIG", path = "/config/" },
   ]
   d3_icon = "/icon.png"
-  d3_twitter = "@therealFIGBERT"
+  d3_twitter = "therealFIGBERT"
   d3_author = "FIGBERT"
diff --git a/content/config.md b/content/config.md
@@ -4,12 +4,16 @@ title = "Docs"
 
 # Configuration
 
+d3c3nt has a number of custom variables you can set in the `[extra]`
+section of your `config.toml` file to personalize the theme for your
+site.
+
 ## Navbar
 
-To customize the navbar, add a `d3_nav` property to your `config.toml`
-in the `[extra]` section. The `d3_nav` variable should be an array of
-objects, which each have `name` and `path` values. `name` will be used
-as the link's text, and `path` will be used as the `href` value.
+To customize the navbar, add a `d3_nav` property. The variable should be
+an array of objects, which each have a `name` and `path` value. `name`
+will be used as the link's text, and `path` will be used as the `href`
+value.
 
 ### Example
 ```toml
@@ -28,13 +32,10 @@ d3_nav = [
 
 ## Favicon
 
-To customize the favicon, add a `d3_icon` property to your `config.toml`
-in the `[extra]` section. The `d3_icon` variable should be a string path
-to an image in the static directory. At the moment the icon generation
-is pretty simple, but this will change in the future to support a more
-[realfavicongenerator.net]-esque approach.
+To customize the favicon, set the `d3_icon` property. The variable
+should be a string path to an image in the static directory.
 
-### Default Config
+### Example
 ```toml
 d3_icon = "/icon.png"
 ```
@@ -45,19 +46,27 @@ d3_icon = "/icon.png"
 
 ## Metadata
 
-To enhance SEO, you can set the `d3_twitter` variable in the `[extra]`
-section of your `config.toml`. The `d3_twitter` variable should be your
-Twitter username (including the "@" symbol), and will be used to set
-meta tags used by Twitter for site previews.
+d3c3nt provides two variables one can set to assert authorship and
+enhance SEO: `d3_author` and `d3_twitter`. `d3_author` should be set to
+your name/handle, and is used in the subheading of posts on your site.
+`d3_twitter` should be set to your Twitter username (not including the
+"@" symbol), and will be used to set meta tags used by Twitter for site
+previews.
 
-### Example Config
+### Example
 ```toml
-d3_twitter = "@therealFIGBERT"
+d3_author = "FIGBERT"
+d3_twitter = "therealFIGBERT"
 ```
 ### Output
 ```html
 <meta name="twitter:card" content="summary">
 <meta name="twitter:creator" content="@therealFIGBERT">
+<!-- ... -->
+<small>
+  <time datetime="2021-12-23">December 23, 2021</time>
+  by <a href="https://figbert.com/">FIGBERT</a>
+</small>
 ```
 
 [realfavicongenerator.net]: https://realfavicongenerator.net/
diff --git a/templates/index.html b/templates/index.html
@@ -14,7 +14,7 @@
     <link rel="canonical" href="{{ current_url | safe }}">
     {% endif -%}
     <meta name="twitter:card" content="summary">
-    <meta name="twitter:creator" content="{{ config.extra.d3_twitter | safe }}">
+    <meta name="twitter:creator" content="@{{ config.extra.d3_twitter | safe }}">
     <link rel="icon" href="/icon.png">
     <meta name="theme-color" content="#1F1E1E">
   </head>