| commit | fafcdd2bfec312db9b0752ec3d51c057a6d7ec11 | [log] [tgz] |
|---|---|---|
| author | Jim Shargo <jshargo@chromium.org> | Fri Jul 22 18:54:20 2022 |
| committer | Jim Shargo <jshargo@chromium.org> | Fri Jul 22 20:57:56 2022 |
| tree | 220413a1bd2e5481a3bbcce7b18f1e663240c776 | |
| parent | defa2b39ad43c2887e860dad620370b84b9636f2 [diff] |
book: Add support for logging git revision (about.md) We can now add the book's current git revision to pages. Eventually, this can be used to track divergence between what's running live and what's at HEAD. To do this, we add some machinery to our preprocessor. It will make it easy should we want to extend this in the future. For now, we've added this to the end of the "about.md" page. Change-Id: I757f419638e2d1532784972cda7a9d9a1bc0fa78 Reviewed-on: https://chromium-review.googlesource.com/c/graphics-book/+/3781185 Reviewed-by: Jim Shargo <jshargo@chromium.org>
This is the source code for a public book and living document capturing the high level architecture and low-level details of graphics in Chrome and ChromeOS.
This book is currently written with https://rust-lang.github.io/mdBook/
This mdbook supports some homebrew markdown extensions. These are provided by scripts/preprocess-graphics-book.py.
One can create in-line nomnoml diagrams by formatting a code block like so:
``` diagram=nomnoml [foo] -> [bar] ```
We also support special text replacements:
First, install mdbook following the guide [0].
Then, to build and run the book locally, run the command mdbook serve. This will start a local server that you can connect to at localhost:3000.
[0] https://rust-lang.github.io/mdBook/guide/installation.html
The book is currently deployed at firebase. The public URL is https://graphics-book.web.app.
With the appropriate permissions on the project, one can build and push the book like so:
$ mdbook build && firebase deploy