add gh-pages action to autodeploy rendered site

This commit is contained in:
arnaucube 2025-01-31 10:29:04 +01:00
parent f8cd1ed0b6
commit 5bb98e2645
2 changed files with 58 additions and 0 deletions

View file

@ -2,5 +2,9 @@
> Hackmds for sharing ideas, once there is consensus around it, move it into this repo to consolidate it. Also we can use PRs to discuss asynchronously specific ideas of the spec.
## Usage
A rendered version of the site can be found at: https://0xparc.github.io/pod2-docs/
To run it locally:
- Needs [mdbook](https://github.com/rust-lang/mdBook), to install: `cargo install mdbook`
- Needs [mdbook-katex](https://github.com/lzanini/mdbook-katex), to install: `cargo install mdbook-katex`
- Run locally: `mdbook serve`