mirror/lighthouse-pulse
1
0
Fork 0
mirror of https://gitlab.com/pulsechaincom/lighthouse-pulse.git synced 2024-12-22 19:50:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
8e7b737912
lighthouse-pulse/book
History
pscott 8e7b737912 Add note about rustup update (#696)
2019-12-11 09:31:25 +11:00
..
src Add note about rustup update (#696) 2019-12-11 09:31:25 +11:00
.gitignore Add newly created mdbook 2019-09-01 11:31:18 +10:00
book.toml Refactor docs into mdbook (#547) 2019-10-02 11:04:56 +10:00
README.md Validator on-boarding docs (#656) 2019-12-09 22:42:36 +11: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.i

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