madness 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5790a84273b260c95800d1497ce38a0d5e7f2eabe77b8231309ebf70eb7acb4
-  data.tar.gz: 013d8d7b8dd741bc5a03092c58c6326caa2cdf6c82b001be4755615e6184439b
+  metadata.gz: 7ae3cdf3ac2b5f6b10c753eea82d7d1582638dbe9cd07d74a3b9dae1538d71ec
+  data.tar.gz: 28ad6247d60993951bcdc8523ceffec325db4ec03d9d2fcf3bc39148a4af7660
 SHA512:
-  metadata.gz: 942b0408a4ef4e85630703cd31a0c1b0c9d4a5695db685d612cd4280dc01282e725b63629b006dd41abf1ec198ac13df34370444820ea00bdf67c0ffe9c686b4
-  data.tar.gz: 1d0c07859780758c0ea6211ac6f0f62662f49be96adf2d083aba88703148b69e0979caeea5ca47351b5aa775310172533d74ccdb82566013fbd137172de22d9b
+  metadata.gz: a56ccf5bd4beb475f1a1b4d1ccbdc4b35fb22bfb472d9b538316b66263c5c3fc26a7ab2f2154ae43701ea3325dfd10ba5efe59344da7164c57ff543bd072d157
+  data.tar.gz: 3b666bcc03cce4e6b93fd1178811cedbc94d36f8caf00f2d38a9e34deebbbf9ad17d30b92522d54968cb49b8c9148ae2740216f7c1ed0a6ae5aa3174d7baccbc

data/README.md

@@ -2,6 +2,8 @@
 
 # Madness - Instant Markdown Server
 
+![repocard](https://repocard.dannyben.com/svg/madness.svg)
+
 Madness is a command line server for rendering markdown documents in your
 browser. It is designed to facilitate easy development of internal
 markdown-based documentation sites.
@@ -40,6 +42,7 @@ $ alias madness='docker run --rm -it -v $PWD:/docs -p 3000:3000 dannyben/madness
 - Compatible with how markdown files are displayed on GitHub and GitHub pages.
 - Configure with a configuration file or command arguments.
 - Fully customizable theme.
+- Built-in light and dark theme support.
 - Automatic generation of navigation sidebar.
 - Automatic generation of Table of Contents (site-wide and per page).
 - Can optionally show additional file types in the navigation menu (e.g. PDF
@@ -134,6 +137,11 @@ sort_order: dirs_first
 # enable sidebar
 sidebar: true
 
+# render the sidebar as a recursive tree of the entire docroot, with
+# collapsible folders. when false, the sidebar shows only the current
+# folder's immediate children.
+nav_tree: false
+
 # add H1 title to files that do not have one
 auto_h1: true
 
@@ -149,8 +157,8 @@ auto_toc: true
 highlighter: true
 
 # enable mermaid diagramming and charting
-# put your diagram code inside <div class='mermaid'>...</div>
-mermaid: false
+# put your diagram code inside ```mermaid ... ``` code fence
+mermaid: true
 
 # enable the copy to clipboard icon for code snippets
 copy_code: true
@@ -224,6 +232,16 @@ For example, for a directory named "API Documentation":
 
 Madness comes with a full text search page.
 
+### Navigation Tree
+
+By default, the sidebar shows the current folder's immediate children. To render
+the sidebar as a recursive tree of the entire documentation root, enable the
+`nav_tree` option:
+
+```yaml
+nav_tree: true
+```
+
 ### Images and Static Files
 
 You can put images and other asset files anywhere in your documentation
@@ -264,19 +282,7 @@ file or a directory in the same directory as the file itself.
 When the `mermaid` option is enabled, you can embed Mermaid diagrams in your
 document using either of the following methods:
 
-1. **Using a `<div>` block with `mermaid` class**:
-
-   ```html
-   <div class="mermaid">
-     graph TD;
-     A-->B;
-     A-->C;
-     B-->D;
-     C-->D;
-   </div>
-   ```
-
-2. **Using a code fence with `mermaid` language specifier**:
+**Using a code fence with `mermaid` language specifier**:
 
    ````markdown
    ```mermaid
@@ -287,6 +293,18 @@ document using either of the following methods:
    C-->D;
    ```
    ````
+   
+**Using a `<div>` block with `mermaid` class**:
+
+   ```html
+   <div class="mermaid">
+     graph TD;
+     A-->B;
+     A-->C;
+     B-->D;
+     C-->D;
+   </div>
+   ```
 
 ### Table of Contents Generation
 
@@ -377,6 +395,11 @@ auth: <%= ENV['BASIC_AUTH'] %>
 
 There are three ways to change how Madness looks. 
 
+The built-in theme supports light and dark color schemes. It follows the
+browser or operating system preference by default, and readers can use the theme
+toggle to switch between light and dark. The selected preference is stored in
+the browser for future visits.
+
 ### Option 1: CSS Overrides
 
 Any CSS file found in the `./css` directory of your documentation root will 
@@ -470,4 +493,3 @@ For more information about the docker image, see:
 [dockerfile]: https://github.com/DannyBen/madness/blob/master/Dockerfile
 [css]: https://github.com/DannyBen/madness/blob/master/app/public/css/main.css
 [sasstool]: https://github.com/DannyBen/sasstool
-