snyaify / selfhosters.net

Selfhosters.net

Repository for the selfhosters.net documentation.

Start documenting

Create or edit a markdown(.md) file in the /docs folder.

It's based on markdown, so looking at a cheat sheet, and checking changes against a live preview helps you confirm the changes appear like you want them to.

Start documenting (and seeing changes live)

Clone repository

git clone https://github.com/selfhosters/selfhosters.net.git
cd selfhosters.net/

Create and activate python virtual environment (docs)

python3 -m venv ./venv
source venv/bin/activate

Install required packages

pip install -r requirements.txt

Start the dev-server

mkdocs serve

Write your documentation

Commit your changes