Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,8 +149,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
Expand Down Expand Up @@ -264,18 +264,6 @@ 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:

**Using a `<div>` block with `mermaid` class**:

```html
<div class="mermaid">
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
</div>
```

**Using a code fence with `mermaid` language specifier**:

````markdown
Expand All @@ -287,6 +275,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

Expand Down
2 changes: 1 addition & 1 deletion lib/madness/settings.rb
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def defaults
auto_nav: true,
auto_toc: true,
highlighter: true,
mermaid: false,
mermaid: true,
copy_code: true,
shortlinks: false,
source_link: nil,
Expand Down
4 changes: 2 additions & 2 deletions lib/madness/templates/madness.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,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
Expand Down
22 changes: 11 additions & 11 deletions site/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,8 @@ <h2 id="configuration-file">Configuration File</h2>
<span class="na">highlighter</span><span class="pi">:</span> <span class="kc">true</span>

<span class="c1"># enable mermaid diagramming and charting</span>
<span class="c1"># put your diagram code inside &lt;div class='mermaid'&gt;...&lt;/div&gt;</span>
<span class="na">mermaid</span><span class="pi">:</span> <span class="kc">false</span>
<span class="c1"># put your diagram code inside ```mermaid ... ``` code fence</span>
<span class="na">mermaid</span><span class="pi">:</span> <span class="kc">true</span>

<span class="c1"># enable the copy to clipboard icon for code snippets</span>
<span class="na">copy_code</span><span class="pi">:</span> <span class="kc">true</span>
Expand Down Expand Up @@ -284,15 +284,6 @@ <h3 id="mermaid-diagrams-and-charts">Mermaid Diagrams and Charts</h3>
<p>When the <code>mermaid</code> option is enabled, you can embed Mermaid diagrams in your
document using either of the following methods:</p>

<p><strong>Using a <code>&lt;div&gt;</code> block with <code>mermaid</code> class</strong>:</p>
<div class="highlight"><pre class="highlight html"><code> <span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">"mermaid"</span><span class="nt">&gt;</span>
graph TD;
A--&gt;B;
A--&gt;C;
B--&gt;D;
C--&gt;D;
<span class="nt">&lt;/div&gt;</span>
</code></pre></div>
<p><strong>Using a code fence with <code>mermaid</code> language specifier</strong>:</p>
<div class="highlight"><pre class="highlight markdown"><code> <span class="p">```</span><span class="nl">mermaid
</span><span class="sb"> graph TD;
Expand All @@ -302,6 +293,15 @@ <h3 id="mermaid-diagrams-and-charts">Mermaid Diagrams and Charts</h3>
C--&gt;D;</span>
<span class="p">```</span>
</code></pre></div>
<p><strong>Using a <code>&lt;div&gt;</code> block with <code>mermaid</code> class</strong>:</p>
<div class="highlight"><pre class="highlight html"><code> <span class="nt">&lt;div</span> <span class="na">class=</span><span class="s">"mermaid"</span><span class="nt">&gt;</span>
graph TD;
A--&gt;B;
A--&gt;C;
B--&gt;D;
C--&gt;D;
<span class="nt">&lt;/div&gt;</span>
</code></pre></div>
<h3 id="table-of-contents-generation">Table of Contents Generation</h3>

<h4 id="site-wide">Site-wide</h4>
Expand Down
2 changes: 1 addition & 1 deletion spec/approvals/cli/config/show
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
auto_nav: true
auto_toc: true
highlighter: true
mermaid: ~
mermaid: true
copy_code: true
shortlinks: ~
source_link: ~
Expand Down
2 changes: 1 addition & 1 deletion spec/approvals/cli/config/show-non-default
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
auto_nav: true
auto_toc: true
highlighter: true
mermaid: ~
mermaid: true
copy_code: true
shortlinks: ~
source_link: ~
Expand Down
24 changes: 10 additions & 14 deletions spec/approvals/render/all-disabled
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ with <strong>markdown support</strong> in it</p>
</blockquote>

<p>Inline <code>code_word</code> and block code:</p>

<pre><code class="ruby">def say(message = &quot;Hi&quot;)
puts message
end
</code></pre>

<div class="highlight"><pre class="highlight ruby"><code><span class="k">def</span> <span class="nf">say</span><span class="p">(</span><span class="n">message</span> <span class="o">=</span> <span class="s2">"Hi"</span><span class="p">)</span>
<span class="nb">puts</span> <span class="n">message</span>
<span class="k">end</span>
</code></pre></div>
<h2 id="footnotes-images">Footnotes, Images</h2>

<p>This needs a footnote explanation<sup id="fnref1"><a href="#fn1">1</a></sup></p>
Expand Down Expand Up @@ -112,14 +110,12 @@ graph TD;
</div>

<p>Or using the <code>mermaid</code> code block:</p>

<pre><code class="mermaid">graph TD;
A--&gt;B;
A--&gt;C;
B--&gt;D;
C--&gt;D;
</code></pre>

<div class='mermaid'>graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
</div>
<h2 id="unsafe-html">Unsafe HTML</h2>

<p>This is calculated by Javascript: <span id='demo'></div></p>
Expand Down