Nikola's official Getting Started is recommended for beginners who require a fully-guided setup experience.
For those ready to jump into a CLI:
- Create a
venv
from the root folder:python3 -m venv .venv
- Activate it in your terminal:
source .venv/bin/activate
- Within the
venv
:pip3 install Nikola[extras]
- (YMMV) If
nikola build
spits out a Pillow-related error, Nikola installed the wrong Pillow version, so manually override it after withpip3 install Pillow==8.3.1
- (YMMV) If
cd website
and runnikola auto
to have Nikola auto-rebuild after nearly any changes.
Not currently working 💀. Unfortunately, you'll simply have to use venv
on
your host machine.
tl;dr:
cd website && nikola auto
. Read on for VS Code Dev Container goodness.
- Install VS Code and Docker on your host machine.
- Add VS Code to your shell PATH.
- Clone this repo (SSH recommended).
code .
from project root.- Install Remote - Container (
ms-vscode-remote.remote-containers
), VS Code should prompt you to do so.- Once installed, another prompt to Re-open in Container appears. Click it.
- Wait for container to build. Once done, it should either ask you to enable
auto-run build tasks or just run the build task for you.
- If it doesn't,
[Ctrl/Cmd] + Shift + B
to manually fire it.
- If it doesn't,
- Install recommended extensions, otherwise Jinja2
.tmpl
files won't have syntax highlighting, for example.
Known issue: When rebuilding the dev container, the auto-run build task will fail. Simply wait until rebuild is complete and manually run the build task (see above).
Check tasks.json for a browser auto-launch variation.
Run this from the website/
folder, assuming you are in an activated venv
and/or dev container:
cd website && nikola build -a && nikola github_deploy
Not currently working 💀.
Tasks: Run Task > Nikola: Build & Deploy