Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conditional sub command for processing user docs #4

Merged
merged 10 commits into from
Jul 3, 2024
Merged

Conditional sub command for processing user docs #4

merged 10 commits into from
Jul 3, 2024

Conversation

eikek
Copy link
Member

@eikek eikek commented Jul 2, 2024

Adds a sub-command user-doc that can be conditionally compiled into the binary that can process markdown files to execute included cli examples and places the results back into the document - producing markdown as output.

Some example docs are placed into the docs/ folder that are processed by ci to detect bad examples.

@eikek eikek added the enhancement New feature or request label Jul 2, 2024
@eikek eikek force-pushed the cli-docs branch 4 times, most recently from df49a5c to c690bb2 Compare July 3, 2024 08:43
@eikek eikek marked this pull request as ready for review July 3, 2024 08:44
@eikek eikek merged commit aa9b4f0 into main Jul 3, 2024
4 checks passed
@eikek eikek deleted the cli-docs branch July 3, 2024 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant