wezterm/docs/book.toml

[book]
title = "Wez's Terminal Emulator"
author = "Wez Furlong"
src = "."

[build]
build-dir = "../gh_pages"
create-missing = false

[output.html]
additional-css = ["custom.css"]
default-theme = "ayu"
preferred-dark-theme = "ayu"
git-repository-url = "https://github.com/wez/wezterm"
additional-js = ["mermaid.min.js", "mermaid-init.js"]

[output.html.fold]
enable = true
level = 1

[output.linkcheck]
traverse-parent-directories = false

[preprocessor]

[preprocessor.mermaid]
command = "mdbook-mermaid"
Start migrating to mdbook for the docs Build the docs by installing mdbook and then running: `mdbook build docs` or run them live with `mdbook serve docs` 2019-12-30 07:41:08 +03:00			`[book]`
			`title = "Wez's Terminal Emulator"`
			`author = "Wez Furlong"`
			`src = "."`

			`[build]`
			`build-dir = "../gh_pages"`
			`create-missing = false`
style download buttons a bit better 2019-12-30 08:39:23 +03:00
			`[output.html]`
			`additional-css = ["custom.css"]`
docs: tweak mdbook config * Sets wezterm's icon as the favicon * enable github link back to the repo * Default to Ayu color scheme 2020-12-26 21:05:39 +03:00			`default-theme = "ayu"`
			`preferred-dark-theme = "ayu"`
			`git-repository-url = "https://github.com/wez/wezterm"`
docs: adopt mermaid-js for flowchart This is a bit more compact and easier to edit. A downside is that the search engine highlight can break the diagram and cause it to emit a syntax error. 2022-04-04 08:09:17 +03:00			`additional-js = ["mermaid.min.js", "mermaid-init.js"]`
docs: upgrade to mdbook 0.4, enable link checking Standardize on `thing.md` rather than `thing.markdown` to make it easier to cross link. 2021-01-31 01:14:29 +03:00
docs: enable folding in navigation area This helps to avoid being overwhelmed by the number of pages! refs: https://github.com/rust-lang/mdBook/issues/1724 2022-01-09 20:13:07 +03:00			`[output.html.fold]`
			`enable = true`
			`level = 1`

Revert "ci: disable mdbook-linkcheck" This reverts commit bef0fa29ac7e7dccc4e119d4ec9070e0767a539c and bb2d45d0aa930245188c17f7695663e4f3becbb3. refs: https://github.com/Michael-F-Bryan/mdbook-linkcheck/issues/53 2021-02-24 20:27:13 +03:00			`[output.linkcheck]`
			`traverse-parent-directories = false`
docs: adopt mermaid-js for flowchart This is a bit more compact and easier to edit. A downside is that the search engine highlight can break the diagram and cause it to emit a syntax error. 2022-04-04 08:09:17 +03:00
			`[preprocessor]`

			`[preprocessor.mermaid]`
			`command = "mdbook-mermaid"`