MkDocs¶

This is how I try to store notes and procedures for different projects. It is not designed for public readability so there are a lot of rough edges. I prioritize jotting things down for myself.

There may be unavailable pages/sections or missing information due to redaction.

MkDocs Plugins / Tweaks¶

Site is using Material for MkDocs

Diagrams are generated with the plantUML plugin for MkDocs. This is far superior to Materials' own diagram plugin (also plantUML is basically an institutional standard)

Coming across "REDACTED" sections/text is done with a prebuild script that strips sensitive elements from the site as it is built.

Installed plugins are centered around (beyond obvious QoL), code snippet display, navigation, and table of contents generation. mkdocs.yml is not available for viewing.

Stylesheet¶

MkDocs allows total theming control with CSS stylesheets. Currently I have a myriad of tweaks for boosting content grouping visibility, along with compressing spacing of elements such as lists. Stylesheet changes constantly and is not available for viewing.

Site Structure¶

Keeping inline with the limitations of MkDocs. The site is organized to maximize navigability and flatness of information (i.e. maximal exposure), while still being readable.

Top menu shows categories

Each category contains individual projects/products for that category

A project is contained within one page. This way it is navigable in its entirety from the table of contents menu on the right.

MkDocs Cheatsheet¶

<details markdown="1">
 <summary>summary text for dropdown</summary>
 put any markdown content here and it'll work
</details>

<p class="subtitle" style="text-align: center;">Block Gaem.</p>

![image description](path/to/image.png){align=left width=50%}

make text start on the next good line after an image as opposed to wrapping around it.

<div style="clear: both;"></div>

<https://hyperlink.com>

```\p\u\m\l
I am a plantUML diagram. remove my escape characters.
\```

* I am a list
    * I am a subitem

[link text as it appears](./localPageLink.md)

<!--RED\ACT-->
I am redacted and won't be built into the published site. remove my escape characters.
<!--REDACT\END-->