Skip to content

Documentation side for Space Station 14 and RobustToolbox

License

Notifications You must be signed in to change notification settings

Centronias/ss14-docs

This branch is 58 commits behind space-wizards/docs:master.

Folders and files

NameName
Last commit message
Last commit date
Oct 25, 2024
Sep 12, 2023
Oct 13, 2024
Oct 13, 2024
Dec 8, 2024
Oct 13, 2024
Nov 16, 2024
Sep 10, 2023
Nov 4, 2024
Oct 25, 2024
Jan 1, 2024
Jan 1, 2024
Jan 1, 2024

Repository files navigation

Space Wizards Development Wiki

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 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.

About

Documentation side for Space Station 14 and RobustToolbox

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 48.8%
  • Handlebars 37.9%
  • JavaScript 7.6%
  • SCSS 3.7%
  • Nix 2.0%