osrf / ros2multirobotbook

Creative Commons Attribution 4.0 International
123 stars 32 forks source link

github pages

ros2multirobotbook

Greetings. Welcome to ros2multirobotbook. We hope you enjoy your stay.

The book is automatically compiled by changes to this repo. The compiled book can be accessed here:

https://osrf.github.io/ros2multirobotbook/

Compiling the book locally (Ubuntu)

It's convenient to compile the book locally when making edits. The following steps will help you install the necessary tools.

Dependencies

Install these system dependencies:

sudo apt-get install libfontconfig1-dev libgraphite2-dev libharfbuzz-dev libicu-dev libssl-dev zlib1g-dev

Then install Rust and Cargo (if you don't have them already) by following the instructions at this link:

Now use cargo to install mdbook:

cargo install mdbook mdbook-open-on-gh

Compiling the book

mdbook build

Then you can view the output:

firefox book/index.html

Alternatively, mdbuild can automatically trigger a rebuild on edits to any source file:

mdbook watch