https://github.com/roapi/docs
ROAPI user documentation
https://github.com/roapi/docs
Last synced: 3 months ago
JSON representation
ROAPI user documentation
- Host: GitHub
- URL: https://github.com/roapi/docs
- Owner: roapi
- Created: 2021-02-21T21:42:18.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-22T19:07:00.000Z (7 months ago)
- Last Synced: 2025-10-21T03:57:16.071Z (3 months ago)
- Language: Handlebars
- Homepage: https://roapi.github.io/docs
- Size: 2.52 MB
- Stars: 55
- Watchers: 2
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ROAPI Document
The official `ROAPI` website based on [mdBook](https://github.com/rust-lang/mdBook).
## Preparation
Install `mdbook` and `open-on-gh`
```sh
$ cargo install mdbook
$ cargo install mdbook-open-on-gh
```
## Build Instructions
1. Fork this repository
2. Clone in your local machine
```sh
$ git clone https://github.com//docs.git
```
3. Build
```sh
$ mdbook build
```
You can use `watch` instead.
```sh
$ mdbook watch --open
```
It's useful to open and watch the rendered book on every file change.