forked from blender/blender-developer-docs
Julian Eisel
36311ff8d0
Enable and use the admonition markdown extension. This is a very common extension that I expect we will use a lot anyway. |
||
|---|---|---|
| docs | ||
| .gitattributes | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
| mkdocs.yml | ||
| requirements.txt | ||
README.md
Blender Developer Documentation
This is a new (experimental) repository for Markdown based developer documentation, using Material for MkDocs.
The official platform for developer documentation is still wiki.blender.org.
Building this Documentation Offline
The following assumes Python 3, pip, Git and Git LFS are installed.
Set up Git LFS for the current user:
git lfs install
Clone the documentation sources:
git clone https://projects.blender.org/blender/blender-developer-docs.git developer-docs
This will clone the sources into a developer-docs directory inside the current
one.
Install all dependencies, such as Material for MkDocs:
python -m pip install -r requirements.txt
Build this documentation with live reloading:
mkdocs serve
Alternatively mkdocs build will generate the documentation as HTML into a
site/ directory. Simply open site/index.html in a browser.