https://github.com/space-wizards/docs

Documentation side for Space Station 14 and RobustToolbox
https://github.com/space-wizards/docs

Last synced: about 10 hours ago
JSON representation

Documentation side for Space Station 14 and RobustToolbox

• Host: GitHub
• URL: https://github.com/space-wizards/docs
• Owner: space-wizards
• License: mpl-2.0
• Created: 2023-09-10T06:35:09.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-29T10:17:25.000Z (2 months ago)
• Last Synced: 2024-10-29T12:18:27.781Z (2 months ago)
• Language: CSS
• Homepage: http://spacestation14.io/docs/
• Size: 9.95 MB
• Stars: 24
• Watchers: 8
• Forks: 162
• Open Issues: 95
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# 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](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](https://spacestation14.io/docs/en/meta/guide-to-editing-docs.html). on the site itself** (or [in this repo](./src/en/meta/guide-to-editing-docs.md))

## Screenshots

![](src/en/assets/images/readme-example-1.png)

![](src/en/assets/images/readme-example-2.png)

## License

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