madness 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d325be34cf8419bce877dd6e64707ff678131f334a5be4e7843f24ae097d6ca
-  data.tar.gz: 1009807cc7b9ebf4823029cd2a08c45e77d1c3459ce14417a29845ec15d3548d
+  metadata.gz: f742c5a694675e084935dc8214712d1e8271adef6730e549dc14835dbe8ef136
+  data.tar.gz: 1476f4d96a43079be27d20999ea39e461f1c8f2e55f70b7df666118dae7a77cc
 SHA512:
-  metadata.gz: 64289788a34000cd60f000e753f8d0efd2a71b9f65085640a4e6fdc269e002f5c5845d9dddcb1b77125fb6f821a7c24be936fbada3f4c816de2eb1274035e4c6
-  data.tar.gz: f6410bffc01951f1a1be37a3dd405347842400eae1a432c58566fa5e48ca694e00f77bea1d9e74d4e78191adf047977812deba2f8a7c25c0ca8bd683e7e64af3
+  metadata.gz: 00d6ace507d19b54ddeed6b197f0b8e235dde719a1ec566ee72c1e080020b6d0f7b8f9b173c47595ab16926d0ebee118514bf5b64e6e26dbfda38209c3d392a9
+  data.tar.gz: ed669abcde052caca2bfbdca9e8e86d62db1f6b52732ca0d486d1690cb63871370acc30e119d85e5cebceece6e3bb4d77dae445416568334d1d1288dc1e4106b

data/README.md

@@ -51,6 +51,7 @@ $ alias madness='docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness
 - Can optionally show additional file types in the navigation menu (e.g. PDF
   files).
 - Optional support for `[[Short Link]]` syntax.
+- Optional support for Mermaid diagrams.
 - Optional basic authentication.
 - Support for extended markdown syntax, such as footnotes and syntax
   highlighting.
@@ -153,6 +154,10 @@ auto_toc: true
 # enable syntax highlighter for code snippets
 highlighter: true
 
+# enable mermaid diagramming and charting
+# put your diagram code inside <div class='mermaid'>...</div>
+mermaid: false
+
 # enable the copy to clipboard icon for code snippets
 copy_code: true
 
@@ -258,12 +263,24 @@ specifying internal links, where `[[Anything]]` will be converted to
 `[Anything](Anything)`, which will then be rendered as an internal link to a
 file or a directory in the same directory as the file itself.
 
+### Mermaid Diagrams and Charts
+
+When the `mermaid` option is enabled, you may display any mermaid diagram in
+your document by enclosing it in a `<div class='mermaid'>...</div>` block.
+
 ### Table of Contents Generation
 
 #### Site-wide
 
 To generate a Table of Contents file for the entire site (for the directories
-and files), run `madness --toc FILENAME`
+and files), add something like this to your `.madness.yml` file:
+
+```yaml
+toc: Table of Contents.md
+```
+
+This directive will (re)generate the specified file whenever you start the
+server.
 
 #### In-page