feat: implement transformation mechanism to improve generated cli docs#107
Open
feat: implement transformation mechanism to improve generated cli docs#107
Conversation
The cobra generated markdown is not ideal and it needs to be tweaked a bit in order to look right in datum.net but cobra does not offer a hook to apply transformations during generation. For this reason I had to implement a transformation mechanism as second step. There are two transformations asked by Felix: 1. Lowercase link "SEE ALSO" to "See also" 2. Move `h1` header to `h3`
gianarb
force-pushed
the
feat/apply-docs-markdown-transformation
branch
from
2ed0a61 to
8763c8a
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The cobra generated markdown is not ideal and it needs to be tweaked a
bit in order to look right in datum.net but cobra does not offer a hook
to apply transformations during generation.
For this reason I had to implement a transformation mechanism as
second step.
There are two transformations asked by Felix:
h1header toh3