Skip to content

Repository files navigation

Doriax Engine Documentation

Official documentation for the Doriax game engine, built with MkDocs.

Documentation content lives in docs/. The site is organized into:

  • getting-started/ — orientation, installation, and first project pages
  • tutorials/ — step-by-step workflows
  • editor/ — editor panels, project workflow, resources, animation, code, and export
  • manual/ — engine concepts and subsystem guides
  • reference/ — API reference, enumerations, and build options
  • contributing/ — documentation and screenshot contribution notes

Local development

Install the dependencies (MkDocs + PyMdown Extensions):

pip install -r requirements.txt

Serve the site locally with live reload:

mkdocs serve

Then open http://127.0.0.1:8000.

Building

Produce a static site in the site/ directory:

mkdocs build --strict

License

Documentation content is licensed under CC BY 4.0.

About

Doriax Engine's documentation

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages