Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mikeblum/hugo-now.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormblum <me@mblum.me>2017-07-06 09:56:14 +0300
committermblum <me@mblum.me>2017-07-07 08:27:52 +0300
commit8ecb6bdf9375d4f8f7d9109c3f48ef9f9652d378 (patch)
tree75618429d6d0ea14ff4ad0c7bfd6401c79df7e83 /README.md
parentb39b3ef0528c81dd09076f33c5026584bd5c766b (diff)
[TOC] Posts and _default single layouts now have a table-of-contents.html partial that parses .Content for headers
[TOC] Table of Contents can be disabled / enabled with `toc`: `true / false` [BANNER] images at the tops of posts are now in a partial and configured with `banner:` [{ `src`: , `alt`: }]
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/README.md b/README.md
index 5e1329d..6d9b2a5 100644
--- a/README.md
+++ b/README.md
@@ -28,6 +28,14 @@ A Hugo port of [Jekyll Now](https://github.com/barryclark/jekyll-now). The Hugo
<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/screenshots/project.png" alt="dashboard"></img>
+---
+
+### Table of Contents
+
+<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/screenshots/table-of-contents.png" alt="table of contents"></img>
+
+---
+
## Features
<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/bootstrap-solid.png" alt="bootstrap 4" width="120px" height="120px"></img>
@@ -40,7 +48,6 @@ Update from Bootstrap 3 to 4
<h3 class="mt-0">Font Awesome</h3>
Latest Font Awesome icons
-:no_good:
<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/javascript.png" alt="no javascript" width="120px" height="120px"></img>
<h3 class="mt-0">Progrssive Enhancement</h3>
@@ -67,6 +74,7 @@ Available for:
- :white_check_mark: posts / .Content
+
<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/pygments-logo.png" alt="pygments" width="120px" height="120px"></img>
<h3 class="mt-0">Syntax Highlighting</h3>
@@ -81,9 +89,21 @@ I would argue site usability / robustness far out weighs build times.
<img src="https://raw.githubusercontent.com/mikeblum/hugo-now/master/static/images/google-analytics.png" alt="google analytics" width="120px" height="120px"></img>
<h3 class="mt-0">Google Analytics</h3>
-Configure Google Analytics with:
+Configure Google Analytics with `GoogleAnalytics`
- .Params.GoogleAnalytics
+<h3 class="mt-0">Table of Contents</h3>
+<h4>Headings are resolved into a styleable Table of Contents</h4>
+
+Enabled via `toc` in your front matter:
+
+```
+toc: true
+```
+
+* true = show table of contents
+* false = hide table of contents
+
+---
## Install