-
Notifications
You must be signed in to change notification settings - Fork 0
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
2 changed files
with
15 additions
and
1 deletion.
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,2 +1,4 @@ | ||
| book | ||
| /.idea | ||
| /.idea | ||
| mdbook | ||
| mdbook.* |
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 +1,13 @@ | ||
| # GoA2Wiki | ||
|
|
||
| ## Local Testing | ||
| 1. Download the appropriate [mdBook](https://github.com/rust-lang/mdBook/releases/v0.4.36/) version for your OS. | ||
| 2. Place the extracted mdBook(.exe) file either inside this repository or inside a directory on your [path](https://en.wikipedia.org/wiki/PATH_(variable)). | ||
| 3. Run the command `mdbook serve --open` | ||
|
|
||
| ## Contributing | ||
| * All source files are inside `src/` and are written in [Markdown](https://www.markdownguide.org/) | ||
| * `SUMMARY.md` is the bar on the left, edit that to add new pages. | ||
|
|
||
| ## Building & Publishing | ||
| GitHub actions handle this for us. No need to worry about it. |