README.md

obsidian-workflow-template-docs

This is the documentation for my obsidian-workflow-template project.

Technology used

I'm using MkDocs with the Material theme.

It has a wonderful documentation and is very customizable.

Requirements

pip install mkdocs
pip install mkdocs-material

Don't forget the sudo before on linux, otherwise you might run into possible errors related to command not found.

Usage

MkDocs includes a live preview server, so you can preview your changes as you write your documentation. The server will automatically rebuild the site upon saving. Start it with:

mkdocs serve

When you're finished editing, you can build a static site from your Markdown files with:

mkdocs build