mkdocs documentation
Theme¶
We use the Material theme for MK Docs. You can find the updated features in the theme specimen. We also run most of the available extensions.
Example configurations¶
Learn from running projects
Here there is a list of projects using mkdocs in different ways for documenting various things:
- SmartCitizen Docs: https://docs.smartcitizen.me
- Fabacademy Barcelona Local Docs: https://fablabbcn-projects.gitlab.io/learning/fabacademy-local-docs/
- This documentation: https://knowledge.fablabbcn.org
Customization¶
You can deeply customize it by simply editing the the mkdocs.yml file the root folder mkdocs.yml.
An interesting feature is the possibility to manually customize navigation. See Smart Citizen Docs as an example.
Automation¶
We use Github Action to automatically update knowledge.fablabbcn.org every time you commit a change.
Currently we run a single workflow to simply build the site like mkdocs build but more complex features are possible. Find an example here.