Generate CLI reference for documentation #5685
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zanieb
added
documentation
|
Notably the top-level preview commands are excluded because they're hidden |
zanieb
force-pushed
the
zb/docs-reference
branch
2 times, most recently
from
e59bbfc
to
693cffc
Compare
zanieb
commented
Aug 1, 2024
| @@ -147,3 +147,20 @@ See https://github.com/astral-sh/uv/issues/5130 */ | |||
| .md-nav__link--active { | |||
| font-weight: bold; | |||
| } | |||
|
|
|||
| /* Styling for the generated CLI reference page */ | |||
There was a problem hiding this comment.
I created a custom class, these have ~no reliance on mkdocs material
zanieb
force-pushed
the
zb/docs-reference
branch
from
693cffc
to
708d6aa
Compare
|
Great! I think I can help with future work part once we've finalized the grouping and ordering. |
zanieb
force-pushed
the
zb/docs-reference
branch
from
708d6aa
to
9e9ddcb
Compare
zanieb
force-pushed
the
zb/docs-reference
branch
from
9e9ddcb
to
19ac430
Compare
zanieb
added a commit
that referenced
this pull request
Aug 1, 2024
Joining #5685 in a dedicated reference section
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Loosely based on Cargo's format
Future work includes: