jj/cli
Waleed Khan ed84468cb8 docs: in jj help util exec, use Markdown warning admonition
We're scraping the CLI help text and rendering it as markdown, so we can use an "admonition" to have this warning text render nicer in the web documentation.

You could argue that `!!! warning` is a little weird to see on the CLI. Some alternatives:

- We could opt to not design the CLI help text around markdown and skip the change to the `jj util exec` help in this commit.
- We could adopt some kind of format that can be rendered well in both contexts.
  - Could sticking to specific formatting constructs by convention.
  - Could use/create an actual translation tool from CLI format to Markdwon.
- We could keep separate versions of web and CLI documentation. (Seems like a bad idea for the foreseeable future, because we don't have the resources to constantly keep both up-to-date and sync.)

I'm in favor of just writing Markdown in the CLI help text for now.
2024-12-07 13:50:44 -08:00
..
examples conflicts: add "ui.conflict-marker-style" config 2024-11-23 08:28:47 -06:00
src docs: in jj help util exec, use Markdown warning admonition 2024-12-07 13:50:44 -08:00
testing style: inline variables into format strings 2024-10-04 22:29:13 +02:00
tests docs: in jj help util exec, use Markdown warning admonition 2024-12-07 13:50:44 -08:00
build.rs build: fix cargo publish by symlinking cli/docs->docs 2024-11-05 17:37:14 -08:00
Cargo.toml completion: suggest file paths incrementally 2024-12-01 11:06:36 +01:00
docs build: fix cargo publish by symlinking cli/docs->docs 2024-11-05 17:37:14 -08:00
LICENSE