mirror of
https://github.com/hl-archive-node/nanoreth.git
synced 2025-12-06 10:59:55 +00:00
docs: add book skeleton (#44)
* docs: add book skeleton * ci: add book test workflow
This commit is contained in:
29
.github/workflows/book.yml
vendored
Normal file
29
.github/workflows/book.yml
vendored
Normal file
@ -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
|
||||
9
book.toml
Normal file
9
book.toml
Normal file
@ -0,0 +1,9 @@
|
||||
[book]
|
||||
authors = ["reth Core Contributors"]
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "book"
|
||||
title = "reth Book"
|
||||
|
||||
[build]
|
||||
build-dir = "target/book"
|
||||
5
book/README.md
Normal file
5
book/README.md
Normal file
@ -0,0 +1,5 @@
|
||||
# reth Book
|
||||
|
||||
*Documentation for reth users.*
|
||||
|
||||
reth is an Ethereum execution client.
|
||||
3
book/SUMMARY.md
Normal file
3
book/SUMMARY.md
Normal file
@ -0,0 +1,3 @@
|
||||
# Summary
|
||||
|
||||
- [Introduction](./README.md)
|
||||
Reference in New Issue
Block a user