From 50d9af612041e6bdb2193cd2649d6c018503dafe Mon Sep 17 00:00:00 2001 From: Aidenkrz Date: Fri, 10 May 2024 02:56:40 -0500 Subject: [PATCH] Update README.md --- README.md | 32 +++----------------------------- 1 file changed, 3 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index b507cdb..b47783a 100644 --- a/README.md +++ b/README.md @@ -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.