Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

P1 #1

Merged
merged 4 commits into from
Jan 7, 2023
Merged

P1 #1

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .github/workflows/book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
paths:
- 'book/**'
- 'book.toml'

pull_request:
branches: [master]
paths:
Expand All @@ -23,6 +24,8 @@ jobs:
run: |
mkdir mdbook
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.21/mdbook-v0.4.21-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
curl -sSL https://github.com/tommilligan/mdbook-admonish/releases/download/v1.8.0/mdbook-admonish-v1.8.0-x86_64-unknown-linux-gnu.tar.gz| tar -xz --directory=./mdbook
curl -sSL https://github.com/badboy/mdbook-mermaid/releases/download/v0.12.6/mdbook-mermaid-v0.12.6-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
echo `pwd`/mdbook >> $GITHUB_PATH

- name: Install mdbook-template
Expand All @@ -32,7 +35,10 @@ jobs:
echo `pwd`/mdbook-template >> $GITHUB_PATH

- name: Build
run: mdbook build
run: |
mdbook-admonish install
mdbook-mermaid install
mdbook build

- name: Save pages artifact
uses: actions/upload-pages-artifact@v1
Expand Down
29 changes: 28 additions & 1 deletion book/getting-started/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,31 @@ This documentation contains a collection of examples demonstrating how to use th

Each example includes a detailed description of the functionality being demonstrated, as well as complete code snippets that you can use as a starting point for your own projects.

We hope that these docs will help you get started with ethers-rs and give you a better understanding of how to use the library to build your own web3 applications in Rust. If you have any questions or need further assistance, please don't hesitate to reach out to the ethers-rs community.
We hope that these docs will help you get started with ethers-rs and give you a better understanding of how to use the library to build your own web3 applications in Rust. If you have any questions or need further assistance, please don't hesitate to reach out to the ethers-rs community.


# Section Test

## Admonition Blocks

```admonish info
A beautifully styled message.
```

```admonish example
My example is the best!
```

```admonish
A plain note.
```

## Mermaid Diagrams

```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```