jj/docs/cli-reference.md
Ilya Grigoriev 16ec185795 docs, CLI reference: use include-markdown instead of a symlink
The main goal is to avoid having a symlink in our source tree. Currently, there
is no good way to work with the `jj` repo with `jj` on Windows.  Currently `jj`
just crashes with symlinks. This is being worked on, see e.g. #2939, but it will
always depend on whether Developer Mode is enabled in Windows or whether
symlinks are materialized as text files with symlinks. Finally, MkDocs has
trouble following symlinks on Windows, so building docs wouldn't work there.

Another advantage is that, previously, we were lucky that MkDocs treats `insta`
header in `cli-reference@.md.snap` as a Markdown header and follows symlinks at
all. Now, we no longer depend on that.
2024-02-12 10:28:09 -08:00

563 B

!!! warning

This CLI reference is experimental. It is automatically generated, but
does not match the `jj help` output exactly.

<!-- See also https://github.com/ConnorGray/clap-markdown/issues -->

{% include-markdown "../cli/tests/cli-reference@.md.snap" rewrite-relative-urls=false start="" %}