set up mdbook

This adds some new tools in CI for lint the book and also sets up
automated deployment to GitLab Pages. Also adds a readme that suggests
reading the book, since that's where all the information will be.

.gitignore

@@ -12,3 +12,6 @@ result*
 
 # GitLab CI cache
 /.gitlab-ci.d
+
+# mdbook artifacts
+/public

.gitlab-ci.yml

@@ -1,6 +1,7 @@
 stages:
   - ci
   - artifacts
+  - deploy
 
 variables:
   # Makes some things print in color
@@ -48,3 +49,14 @@ artifacts:
   image: nixos/nix:2.18.2
   script:
     - ./bin/nix-build-and-cache packages
+
+pages:
+  stage: deploy
+  image: nixos/nix:2.18.2
+  script:
+    - direnv exec . mdbook build
+  artifacts:
+    paths:
+      - public
+  only:
+    - main

.lycheeignore

@@ -0,0 +1 @@
+.gitignore

.markdownlintignore

@@ -0,0 +1 @@
+.gitignore

README.md

@@ -0,0 +1,9 @@
+# Grapevine
+
+A Matrix homeserver.
+
+## Read the book
+
+[Click here to read the latest version.][0]
+
+[0]: https://matrix.pages.gitlab.computer.surgery/grapevine-fork/

book.toml

@@ -0,0 +1,12 @@
+[book]
+title = "Grapevine"
+language = "en"
+multilingual = false
+src = "book"
+
+[build]
+build-dir = "public"
+
+[output.html]
+git-repository-icon = "fa-git-square"
+git-repository-url = "https://gitlab.computer.surgery/matrix/grapevine-fork"

book/SUMMARY.md

@@ -0,0 +1,3 @@
+# Summary
+
+* [Introduction](./introduction.md)

book/introduction.md

@@ -0,0 +1 @@
+# Introduction

engage.toml

@@ -30,6 +30,26 @@ name = "cargo-clippy"
 group = "versions"
 script = "cargo clippy -- --version"
 
+[[task]]
+name = "lychee"
+group = "versions"
+script = "lychee --version"
+
+[[task]]
+name = "markdownlint"
+group = "versions"
+script = "markdownlint --version"
+
+[[task]]
+name = "lychee"
+group = "lints"
+script = "lychee --offline ."
+
+[[task]]
+name = "markdownlint"
+group = "lints"
+script = "markdownlint ."
+
 [[task]]
 name = "cargo-fmt"
 group = "lints"

nix/shell.nix

@@ -3,6 +3,9 @@
 , engage
 , inputs
 , jq
+, lychee
+, markdownlint-cli
+, mdbook
 , mkShell
 , system
 , toolchain
@@ -27,6 +30,9 @@ mkShell {
     # Keep sorted
     engage
     jq
+    lychee
+    markdownlint-cli
+    mdbook
     toolchain
   ]
   ++