https://github.com/six-two/mkdocs-knowledge-base-guide
Publish your Markdown notes (Obsidian, Trillium, etc) as a website with MkDocs
https://github.com/six-two/mkdocs-knowledge-base-guide
Last synced: 4 months ago
JSON representation
Publish your Markdown notes (Obsidian, Trillium, etc) as a website with MkDocs
- Host: GitHub
- URL: https://github.com/six-two/mkdocs-knowledge-base-guide
- Owner: six-two
- Created: 2024-09-21T16:25:47.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-01T19:05:03.000Z (7 months ago)
- Last Synced: 2025-02-01T22:48:25.810Z (5 months ago)
- Language: Shell
- Homepage: https://mkdocs-knowledge-base-guide.six-two.dev/
- Size: 337 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MkDocs Knowledge Base Guide
This guide aims to show you how to publish your knowledge base with MkDocs.
It mainly describes my setup, so it focuses on extensions I personally use or created for my knowledge base.
You can read the guide at or you can clone this repository and serve it with mkdocs.
## MkDocs advantages
- Actively developed
- Creates a static site that can be hosted anywhere cheaply (or even for free)
- Has a fully client side search function
- Has really great Material theme and many other plugins
- Writing small custom extensions is relatively easy, since it can be done in Python.
The [hooks](https://www.mkdocs.org/user-guide/configuration/#hooks) option also enables writing custom hooks without creating all the boilerplate code that a "proper" extension needs.
## MkDocs Drawbacks
MkDocs processes all sites sequentially.
This can lead to slow build performance, which makes the live reloading for large sites nearly unusable in my opinion.
For my personal knowledge base, which contains over 700 pages with over 39k lines in total and uses many plugins, the build process takes around 40 seconds on a M3 Macbook.
In the CI/CD pipeline, the build takes much longer.