Add Servers/Documentation/Zensical.md
All checks were successful
GitOps Automatic Deployment / GitOps Automatic Deployment (push) Successful in 6s
All checks were successful
GitOps Automatic Deployment / GitOps Automatic Deployment (push) Successful in 6s
This commit is contained in:
34
Servers/Documentation/Zensical.md
Normal file
34
Servers/Documentation/Zensical.md
Normal file
@@ -0,0 +1,34 @@
|
||||
## Purpose
|
||||
After many years of Material for MKDocs being updated with new features and security updates, it finally reached EOL around the end of 2025. The project maintainers started pivoting to a new successor called [Zensical](https://zensical.org/docs/get-started/). This document outlines my particular process for setting up a standalone documentation server within a virtual machine.
|
||||
|
||||
!!! info "Assumptions"
|
||||
It is assumed that you are deploying this server into `Ubuntu Server 24.04.2 LTS (Minimal)`. It is also assumed that you are running
|
||||
|
||||
### Setup Python Environment
|
||||
The first thing we need to do is install the necessary python packages and install the zensical software stack inside of it.
|
||||
|
||||
```sh
|
||||
sudo apt update && sudo apt upgrade -y
|
||||
sudo apt install -y nano python3 python3.12-venv
|
||||
mkdir -p /srv/zensical
|
||||
cd /srv/zensical
|
||||
source .venv/bin/activate
|
||||
pip install zensical
|
||||
zensical new .
|
||||
```
|
||||
|
||||
### Configure Zensical Settings
|
||||
Now we want to set some sensible defaults for Zensical to style it to look as close to Material for MKDocs as possible.
|
||||
|
||||
```sh
|
||||
|
||||
```
|
||||
|
||||
### Launch Zensical Server
|
||||
At this point, you can simply launch the server via the hotload-friendly `serve` mode. I have this configured to listen on `0.0.0.0` but you can set it to `localhost` or a LAN IP address like `192.168.3.8`. You can adjust the port number if you want to.
|
||||
|
||||
```sh
|
||||
zensical serve -a 0.0.0.0:80
|
||||
```
|
||||
|
||||
mkdir -p /srv/zensical/server
|
||||
Reference in New Issue
Block a user