This is the mdbook-based developer documentation for all Space Wizards projects, including Robust Toolbox, Space Station 14, the SS14 launcher, etc. These docs cover many topics and can be potentially very useful for mappers, spriters, active contributors & prospective contributors, people who want to use our engine for their own projects, fork developers, and so on.
The site is currently hosted at https://docs.spacestation14.com.
Benefits of the current docs site infrastructure include:
- First-class git support, open source and actually editable by everyone
- Decently familiar & comfortable for developers since
mdbookuse is very widespread - No sign-on infrastructure or hosting necessary (besides GH pages), if forks would like to host their own
- Very low friction to adding new pages and editing/fixing old ones
- High level of customizability with styling and easy custom scripting
- Eventual localization support
The following mdbook features & plugins are available and in use:
MathJaxsupport- Sidebar ToC (integrated directly into
index.hbsetc) mdbook-mermaidmdbook-linkcheckmdbook-templatemdbook-admonishmdbook-emojicodesmdbook-embedify
For information such as how to edit, build & test these docs, see Guide to Editing Docs. on the site itself (or in this repo)
The Space Wizards Development Wiki is released under the Mozilla Public License v2.0.