Blender Education projects website

Go to file

Monique Dewanchand 4e7db6360b Setup initial structure for foundation badges		2024-05-15 21:42:14 +02:00
docs	Setup initial structure for foundation badges	2024-05-15 21:42:14 +02:00
theme_overrides	Setting up structure of the docs website	2024-02-03 12:08:29 +01:00
mkdocs.yml	Setup initial structure for foundation badges	2024-05-15 21:42:14 +02:00
README.md	Update README.md	2024-02-03 11:43:32 +01:00
requirements.txt	Add requirements	2024-02-03 11:44:56 +01:00

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.

TODO