Skip to content

MkDocs

This is how I try to store notes and procedures for different projects. The top priority for this site is ease of writing. I prioritize jotting things down for myself.

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

TODO:

  • headers need work / cleaning up.
  • table of contents needs reformatting, the |'s bug me.

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 in line 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 (or significant subproject) is contained within one page.
    • This way it is navigable, in its entirety, from the table of contents menu on the right.