add mdbook-katex, add typos GHA, add docs intro page

This commit is contained in:
arnaucube
2024-03-29 19:13:49 +01:00
parent 071ba0750a
commit c3e598b184
6 changed files with 55 additions and 0 deletions

View File

@@ -23,6 +23,7 @@ jobs:
runs-on: ubuntu-latest
env:
MDBOOK_VERSION: 0.4.36
MDBOOKKATEX_VERSION: 0.7.0
steps:
- uses: actions/checkout@v4
- name: Install mdBook
@@ -30,6 +31,7 @@ jobs:
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
rustup update
cargo install --version ${MDBOOK_VERSION} mdbook
cargo install --version ${MDBOOKKATEX_VERSION} mdbook-katex
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4

2
.github/workflows/typos.toml vendored Normal file
View File

@@ -0,0 +1,2 @@
[default.extend-words]
groth = "groth"

18
.github/workflows/typos.yml vendored Normal file
View File

@@ -0,0 +1,18 @@
name: typos
on:
push:
branches:
- main
jobs:
typos:
if: github.event.pull_request.draft == false
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Use typos with config file
uses: crate-ci/typos@master
with:
config: .github/workflows/typos.toml