James Beith

Technical writing about Python & Django.

www.jamesbeith.co.uk

---

Site

The site is built using Hugo. The theme is PaperMod which is installed unmodified as a Git Submodule.

Content

Content is written in Markdown. Hugo uses Goldmark, a CommonMark compliant parser, to render Markdown to HTML.

To create new content use.

hugo new content content/til/$(date '+%Y-%m-%d')/title.md

To run the local webserver use.

hugo server --buildDrafts --buildFuture

Linting

Vale and Prettier are used.

To install Vale, first install the Homebrew package manager. Then you can install Vale using.

brew install vale

You then need to download and install Vale’s external configuration sources using.

vale sync

To install Prettier, first install Node.js using a version manager such as fnm. Then enable the Corepack (Yarn) package manager.

corepack enable

Then you can install Prettier using.

yarn install

To run the linting tools use.

yarn lint

You can also run the linting tools to automatically apply all available fixes using.

yarn fix

Deployment

The site is deployed using Cloudflare Pages.