Skip to content

Commit

Permalink
Add information about running the documentation locally.
Browse files Browse the repository at this point in the history
  • Loading branch information
CakeVR committed Dec 6, 2023
1 parent bde187e commit 5f7e166
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,20 @@ A preprocessor decides how the book's chapters will be modified before building
The preprocessors are not part of the built-in feature set and were developed by other developers.\
They must be installed, see the [`.github/workflows/mdbook.yml`](https://github.com/dialogic-godot/documentation/blob/main/.github/workflows/mdbook.yml) for this.

## Run the documentation locally
To build the documentation, we need its software `mdBook`, which is written in the Rust Language

1. First, install Rust: https://www.rust-lang.org/tools/install
Open a new console, this allows `cargo` to function and makes the following commands possible.

2. Let's install `mdBook`: `cargo install mdbook`

3. We need to install the preprocessor for the admonish feature: `cargo install mdbook-admonish`

4. Finally, you can run this command inside this project's root: `mdbook serve --open`

The workflow is also described in the [.github/workflows/mdbook.yml](https://github.com/dialogic-godot/documentation/blob/main/.github/workflows/mdbook.yml) file.

## Admonish
The documentation supports admonish. We use a preprocessor for this.
You can create these by using the following syntax, using `info` as an example category:
Expand Down

0 comments on commit 5f7e166

Please sign in to comment.