mirror/lighthouse-pulse
1
0
Fork 0
mirror of https://gitlab.com/pulsechaincom/lighthouse-pulse.git synced 2024-12-27 06:27:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
d90bd648d8
lighthouse-pulse/book
History
Paul Hauner 66f183be02
Update docs for Altona (#1304)
2020-06-28 16:04:03 +10:00
..
src Update docs for Altona (#1304) 2020-06-28 16:04:03 +10:00
.gitignore Add newly created mdbook 2019-09-01 11:31:18 +10:00
book.toml Update HTTP API docs (#1010) 2020-04-16 20:31:43 +10:00
README.md Update HTTP API docs (#1010) 2020-04-16 20:31:43 +10:00

README.md

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

  1. Install mdBook: $ cargo install mdbook
  2. Build the book, open it in a browser and build after file changes: $ mdbook serve --open