1
1
mirror of https://github.com/wez/wezterm.git synced 2024-11-27 02:25:28 +03:00
Commit Graph

12 Commits

Author SHA1 Message Date
Wez Furlong
fecf3bb60b
docs: add mdbook-admonish 2023-02-25 18:19:47 -07:00
Wez Furlong
d5060ec3c1 docs: use asciinema's web player for screenshots
I've wanted to avoid checking in all the screenshot pics as the png
files change every time I run the generation script, and it bloats
the repo over time.

This commit changes the doc generation step to use the asciinema
web player with the equivalent contents.

Really, it's only a smallish step to go from this to just emitting
the html directly in the doc pages, but I think I might use
the player for some examples in the future.

I think this is still a fine step for now in any case.

While comparing this with the existing screenshots, I noticed the
the Alabaster screen shot png has the wrong color for its rightmost
column: there's an issue in wezterm in parsing the dynamic color
escapes that causes it to pick up the wrong color.

Loading the scheme by name has the correct color and matches
how it is shown as of this commit.
2022-07-09 18:59:44 -07:00
Wez Furlong
2a8ff9ca75 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-03 22:09:17 -07:00
Wez Furlong
93c3a6381d 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 10:13:07 -07:00
Wez Furlong
35060fb2de Revert "ci: disable mdbook-linkcheck"
This reverts commit bef0fa29ac and
bb2d45d0aa.

refs: https://github.com/Michael-F-Bryan/mdbook-linkcheck/issues/53
2021-02-24 09:28:00 -08:00
Wez Furlong
bef0fa29ac ci: disable mdbook-linkcheck
It no longer builds, and switching to an older version produces
errors :-(

refs: https://github.com/Michael-F-Bryan/mdbook-linkcheck/issues/53
2021-02-23 08:10:38 -08:00
Wez Furlong
9a610358d1 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-30 14:14:29 -08:00
Wez Furlong
3d9f341e00 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 10:05:39 -08:00
Wez Furlong
028e928cb2 default to darker styling 2019-12-29 22:05:49 -08:00
Wez Furlong
76c1dff6b3 style download buttons a bit better 2019-12-29 21:39:23 -08:00
Wez Furlong
4681436bd1 docs: code generation for release info 2019-12-29 21:24:08 -08:00
Wez Furlong
a11f036d87 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-29 20:41:08 -08:00