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 highlight 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
Vim tags
Through the vim-md-tags plugin, links can be directly created while in one file. For example, if a link is created through markdown syntax [content](link)
and then the user presses enter while hovering over the link, the file will automatically be created in a new buffer. See the vim-md-tags repository for more information.
Link validation
Links are validated through lychee