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 all 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
7 changes: 4 additions & 3 deletions roadmap/implementers-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ The implementers' guide is compiled from several source files with [`mdBook`](ht

## Hosted build

This is avalible at https://paritytech.github.io/polkadot/book/
This is available [here](https://paritytech.github.io/polkadot/book/).

## Local build

To view it locally from the repo root:

Ensure graphviz is installed:

```sh
brew install graphviz # for macOS
sudo apt-get install graphviz # for Ubuntu/Debian
Expand All @@ -19,11 +20,11 @@ sudo apt-get install graphviz # for Ubuntu/Debian
Then install and build the book:

```sh
cargo install mdbook mdbook-linkcheck mdbook-graphviz mdbook-mermaid
cargo install mdbook mdbook-linkcheck mdbook-graphviz mdbook-mermaid mdbook-last-changed
mdbook serve roadmap/implementers-guide
open http://localhost:3000
```

## Specification

See also the Polkadot specificaton [hosted](https://spec.polkadot.network/), and it's [source](https://github.com/w3f/polkadot-spec)).
See also the Polkadot specification [hosted](https://spec.polkadot.network/), and its [source](https://github.com/w3f/polkadot-spec).
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: 1 addition & 1 deletion scripts/ci/gitlab/pipeline/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ build-implementers-guide:
- .collect-artifacts-short
script:
- apt-get -y update; apt-get install -y graphviz
- cargo install mdbook mdbook-mermaid mdbook-linkcheck mdbook-graphviz
- cargo install mdbook mdbook-mermaid mdbook-linkcheck mdbook-graphviz mdbook-last-changed
- mdbook build ./roadmap/implementers-guide
- mkdir -p artifacts
- mv roadmap/implementers-guide/book artifacts/
Expand Down