2019-10-02 01:04:56 +00:00
|
|
|
# Lighthouse Book
|
|
|
|
|
|
|
|
|
|
Contains an [mdBook](https://github.com/rust-lang-nursery/mdBook) that serves
|
|
|
|
|
as the primary source of Lighthouse user documentation.
|
|
|
|
|
|
2020-04-16 10:31:43 +00:00
|
|
|
The book is hosted at [lighthouse-book.sigmaprime.io](http://lighthouse-book.sigmaprime.io)
|
2019-10-02 01:04:56 +00:00
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
The [mdBook docs](https://github.com/rust-lang-nursery/mdBook#usage) are the
|
|
|
|
|
best source of information for building the book.
|
|
|
|
|
|
|
|
|
|
### Example
|
|
|
|
|
|
|
|
|
|
1. Install mdBook: `$ cargo install mdbook`
|
|
|
|
|
1. Build the book, open it in a browser and build after file changes: `$ mdbook
|
2019-12-09 11:42:36 +00:00
|
|
|
serve --open`
|
