Skip to content

README.md

Latest commit

 

History

History
35 lines (25 loc) · 1.55 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.55 KB

Rem Station Development Wiki

This is the mdbook-based developer documentation for all Rem Station projects. The Rem Station docs site does not cover as many topics as the Wizard Den's docs website does. If you are looking for a certain topic, it may be covered on their site

The site is currently hosted at https://docs.remstations.com

Benefits of the current docs site infrastructure include:

  • First-class git support, open source, and editable by everyone
  • Decently familiar & comfortable for developers since mdbook use 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:

  • MathJax support
  • Sidebar ToC (integrated directly into index.hbs, etc)
  • mdbook-mermaid
  • mdbook-linkcheck
  • mdbook-template
  • mdbook-admonish
  • mdbook-emojicodes
  • mdbook-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)

Screenshots

License

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