-
Notifications
You must be signed in to change notification settings - Fork 143
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add a proper example page, and a guide to editing docs
- Loading branch information
1 parent
5b5eee9
commit deb632a
Showing
10 changed files
with
129 additions
and
47 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -0,0 +1,88 @@ | ||
# Docs Example Page | ||
|
||
This page is used for showing off plugins and styling available in this `mdbook` instance. | ||
|
||
Its best to view the raw markdown source of this page, which you can do using the button in the top right and clicking 'Code' instead of 'Preview' on GitHub. | ||
|
||
## markdown | ||
|
||
Best to look at [a general markdown guide](https://www.markdownguide.org/getting-started/) for this! There's a lot. | ||
|
||
**bold** | ||
|
||
*italic* | ||
|
||
~~strikethrough~~ | ||
|
||
## templates | ||
|
||
You can also pass args into a template invocation which are interpolated into the page by `mdbook-template`. See [their docs](https://github.com/sgoudham/mdbook-template#format) for more info | ||
|
||
`\{\}#template {link to template file})\}\}` | ||
|
||
{{#template ../templates/outdated.md}} | ||
|
||
{{#template ../templates/wip.md}} | ||
|
||
{{#template ../templates/stub.md}} | ||
|
||
## admonishments | ||
|
||
All available admonishment types. | ||
|
||
To use an admonishment: | ||
`````` | ||
```admonishment {type} "{text you want as title, or leave blank}" | ||
description | ||
``` | ||
`````` | ||
|
||
```admonish note | ||
``` | ||
|
||
```admonish abstract | ||
``` | ||
|
||
```admonish info | ||
``` | ||
|
||
```admonish tip | ||
``` | ||
|
||
```admonish success | ||
``` | ||
|
||
```admonish question | ||
``` | ||
|
||
```admonish warning | ||
``` | ||
|
||
```admonish failure | ||
``` | ||
|
||
```admonish danger | ||
``` | ||
|
||
```admonish bug | ||
``` | ||
|
||
```admonish example | ||
``` | ||
|
||
```admonish quote | ||
``` | ||
|
||
## latex | ||
|
||
\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\] | ||
|
||
## mermaid | ||
|
||
```mermaid | ||
graph TD; | ||
A-->B; | ||
A-->C; | ||
B-->D; | ||
C-->D; | ||
``` |
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 |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Guide to Editing Docs | ||
|
||
Hello! As you may be able to notice, this docs site is completely open source and free to edit on GitHub. You can see the GitHub page for this site at [https://github.com/space-wizards/docs](https://github.com/space-wizards/docs). | ||
|
||
There are a couple things to keep in mind when contributing. While we disallow web-edit PRs (those made exclusively on GitHub) on the main Space Station 14 & Robust Toolbox repos, that is not the case here. **Web-editing is encouraged** to make editing documentation as painless as possible. | ||
|
||
If you want to get an idea of what features are at your disposal when writing documentation, go to our [Docs Example Page](./docs-example-page.md). | ||
|
||
To start a basic edit of a page, simply follow these steps: | ||
|
||
1. Create an accout on GitHub, or log in if you already have one. | ||
|
||
2. Fork the [space-wizards/docs](https://github.com/space-wizards/docs) repo on GitHub. | ||
|
||
![](../assets/images/meta-create-fork.png) | ||
|
||
3. Click the 'View & Edit Page on GitHub` icon in the very top right of any page on this site. | ||
|
||
![](../assets/images/meta-edit-page-button.png) | ||
|
||
4. Click the 'Edit this file' button at the top right of the file view. | ||
|
||
![](../assets/images/meta-edit-file.png) | ||
|
||
5. Make your changes, then commit & create a pull request! We'll handle the rest. | ||
|
||
More in-depth information for contributors, like how to test locally & port pages from our old docs site, is available on our [README](https://github.com/space-wizards/docs/blob/master/README.md) for the GitHub docs site. |
This file was deleted.
Oops, something went wrong.
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
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