microsoft/openvmm
Publicmirrored from https://github.com/microsoft/openvmmAvailable
Guide/src/dev_guide/contrib/guide.md
32lines · modecode
| 1 | # Updating this Guide |
| 2 | |
| 3 | We gladly welcome PRs that improve the quality of the OpenVMM guide! |
| 4 | |
| 5 | The OpenVMM Guide is written in Markdown, and rendered to HTML using |
| 6 | [mdbook](https://github.com/rust-lang/mdBook). You can find the source-code of |
| 7 | this Guide in the main OpenVMM GitHub repo, in the |
| 8 | [`Guide/`](https://github.com/microsoft/openvmm/tree/main/Guide) folder. |
| 9 | |
| 10 | For small changes, you can simply click the "Suggest an Edit" button in the |
| 11 | top-right corner of any page to automatically open up a GitHub Edit page. |
| 12 | |
| 13 | For larger changes, we suggest cloning the repo locally, and previewing changes |
| 14 | to Markdown in your editor (Visual Studio Code has good support for this). |
| 15 | |
| 16 | ## Building locally |
| 17 | |
| 18 | If you want a full rendered copy of the guide locally, you can build one by |
| 19 | installing mdbook: |
| 20 | |
| 21 | ``` |
| 22 | cargo install mdbook |
| 23 | ``` |
| 24 | |
| 25 | Then from the root directory of the repo, running: |
| 26 | |
| 27 | ``` |
| 28 | mdbook serve Guide |
| 29 | ``` |
| 30 | |
| 31 | And navigating to the localhost URL in your web browser (typically |
| 32 | `http://127.0.0.1:3000/`) |