diff options
| -rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -14,6 +14,8 @@ $ source venv/bin/activate ### Update Wiki Content +Wiki content is pulled and updated automagically as a git submodule from the [pmbootstrap wiki](https://github.com/postmarketOS/pmbootstrap/wiki). + ```bash $ git submodule update --init --recursive $ git pull --recurse-submodules @@ -21,6 +23,8 @@ $ git pull --recurse-submodules ### New Blog Content +Blog content is written in markdown format with metadata in the file header. Filename syntax is `yyyy-mm-dd-slug.md`. + ```bash $ cat >content/blog/2017-12-31-happy-new-year.md << EOF > --- @@ -33,12 +37,18 @@ $ cat >content/blog/2017-12-31-happy-new-year.md << EOF ### Dev Server +Run the dev server during local development, changes are auto reloaded: + ```bash (venv)$ FLASK_DEBUG=1 FLASK_APP=app.py flask run ``` ### Build +To run a static site build, run: + ```bash (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. |