Dungeon Crawler Framework Documentation (MkDocs Material)

This folder contains the documentation site for Dungeon Crawler Framework, built with MkDocs and the Material theme.

Local preview

cd Docs
pip install -r requirements.txt
mkdocs serve

Then open http://127.0.0.1:8000/ in your browser. The site rebuilds automatically as you edit files in docs/.

Build a static site

cd Docs
mkdocs build            # output goes to Docs/site/

GitHub Pages deployment

A ready-made GitHub Actions workflow is provided at Docs/.github/workflows/deploy.yml.

1. Move it to the repository root: .github/workflows/deploy.yml.
2. In your GitHub repo, go to Settings → Pages → Build and deployment → Source and select GitHub Actions.
3. Push to main. Every change under Docs/** rebuilds and publishes the site to https://mantis3de.github.io/Dungeon Crawler Framework/.

Structure

Docs/
├── mkdocs.yml                 # site config + navigation
├── requirements.txt          # python deps
├── docs/
│   ├── index.md              # home
│   ├── getting-started/      # installation + 5-minute quick start
│   ├── editors/              # the five visual editors
│   ├── architecture.md       # module diagram
│   ├── api.md                # public API reference
│   ├── faq.md                # Asset Store FAQ
│   └── changelog.md
└── .github/workflows/deploy.yml