diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml new file mode 100644 index 000000000..0aecf090c --- /dev/null +++ b/.github/workflows/book.yml @@ -0,0 +1,29 @@ +name: book +on: + push: + branches: [main] + paths: + - 'book/**' + - 'book.toml' + pull_request: + branches: [main] + paths: + - 'book/**' + - 'book.toml' + +jobs: + test: + runs-on: ubuntu-latest + name: test + + steps: + - uses: actions/checkout@v3 + + - name: Install mdbook + run: | + mkdir mdbook + curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook + echo `pwd`/mdbook >> $GITHUB_PATH + + - name: Run tests + run: mdbook test diff --git a/book.toml b/book.toml new file mode 100644 index 000000000..35521bb78 --- /dev/null +++ b/book.toml @@ -0,0 +1,9 @@ +[book] +authors = ["reth Core Contributors"] +language = "en" +multilingual = false +src = "book" +title = "reth Book" + +[build] +build-dir = "target/book" \ No newline at end of file diff --git a/book/README.md b/book/README.md new file mode 100644 index 000000000..1411ac2b7 --- /dev/null +++ b/book/README.md @@ -0,0 +1,5 @@ +# reth Book + +*Documentation for reth users.* + +reth is an Ethereum execution client. \ No newline at end of file diff --git a/book/SUMMARY.md b/book/SUMMARY.md new file mode 100644 index 000000000..2de157bc7 --- /dev/null +++ b/book/SUMMARY.md @@ -0,0 +1,3 @@ +# Summary + +- [Introduction](./README.md)