Welcome

This page will cover how to setup this documentation site, both in case I need to do so in the future, or in case you would like to use this setup for your own notes. The source code for these notes can be found on codeberg

I have tried many different templates for notes before, including mdbook and celestrial docs. This iteration is me trying for a much more simplistic approach, less admonitions and callouts and more focus on just the text. There can be a nasty tendency to introduce too many bells and whistles.

Setup

You can install everything in this repository without uv, however I would highly recommend installing all the requiremnts in a virtual environment instead of globally to your system. The instructions to install it can be found here

Then, all you need to do is run the following

git clone https://codeberg.org/mark-pitblado/notes/
cd notes
uv sync
uv run mkdocs serve

The notes should open on localhost:8000

Mkdocs plugins used

This site uses the following plugins

  1. Mkdocs Awesome Nav
  2. Git Revision Date

Links are validated through lychee


Table of Contents