postmarketos.org

Dev

Python Requirements Setup

Python 3.4+ is supported. Install all requirements, preferably within a virtualenv:

$ python -m venv .venv
$ source .venv/bin/activate
(venv)$ pip install -r requirements.txt

New Blog Content

Blog content is written in markdown format with metadata in the file header. Filename syntax is yyyy-mm-dd-slug.md.

$ cat >content/blog/2017-12-31-happy-new-year.md << EOF
> ---
> title: Happy New Year!
> ---
>
> This is a *markdown* **formatted** post.
> EOF

Dev Server

Run the dev server during local development, changes are auto reloaded:

(venv)$ FLASK_DEBUG=1 FLASK_APP=app.py flask run

CSS

Not much CSS is used due to heavy usage of Tachyons toolkit classes. Please use CSS judiciously only when needed.

Any CSS used should be compiled via lessc:

$ npm install -g less
$ lessc static/css/main.less static/css/main.css

Build

To run a static site build, run:

(venv)$ python freeze.py

This will generate a static version in docs/. Any manual changes to the docs/ directory will be overridden in the next build.

Note that the docs/ directory is ignored and not versioned.