mirror of
https://github.com/arnaucube/sonobe-docs.git
synced 2026-02-10 05:06:45 +01:00
add mdbook-katex, add typos GHA, add docs intro page
This commit is contained in:
2
.github/workflows/mdbook.yml
vendored
2
.github/workflows/mdbook.yml
vendored
@@ -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
2
.github/workflows/typos.toml
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
[default.extend-words]
|
||||
groth = "groth"
|
||||
18
.github/workflows/typos.yml
vendored
Normal file
18
.github/workflows/typos.yml
vendored
Normal 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
|
||||
|
||||
Reference in New Issue
Block a user