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.

Sign up for GitHub

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

Jump to bottom

Markdown Documentation Generator #21

Open
osterman opened this issue Apr 24, 2020 · 0 comments
Open

Markdown Documentation Generator #21

osterman opened this issue Apr 24, 2020 · 0 comments

Comments

@osterman
Copy link

osterman commented Apr 24, 2020 •
edited
Loading

what

Add a variant md command which emits markdown formatted documentation of all commands suitable for inclusion in a README.md

why

  • Easily document a command's usage and showcase what it's capable of doing

inspiration

See terraform-docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@osterman