mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-03 00:31:50 +00:00
6883e1bfb6
## Issue Addressed https://github.com/sigp/lighthouse/issues/2889 ## Additional Info I have checked that linkcheck has succeeded on the book built locally. 👌 ```shell $ cd book $ mdbook serve --open ... 2022-01-14 01:13:40 [INFO] (mdbook::book): Book building has started 2022-01-14 01:13:40 [INFO] (mdbook::book): Running the html backend $ linkcheck http://localhost:3000 Perfect. Checked 4495 links, 80 destination URLs (76 ignored). ``` Also I'll tackle running linkcheck on CI in another pull request.
Lighthouse Book
Contains an mdBook that serves as the primary source of Lighthouse user documentation.
The book is hosted at lighthouse-book.sigmaprime.io
Usage
The mdBook docs are the best source of information for building the book.
Example
- Install mdBook:
$ cargo install mdbook - Build the book, open it in a browser and build after file changes:
$ mdbook serve --open