Skip to content

Commit ebc6760

Browse files
authored
Merge pull request #87 from silicon-heaven/update-mdbook
Update mdbook
2 parents 900100a + 4c0ea82 commit ebc6760

4 files changed

Lines changed: 21 additions & 11 deletions

File tree

.github/workflows/mdbook.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,18 @@ jobs:
3131
build:
3232
runs-on: ubuntu-latest
3333
env:
34-
MDBOOK_VERSION: 0.4.50
35-
MDBOOK_PAGETOC_VERSION: 0.2.0
36-
MDBOOK_LINKCHECK_VERSION: 0.7.7
34+
MDBOOK_VERSION: --version 0.5.3
35+
MDBOOK_PAGETOC_VERSION: --version 0.3.0
36+
MDBOOK_LINKCHECK_VERSION: --git https://github.com/Michael-F-Bryan/mdbook-linkcheck --rev ed981be6ded11562e604fff290ae4c08f1c419c5
37+
MDBOOK_OPEN_ON_GH_VERSION: --version 3.0.0
3738
steps:
3839
- uses: actions/checkout@v4.2.2
3940
- name: Install mdBook
4041
run: |
41-
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
42-
rustup update
43-
cargo install --version '${{env.MDBOOK_VERSION}}' mdbook
44-
cargo install --version '${{env.MDBOOK_PAGETOC_VERSION}}' mdbook-pagetoc
45-
cargo install --version '${{env.MDBOOK_LINKCHECK_VERSION}}' mdbook-linkcheck
42+
cargo install ${{env.MDBOOK_VERSION}} mdbook
43+
cargo install ${{env.MDBOOK_PAGETOC_VERSION}} mdbook-pagetoc
44+
cargo install ${{env.MDBOOK_OPEN_ON_GH_VERSION}} mdbook-open-on-gh
45+
cargo install ${{env.MDBOOK_LINKCHECK_VERSION}} mdbook-linkcheck
4646
- name: Setup Pages
4747
id: pages
4848
uses: actions/configure-pages@v5.0.0

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
book
2-
theme

book.toml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
[book]
22
authors = ["Fanda Vacek"]
33
language = "en"
4-
multilingual = false
54
src = "src"
65
title = "SHV RPC Documentation"
76

87
[preprocessor.pagetoc]
98

9+
[preprocessor.open-on-gh]
10+
command = "mdbook-open-on-gh"
11+
renderer = ["html"]
12+
git-branch = "master"
13+
1014
[output.html]
11-
additional-css = ["theme/pagetoc.css"]
15+
additional-css = ["theme/pagetoc.css", "theme/open-in.css"]
1216
additional-js = ["theme/pagetoc.js"]
17+
git-repository-url = "https://github.com/silicon-heaven/shv-doc"
1318
[output.linkcheck]

theme/open-in.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
footer {
2+
font-size: 0.8em;
3+
text-align: center;
4+
border-top: 1px solid black;
5+
padding: 5px 0;
6+
}

0 commit comments

Comments
 (0)