-
Notifications
You must be signed in to change notification settings - Fork 180
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
1 parent
ff8cb8b
commit a8f7d31
Showing
2 changed files
with
33 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 |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Contributing to the Anki manual | ||
|
||
## Local development | ||
|
||
anki-manual is built using [mdBook](https://rust-lang.github.io/mdBook/), a Rust-based tool for creating webpages using Markdown. | ||
|
||
### Install dependencies | ||
|
||
In order to use mdBook, please first ensure that you have [Rust](https://www.rust-lang.org/tools/install) installed on your machine. | ||
|
||
Next, install mdBook and its pre-processors | ||
``` | ||
cargo install mdbook | ||
cargo install mdbook-toc | ||
cargo install mdbook-linkcheck | ||
``` | ||
|
||
### Develop and preview | ||
|
||
To serve anki-manual locally, build the book with | ||
|
||
``` | ||
mdbook build | ||
``` | ||
|
||
and then serve anki-manual with | ||
|
||
``` | ||
mdbook serve --open | ||
``` | ||
|
||
You can now make changes to the markdown (*.md) files in the `src/` directory and have your changes previewed locally. |
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