scy/chaos-guide
2
4
Fork
You've already forked chaos-guide
1
Link collection & FAQ for the Chaos community https://chaos.guide/
  • Python 65.6%
  • HTML 23.4%
  • CSS 7.1%
  • Shell 3.9%
2024年12月03日 18:06:20 +01:00
config/en Add #jetzt5 geekend 2024年03月16日 20:28:37 +01:00
docs/en Add a note about degraded maintenance 2024年04月01日 19:58:15 +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
deploy.sh Ensure www.chaos.guide works too 2024年12月03日 18:06:20 +01:00
LICENSE.txt Set up mkdocs-material & add some initial content 2023年07月24日 20:22:04 +02:00
README.md Use buttons, not text, for location links 2023年07月29日 15:04:35 +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
serve.sh serve.sh: 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 you’d just like to change small things in the Guide’s content, you might get away with just editing the Markdown files in docs and not need a local development environment at all.

However, if you’d 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, you’ll 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:

./serve.sh

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

Deployment

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

Questions & contributions

Check out https://chaos.guide/en/contributing/ for more information on how to contribute, or how to contact us.