Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Add a last change footer to the implementers guide #6216

Merged
merged 4 commits into from
Nov 8, 2022
Merged
Show file tree
Hide file tree
Changes from 2 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
2 changes: 2 additions & 0 deletions roadmap/implementers-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Then install and build the book:

```sh
cargo install mdbook mdbook-linkcheck mdbook-graphviz mdbook-mermaid
# This plugin is not available on crates.io yet.
cargo install --git https://github.com/badboy/mdbook-last-changed/ --rev 2448157
mdbook serve roadmap/implementers-guide
open http://localhost:3000
```
Expand Down
6 changes: 6 additions & 0 deletions roadmap/implementers-guide/book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,14 @@ title = "The Polkadot Parachain Host Implementers' Guide"
command = "mdbook-graphviz"
[preprocessor.mermaid]
command = "mdbook-mermaid"
[preprocessor.last-changed]
command = "mdbook-last-changed"
renderer = ["html"]

[output.html]
additional-css = ["last-changed.css"]
additional-js = ["mermaid.min.js", "mermaid-init.js"]
# Repository URL used in the last-changed link.
git-repository-url = "https://github.com/paritytech/polkadot"

[output.linkcheck]
7 changes: 7 additions & 0 deletions roadmap/implementers-guide/last-changed.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
footer {
font-size: 0.8em;
text-align: center;
margin-top: 50px;
border-top: 1px solid black;
padding: 5px 0;
}
2 changes: 2 additions & 0 deletions scripts/ci/gitlab/pipeline/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ build-implementers-guide:
script:
- apt-get -y update; apt-get install -y graphviz
- cargo install mdbook mdbook-mermaid mdbook-linkcheck mdbook-graphviz
# This plugin is not available on crates.io yet.
- cargo install --git https://github.com/badboy/mdbook-last-changed/ --rev 2448157
- mdbook build ./roadmap/implementers-guide
- mkdir -p artifacts
- mv roadmap/implementers-guide/book artifacts/
Expand Down