Skip to content

Commit

Permalink
Deployed 8e7505e with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
MikhailKravets committed Oct 19, 2024
1 parent 51cdcf6 commit 74660f2
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 6 deletions.
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -842,8 +842,8 @@
<h1>Home</h1>

<p><img alt="logo" src="assets/logos/logo.svg" /></p>
<p><em><code>mkdocs_puml</code> is a fast and simple package that brings PlantUML diagrams to MkDocs
documentation.</em></p>
<p><code>mkdocs_puml</code> is a fast and simple package that brings PlantUML diagrams to MkDocs
documentation.</p>
<h3 align="center">

<a href="https://pypi.org/project/mkdocs_puml/" target="_blank"><img src="https://img.shields.io/pypi/v/mkdocs-puml?style=for-the-badge" /></a>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

34 changes: 32 additions & 2 deletions themes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -729,6 +729,24 @@
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#how-to-use" class="md-nav__link">
<span class="md-ellipsis">
How to Use
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#license" class="md-nav__link">
<span class="md-ellipsis">
License
</span>
</a>

</li>

</ul>
Expand All @@ -751,8 +769,10 @@

<h1 id="themes-hub">Themes Hub<a class="headerlink" href="#themes-hub" title="Permanent link">&para;</a></h1>
<p><img alt="logo" src="../assets/logos/logo-themes.svg" /></p>
<p><em><code>mkdocs_puml</code> offers a collection of themes for use.</em></p>
<p>Themes Hub is a collection of themes specifically designed for PlantUML with
a seamless integration with <code>mkdocs_puml</code>.</p>
<h2 id="available-themes">Available Themes<a class="headerlink" href="#available-themes" title="Permanent link">&para;</a></h2>
<p>Currently the hub consists of the following themes.</p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -789,11 +809,21 @@ <h2 id="available-themes">Available Themes<a class="headerlink" href="#available
</tr>
</tbody>
</table>
<h2 id="how-to-use">How to Use<a class="headerlink" href="#how-to-use" title="Permanent link">&para;</a></h2>
<details class="note" open="open">
<summary>How to use Themes</summary>
<summary>Using Themes from Hub with <code>mkdocs_puml</code></summary>
<p>Refer to the <a href="../getting_started/setup/#theming">Setup Theming Section</a> to learn how
use themes with <code>mkdocs_puml</code>.</p>
</details>
<p>To use a theme from the hub, locate its corresponding <code>.puml</code> file containing the styles.
Each theme card includes a link to its folder in the GitHub repository.
Open the folder, select the desired flavor, get raw link to the file,
and build the <code>!include</code> statements to insert into your PlantUML code.</p>
<p>For example, for <code>catppuccin/mocha</code> flavor's <code>!include</code> statement is</p>
<div class="highlight"><pre><span></span><code>!include https://raw.githubusercontent.com/MikhailKravets/mkdocs_puml/themes/themes/catppuccin/mocha.puml
</code></pre></div>
<h2 id="license">License<a class="headerlink" href="#license" title="Permanent link">&para;</a></h2>
<p>Themes from the hub are licensed under MIT license.</p>



Expand Down
2 changes: 1 addition & 1 deletion themes/kanagawa/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -955,7 +955,7 @@


<h1 id="kanagawa">Kanagawa <img alt="🌊" class="twemoji" src="https://cdn.jsdelivr.net/gh/jdecked/[email protected]/assets/svg/1f30a.svg" title=":ocean:" /><a class="headerlink" href="#kanagawa" title="Permanent link">&para;</a></h1>
<p><img src="/assets/themes/kanagawa/kanagawa%402x.png" width=300 /></p>
<p><img src="../../assets/themes/kanagawa/kanagawa@2x.png" width=300 /></p>
<hr />
<p>Kanagawa theme implements a color palette defined in <a href="https://github.com/rebelot/kanagawa.nvim">kanagawa.nvim</a>.
This color scheme is inspired by Katsushika Hokusai’s work, especially, his famous "The Great Wave".</p>
Expand Down

0 comments on commit 74660f2

Please sign in to comment.