This repository holds the source content for Mathesar's wiki, as published to:
Table of Contents
-
Install requirements
pip install -r requirements.txt -
Start MkDocs
mkdocs serve -a localhost:9000 -
Preview the docs at http://localhost:9000
-
Keep mkdocs running while you edit and your local preview will refresh automatically.
-
Mathesar maintainers are encouraged to push small commits directly to
master. -
Community contributors may suggest changes by opening PRs.
-
Our docs run on a distribution of
mkdocscalledmkdocs-material. For basics of doc writing, see the Writing your docs section ofmkdocsuser guide. -
For some customization basics, see Customization section of
mkdocs-material's Getting started guide. To learn about some ofmkdocs-material's features (annotations, code blocks, content tabs, etc.), see its Reference. -
For page redirects, we use
mkdocs-redirects. -
We use the awesome-pages plugin for some additional control over the navigation system.
-
We use the mkdocs-htmlproofer-plugin to validate internal hyperlinks.
-
The source content for Mathesar's documentation, which also utilizes MkDocs.