Clone the Repository · Build Using Python · Zensical Studio · Special Thanks
This is my personal, self-hosted professional portfolio and network documentation website built with Zensical. This repository only contains the source markdown and development files. The built website in the /site directory is not tracked in the repo, but get's uploaded to my Nginx Web server. The website is hosted on my own server and exposed to the internet with a Cloudflare Tunnel.
You can build your own network documentation website with the configuration, directory structure, custom icon libraries, and page templates provided in this code repository. Just fork the repo and replace the *.md files with your own created using the templates. The provided zensical.toml configuration file and customized CSS can be used for any Zensical project regardless of the page content. Note: You will need to change the .nav.yml files to reflect the names of your own markdown files.
git clone https://github.com/benhaube/network-portfolio.git
cd network-portfolio/git clone git@github.com:benhaube/network-portfolio.git
cd network-portfolio/python -m venv .venv/
source .venv/bin/activatepip install zensical| Plugin | Role |
|---|---|
mkdocs-awesome-nav |
Customize the navigation structure. |
mkdocs-glightbox |
Create an image gallery. |
pip install mkdocs-awesome-nav mkdocs-glightboxRun the following commands to upgrade Zensical and the required plugins to the latest version.
# Upgrade Zenzical
pip install --upgrade --force-reinstall zensical
# Upgrade Plugins
pip install --upgrade --force-reinstall mkdocs-awesome-nav mkdocs-glightbox
# Upgrade `pip`
pip install --upgrade pipRun the following command to check the currently installed version of Zensical.
pip show zensicalzensical servezensical buildTip
Zensical will create a new directory in the root of the repository named 'site' and build the site in that directory. Move the resulting site/* directory and its contents onto the Web server of your choice. Do NOT move any other source files or directories to the Web server.
Zensical Studio is the project-aware authoring environment for Zensical and MkDocs projects. It safely updates links, references, and redirects across your entire project when you rename, move, or split content. Your source files stay in Git – under your control.
- Python Markdown editing and accurate syntax highlighting, including nested content.
- Formatting and linting for python markdown files.
- Automatic link completion, broken link detection, preview links on hover
- Navigate the content, search workspace symbols, and find references across the project.
- Live preview to see changes immediately.
Install Zensical Studio in VSCode and open your Zensical or MkDocs project. Zensical Studio automatically detects zensical.toml or mkdocs.yml and activates Python Markdown support for your documentation files.
-
Open the command palette (
Ctrl + Shift + P) and paste the following command:ext install zensical.zensical-studio -
Confirm the extension is active and the Python Markdown language is active when you open a Markdown file. You can see this in the status bar in the bottom right of the screen. If you do not see a status bar, you can turn it on in View → Appearance → Status Bar.
Tip
You can also install the extension from the Linux command line:
codium --install-extension zensical.zensical-studioGoogle — For their Google Sans and Google Sans Code fonts.
- The fonts are used with the SIL Open Font License.
Zensical — For their incredible open-source static website generator.
- Some of the Zensical source code has been modified and redistributed in this repository with the MIT license.
Lucide — For their beautiful and modern icon library.
- Some Lucide icons are used, modified and redistributed in this repository with the ISC and MIT licenses.
Selfh.st — For their awesome, colorful brand icons.
- Some Selfh.st icons are used, modified and redistributed in this repository with the Creative Commons Attribution 4.0 license.
Simple Icons — For their monochrome brand icons.
- Some Simple Icons are used, modified and redistributed in this repository with the CC0 1.0 Universal license.
Mermaid.js — For building an amazing tool for rendering beautiful flowcharts.
- The Mermaid javascript is used with the MIT license.
VSCodium — For their excellent open-source, MIT-Licensed IDE that lacks Microsoft's spyware / telemetry. I have used it extensively in the development of this website, and daily in all of my projects and network configuration management.
Inkscape — For building an incredible piece of software for the FOSS community to create and edit SVG icons.

