About Zen ¶
This test site is built using Zensical, a modern documentation framework employing a rewrite of the Material theme on top of MkDocs. Examples of major sites that use Material for MkDocs can be found on the GitHub project page linked under Trusted by ....
Page content is written in the popular markdown text markup language. This video guide to standard and extended markdown is perhaps The Only Markdown Crash Course You Will Ever Need.
Much of my work here was inspired by the YouTube video Build + Deploy a Documentation Portal from Scratch by James Willett. He has a companion web site revealing the underlying details used to create his documentation portal: Getting Started with Material for MkDocs.
Another useful reference is Techdox, which makes extensive use of the many features of MkDocs and the Material theme, and serves as a resourceful tutorial because all of the code for the site can be examined on GitHub.
This Showcase of MkDocs and Material Features demonstrates many of the built-in formatting and display capabilities provided by the MkDocs Material theme and the enabled Markdown extensions.
Versions¶
This site is available in two versions:
- https://zen-proxy.langley.stream:4443/ (reverse-proxied local Zensical server, without PHP support)
- https://zen-php.langley.stream:4443/ (static site built by Zensical in our
/opt/zensicalweb space, with PHP support)