aboutsummaryrefslogtreecommitdiff
path: root/mdbook
AgeCommit message (Collapse)Author
2024-02-14prop348-refNick Mathewson
2023-11-09Reorganize outputJim Newsome
Adding an additional output plugin to mdbook causes it to create an extra level of subdirectories in its build directory; one for each output plugin. We add an intermediate build directory `build`, and after building the individual mdbooks, construct the `html` directory with the desired layout.
2023-11-09Use mdbook-linkcheck to detect missing defs for ref-style linksJim Newsome
Suppose in raw markdown we have: ```markdown See [foo][barr]. [bar]: https://link-to-bar ``` The intent is to link the text "foo", but because of a typo it used the label barr instead of bar. The result is that the rendered html won't have a link at all. The text will be rendered literally as `[foo][barr]`. Since there's no link (not even a broken one), a link checker run over the rendered output won't spot the problem. The mdbook-linkcheck plugin correctly detects this issue. However, it doesn't understand links that go between our two mdbook projects since the relative paths in the source don't match the relative paths in the rendered output. Since checking whether the links are non-broken is already covered by `bin/check_links` (using linklint), we can disable checking the link destinations altogether.
2023-11-09build_html: use mdbook_mermaid when available.Nick Mathewson
This is much more convenient for folks who don't want to mess with the jenga tower that is mermaid-cli.
2023-11-09Make mmdc optional.Nick Mathewson
The build script now only uses mmdc and a temporary conditionally, and otherwise (for now) leaves mermaid blocks unformatted.
2023-11-09Clean up spec/book.html slightly.Nick Mathewson
2023-11-09Use mermaid-cli to generate SVG for our diagrams.Nick Mathewson
2023-11-06Repair the gettor permalink (and CI)Nick Mathewson
2023-10-19Add proposal 347-domain-separation.mdNick Mathewson
2023-10-19Add proposal 346-protovers-againNick Mathewson
2023-10-18Try to use our favicon.Nick Mathewson
2023-10-18Improve redirect URLsNick Mathewson
For those that are already correct, list the correct URL on the main site, and mark them as "implicit" so we can double-check them. For those that remain, remove all old links to gitweb.tpo, and link to gitlab.tpo instead.
2023-10-18Do not add a redirect file when an index file already exists.Nick Mathewson
2023-10-18Try to fix proposals redirects for md proposalsNick Mathewson
2023-10-18No longer add needless redirects.Nick Mathewson
2023-10-18Add html extensions to redirect filesNick Mathewson
2023-10-18Add <meta> redircts from proposal number to proposal.Nick Mathewson
2023-10-18Move all binaries to a "bin" directory.Nick Mathewson
2023-10-17Add (and run) script to auto-regenerate permalink redirects.Nick Mathewson
This deliberately doesn't make any changes in the current formatting or targets (yet); that can come later. It uses the existing yaml format and file.
2023-10-17Add begin/end markers to redirect list.Nick Mathewson
2023-10-17Use index.html <meta> redirects in cases where the directory exists.Nick Mathewson
2023-10-14Rename rend-spec-v3 urls to rend-spec.Nick Mathewson
2023-10-12Merge INTRO and README; fix more titles.Nick Mathewson
2023-10-12Copy all verbatim items into spec directory.Nick Mathewson