Skip to content

LegionForge/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LegionForge Documentation

Source for the LegionForge documentation hub served at docs.legionforge.org.

This is the central documentation site for the entire LegionForge ecosystem:

Local development

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Then open http://127.0.0.1:8000/.

Build

mkdocs build --strict

Output goes to site/ (gitignored).

Deploy

Pushes to main trigger .github/workflows/deploy.yml, which builds with MkDocs and deploys to GitHub Pages. The custom domain is set via the CNAME file in the repo root and the docs.legionforge.org DNS record at Namecheap.

Editing pages

Every page has an "edit this page" pencil icon in the top-right that links straight to the source markdown on GitHub. Easiest way to make a small correction.

License

Documentation is dual: prose under AGPL-3.0 (matching the framework), code examples under the license of their source project.

About

LegionForge documentation hub — docs.legionforge.org · framework, Guardian, tools, apps

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors