Link collection & FAQ for the Chaos community
Go to file
Tim Weber b28ac08e84
FireShonks is only until the 30th
2023-09-21 21:14:46 +02:00
config/en FireShonks is only until the 30th 2023-09-21 21:14:46 +02:00
docs/en Allow event locations to be optional 2023-09-20 23:43:40 +02:00
includes/en Emphasize that this is an unofficial site 2023-07-24 23:41:31 +02:00
overrides Allow CfPs to expire, gray out the icon then 2023-08-02 00:56:31 +02:00
.gitignore Use buttons, not text, for location links 2023-07-29 15:04:35 +02:00
LICENSE.txt Set up mkdocs-material & add some initial content 2023-07-24 20:22:04 +02:00 Use buttons, not text, for location links 2023-07-29 15:04:35 +02:00 Remove files from dist before building for deploy 2023-07-24 23:19:09 +02:00
redirect-en.html Add deployment script 2023-07-24 20:55:16 +02:00
requirements-dev.txt Move events & locations to a structured YAML file 2023-07-30 16:05:22 +02:00 Pass arguments to `mkdocs serve` 2023-08-02 14:29:33 +02:00

The Chaos Guide

This is the source repository for the Chaos Guide.

The Guide is a static website, with source documents written in Markdown and rendered into HTML using mkdocs-material. We are somewhat prepared to become multi-lingual, but for now the Guide is in English only.

Setting up for development

If youd just like to change small things in the Guides content, you might get away with just editing the Markdown files in docs and not need a local development environment at all.

However, if youd like to preview how your changes actually look like on the site, you need Python (at least version 3.8) and a few libraries.

To set it up, first create a new virtual environment:

virtualenv .venv

Then, activate that virtual environment. If you work in multiple shells, you need to do this in each one of them. Also, when you log out or call deactivate, youll have left that virtual environment and will need to re-enable it to use it.

. .venv/bin/activate

Last step: Install the required libraries.

pip install -r requirements-dev.txt

Now, you can run a development server:


If you open http://localhost:8000/ in your browser, you should be able to see the generated website.


For now, deployment is manual and done by scy, using the script.

Questions & contributions

Check out for more information on how to contribute, or how to contact us.