forked from space-wizards/docs
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
3 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,7 @@ | ||
# Space Wizards Development Wiki | ||
# Goob Station Wiki | ||
|
||
This is a port of the old Wiki.js SS14 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` | ||
- `mdbook-emojicodes` | ||
|
||
The site is currently hosted at [https://docs.spacestation14.com](https://docs.spacestation14.com). | ||
|
||
**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) | ||
Fork of the SS14 mdbook wiki. | ||
|
||
## License | ||
|
||
The Space Wizards Development Wiki is released under the Mozilla Public License v2.0. | ||
The Space Wizards Development Wiki/Goob Station Wiki is released under the Mozilla Public License v2.0. |