kilpatrick.co.uk is an astro website for John Kilpatrick.
Install guide for astro here.
With npm installed:
git clone https://github.com/rjkilpatrick/kilpatrick.co.uk
npm install
npm run dev| Script | Purpose |
|---|---|
npm run dev |
Start the local dev server |
npm run build |
Build the static site to dist/ |
npm run preview |
Preview the production build locally |
npm run typecheck |
Run Astro's TypeScript checker |
npm run lint |
Run ESLint and Stylelint |
npm run lint:fix |
Run ESLint and Stylelint, applying automatic fixes |
npm run format |
Format the repo with Prettier |
npm run format:check |
Check formatting without writing changes |
npm run check |
Run format:check, lint, and typecheck together |
This repo uses ESLint, Stylelint, and Prettier to keep the codebase consistent, and prek (a fast, drop-in pre-commit replacement) to run those checks automatically before each commit.
Install prek once per machine (see the prek README for other install methods), then wire it up for this repo:
prek installAfter that, git commit will run formatting, linting, and type-checking on the files you're changing. The same checks run in CI on every push and pull request.
The website source is licensed under the MIT license, and the content is licensed under CC-BY 4.0.
This means for example if you want to redistribute a post, or any site related images they contain, you can share and adapt it for any purpose, as long as it's attributed correctly. E.g. TODO: PROVIDE EXAMPLE. If you want to use any of the site source, for example using the css in your own project, use the file with the license text added in a comment at the top.