This repository contains the source to Mixxx website. This site is built with Cactus, a static site generator.
To get started contributing to the Mixxx website, first install all requirements (e.g. Cactus). Optionally, use a Virtualenv to isolate dependencies.
$ pip install -r requirements.txt
Then build the site from its templates:
$ cactus build
If all goes well, you should have the rendered HTML in your .build
directory. To stand up a development server to test out your change, type:
$ cactus serve
You can then visit http://127.0.0.1:8000 to see your development version
of the site.
Cactus uses Django's templates for rendering pages.
The main templates are stored in the templates/ folder. Leaf pages are
stored in pages/. If there is a snippet of code you want to use in
multiple places on the site, place it in the templates/ folder -- for
example templates/download_button.html.
- Django template language
- template internationalization
- Cactus documentation (not super useful)
All strings wrapped with {% trans 'Hello World' %} are flagged for
translation. Whenever adding new English strings to the website, please wrap
them in a {% trans 'Hello World' %} block.
Note: Requires SSH access to mixxx.org.
First, publish to http://staging.mixxx.org:
$ fab staging rebuild publish
Visit the staging site to verify everything looks ok. Then, publish to the production site:
$ fab production rebuild publish
Visit https://mixxx.org to verify everything looks ok.