Commit Graph
15 Commits
Author SHA1 Message Date
Wez Furlong f65e985e64 docs: add since macro. document connection metadata object 2023-06-28 13:52:15 -07:00
Wez Furlong 0cf6a16ef2 allow running ./docs/build.sh serve to build and serve docs
Any arguments you pass to it will be passed through to mkdocs
2023-03-23 08:28:17 -07:00
Wez Furlong 6b9b01eca0 disable social media cards in local builds
Enable it for the final deploy
2023-03-13 15:38:18 -07:00
Wez Furlong 3a1b1053bd docs: add link checking
Ideally there would be a good mkdocs based checker, but the
one that is out there only validate absolute URLs, which makes
it unsuitable for checking local relative links in the docs.

Adjust the doc build so that we also generate the SUMMARY.md
for mdbook, and use mdbook's link checker to check the links.

Fixup the couple of broken links that it found.
2023-03-13 12:01:07 -07:00
Wez Furlong 52d204984a docs: install exclude plugin to exlude stuff better
Previously, I was cleaning up some junk like _index directories
generated from the _index.md fragments. I noticed that those
were showing up in the search index, so it is better to exclude
from the outset. mkdocs doesn't natively support the idea of
exclusion, but there is a plugin that does, so use it.
2023-03-11 23:27:49 -07:00
Wez Furlong 77b91cf3cc docs: adjust PATH for pip 2023-03-11 22:30:11 -07:00
Wez Furlong a841b1e635 docs: do black formatting in docs/build.sh
This way it should get included in the automated fixup commit
performed by the workflow
2023-03-11 20:41:44 -07:00
Wez Furlong f0c893582e switch from mdbook to mkdocs 2023-03-11 20:13:54 -07:00
Wez Furlong c1f0daa2a3 docs/build.sh: just run on all md files
I'd carried over behavior from wezterm where we only considered
tracked markdown files, which could be confusing for newly
authored files: they wouldn't get considered or updated until
they had been committed.
2023-03-11 06:54:59 -07:00
Wez Furlong a40cf617d3 docs/build.sh: always enable coloring in output
should make it easier to spot the source of the issue
2023-03-11 06:46:07 -07:00
Wez Furlong bf99848ef0 ci: surface unformatted lua code errors pushed to main
the pages workflow silently corrects these so they go unnoticed,
leaving the corrections to show up for the next person to run
`docs/build.sh`, polluting their later commit with unrelated
changes.

Augment the verify-pages workflow to also run on `main` and
surface the corrections with a failed workflow run.
2023-03-11 06:11:58 -07:00
Wez Furlong 3e97cea1f6 docs build: simplify dep logic a little 2023-03-07 11:31:01 -07:00
Wez Furlong a0c0107a54 docs: install mdbook-admonish
See: https://tommilligan.github.io/mdbook-admonish/overview.html
https://tommilligan.github.io/mdbook-admonish/reference.html
2023-02-25 15:08:54 -07:00
Wez Furlong c8a8d7da00 docs: install gelatyx earlier 2023-02-25 11:24:37 -07:00
Wez Furlong 831bfe9aab docs: skeleton for building the docs
Rather than edit SUMMARY.md, you edit docs/generate-toc.py
and it will flesh out sections based on the list of files
in a directory.
2023-02-25 10:50:58 -07:00