Skip to content

Commit

Permalink
update tooling (#19)
Browse files Browse the repository at this point in the history
* new mdbook versions
* nim syntax highlighting
* add admonish plugin
  • Loading branch information
arnetheduck authored Nov 8, 2023
1 parent 6dde1b0 commit 52a1e1f
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 5 deletions.
11 changes: 8 additions & 3 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,22 @@ jobs:
with:
crate: mdbook
use-tool-cache: true
version: "0.4.28"
version: "0.4.35"
- uses: actions-rs/[email protected]
with:
crate: mdbook-toc
use-tool-cache: true
version: "0.11.2"
version: "0.14.1"
- uses: actions-rs/[email protected]
with:
crate: mdbook-open-on-gh
use-tool-cache: true
version: "2.3.3"
version: "2.4.1"
- uses: actions-rs/[email protected]
with:
crate: mdbook-admonish
use-tool-cache: true
version: "1.13.1"
- name: Build book
run: |
PATH=.cargo/bin:$PATH mdbook build
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,20 @@ An ever evolving collection of conventions, idioms and tricks that reflects the
The style guide is built using [mdBook](https://github.com/rust-lang/mdBook), and published to gh-pages using a github action.

```bash
# Install tooling
cargo install mdbook mdbook-toc mdbook-open-on-gh
# Install or update tooling (make sure you add "~/.cargo/bin" to PATH):
cargo install mdbook --version 0.4.35
cargo install mdbook-toc --version 0.14.1
cargo install mdbook-open-on-gh --version 2.4.1
cargo install mdbook-admonish --version 1.13.1

# Edit book and view through local browser
mdbook serve
```

## Update theme

Follow [instructions](https://github.com/ehuss/mdBook/blob/master/CONTRIBUTING.md#updating-higlightjs), adding `nim`.

## Contributing

We welcome contributions to the style guide as long as they match the strict security requirements Status places on Nim code. As with any style guide, some of it comes down to taste and we might reject them based on consistency or whim.
Loading

0 comments on commit 52a1e1f

Please sign in to comment.