lighthouse/book
Pawan Dhananjay 3ab9d3a84e
Add a cli option for the snapshot cache size (#5270)
* Add a cli option for snapshot cache size

* Remove junk

* Make snapshot_cache module public

* lint

* Update docs
2024-02-26 05:19:39 +00:00
..
src Add a cli option for the snapshot cache size (#5270) 2024-02-26 05:19:39 +00: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

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