- Install Node.js
- Install pnpm
- Clone this repository
- Install dependencies:
pnpm install
- Spawn development server:
pnpm start
- Visit localhost:4321
Linters run automatically in this GitHub Action workflow. You can also run them locally.
lychee is a tool that recursively checks all links on the site for 404s.
- Install lychee
- Build the site:
pnpm build
- Preview the site in the background:
pnpm preview --host 0.0.0.0 &
- Run lychee:
lychee dist src/content
You may need to set GITHUB_TOKEN
to avoid issues checking links to github.com.
Vale checks style and grammar in Markdown files.
- Install Vale
- Download style rules:
vale sync
- Check with Vale:
vale .
For editor integration, use:
- Visual Studio Code:
chrischinchilla.vale-vscode
- Vim: ALE
Prettier is a code formatter. It's shipped as a devDependency
, so pnpm install
will have installed it.
To format all files:
$ pnpm format
Astro has some of its own diagnostics.
$ pnpm astro check
$ pnpm tsc