mirror-space-wizards/docs
1
0
Fork 0
mirror of https://github.com/space-wizards/docs.git synced 2025-12-10 06:01:14 +03:00
Code Issues Projects Releases Packages Wiki Activity
Mirror of space-wizards/docs
626 commits 14 branches 0 tags 32 MiB
Find a file
Exact
chromiumboy 9737a4bb28
 Silicon Department V2 (#544) 
A modified version of [ScarKy0](https://github.com/ScarKy0)'s original
document (#537)

---------

Co-authored-by: ScarKy0 <scarky0@onet.eu>
Co-authored-by: ScarKy0 <106310278+ScarKy0@users.noreply.github.com>
2025-12-09 18:14:22 +01:00
.github add workflow to check that all .md files are linked in SUMMARY.md (#518) 2025-09-23 16:58:29 +02:00
.vscode firefox debugger 2023-09-12 02:56:24 -05:00
scripts Styling changes, Mermaid sequence diagrams styling 2024-10-13 15:10:07 +02:00
scss Styling changes, Mermaid sequence diagrams styling 2024-10-13 15:10:07 +02:00
src Silicon Department V2 (#544) 2025-12-09 18:14:22 +01:00
tests add workflow to check that all .md files are linked in SUMMARY.md (#518) 2025-09-23 16:58:29 +02:00
theme Styling changes, Mermaid sequence diagrams styling 2024-10-13 15:10:07 +02:00
.gitattributes Add .gitattribute file (#538) 2025-10-23 14:03:06 +02:00
.gitignore Add Obsidian to the .gitignore (#539) 2025-10-23 15:25:23 +02:00
book.toml Restructure Discord bot docs, add new embedded bot docs (#470) 2025-06-02 10:09:54 +02:00
flake.lock Add nix support (#115) 2024-01-01 02:20:48 -08:00
flake.nix Add nix support (#115) 2024-01-01 02:20:48 -08:00
LICENSE readme, license, 404 page 2023-09-10 02:40:56 -05:00
README.md Add mdbook-embedify to readme 2024-11-04 03:16:12 +01:00
shell.nix Add nix support (#115) 2024-01-01 02:20:48 -08:00

README.md

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.