diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml index 9de50ff..d697f55 100644 --- a/.github/workflows/book.yml +++ b/.github/workflows/book.yml @@ -15,8 +15,14 @@ jobs: uses: peaceiris/actions-mdbook@v1 with: mdbook-version: '0.4.14' + - name: Install static-sitemap-cli + run: npm install static-sitemap-cli - name: Build run: mdbook build + - name: Generate sitemap + run: | + cd book + npx sscli --no-clean --base https://iamb.chat - name: Deploy uses: peaceiris/actions-gh-pages@v3 if: ${{ github.ref == 'refs/heads/main' }} diff --git a/book.toml b/book.toml index e6347ad..5d8537a 100644 --- a/book.toml +++ b/book.toml @@ -4,6 +4,7 @@ language = "en" multilingual = false src = "src" title = "iamb documentation" +description = "Documentation for the iamb Matrix client" [output.html] curly-quotes = true diff --git a/src/development.md b/src/development.md index e0c5722..c1a74c2 100644 --- a/src/development.md +++ b/src/development.md @@ -17,6 +17,8 @@ rustup toolchain install nightly --component rustfmt You will also likely want to use [rust-analyzer] during your development. Refer to its documentation for help on setting it up in your preferred editor. +## Programming In Rust + If you are new to Rust, some helpful resources to learn or refer to are: - [The Rust Book](https://doc.rust-lang.org/book/) (or [an alternative version](https://rust-book.cs.brown.edu/) with quizzes and visualizations) @@ -27,7 +29,7 @@ If you are new to Rust, some helpful resources to learn or refer to are: You can find more resources on [the Rust website](https://www.rust-lang.org/learn). At some point while working on __iamb__, you will have to touch one of its -dependencies. Some of the libraries you may whose docs you may need are: +dependencies. Some of the libraries whose docs you may need are: - [matrix-sdk] - [modalkit] diff --git a/theme/head.hbs b/theme/head.hbs new file mode 100644 index 0000000..7f5cb7a --- /dev/null +++ b/theme/head.hbs @@ -0,0 +1,34 @@ +{{#with { + "meta": { + "index.md": { "canonical": "", "keywords": "" }, + "commands.md": { "canonical": "commands.html", "keywords": ", commands" }, + "e2ee/keys.md": { "canonical": "e2ee/keys.html", "keywords": ", e2ee, room keys" }, + "e2ee/verify.md": { "canonical": "e2ee/verify.html", "keywords": ", e2ee, verification" }, + "e2ee/index.md": { "canonical": "e2ee/", "keywords": "" }, + "rooms/management.md": { "canonical": "rooms/management.html", "keywords": ", rooms" }, + "rooms/index.md": { "canonical": "rooms/", "keywords": "" }, + "rooms/browsing.md": { "canonical": "rooms/browsing.html", "keywords": "" }, + "rooms/members.md": { "canonical": "rooms/members.html", "keywords": ", users, members" }, + "configure.md": { "canonical": "configure.html", "keywords": ", configuration" }, + "development.md": { "canonical": "development.html", "keywords": ", development, rust" }, + "install.md": { "canonical": "install.html", "keywords": ", install" }, + "layout/index.md": { "canonical": "layout/", "keywords": "" }, + "layout/tabs.md": { "canonical": "layout/tabs.html", "keywords": ", tab management" }, + "layout/windows.md": { "canonical": "layout/windows.html", "keywords": ", window management" }, + "keybindings.md": { "canonical": "keybindings.html", "keywords": ", keybindings" }, + "messages/index.md": { "canonical": "messages/", "keywords": ", messages" } + } +} }} + +{{#each meta}} +{{#if (eq ../../path @key)}} +{{#with this}} + + + + +{{/with}} +{{/if}} +{{/each}} + +{{/with}}