Blender Education projects website
| docs | ||
| theme_overrides | ||
| hooks.py | ||
| mkdocs.yml | ||
| README.md | ||
| requirements.txt | ||
Blender Education Documentation
Welcome to the Blender Education Documentation.
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-education-docs.git education-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 or python -m mkdocs serve
Alternatively mkdocs build will generate the documentation as HTML into a
site/ directory. Simply open site/index.html in a browser.
Links
TODO