Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.33 KB

README.md

File metadata and controls

32 lines (23 loc) · 1.33 KB

Space Wizards Development Wiki

This is a work-in-progress port of the old SS14 Wiki.js documentation to mdbook, for the following benefits:

  • First-class git support, open source and actually editable by everyone
  • No webshit bloat, much faster in general
  • More familiar & comfortable for developers since mdbook use is very widespread
  • No sign-on infrastructure or hosting necessary (besides GH pages)
  • More customizable
  • Friction to editing reduced significantly
  • Eventual localization support

The following mdbook features & plugins are available and in use:

  • MathJax support
  • Sidebar ToC (integrated directly into index.hbs etc)
  • mdbook-mermaid
  • mdbook-linkcheck
  • mdbook-template
  • mdbook-admonish

The site is currently hosted at https://spacestation14.io/docs/. This will likely change in the future, so links here should not be relied on.

For information such as how to edit, build & test these docs, see Guide to Editing Docs. on the site itself (or in this repo)

Screenshots

License

The Space Wizards Development Wiki is released under the Mozilla Public License v2.0.