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

Add examples to the README #61

Closed
zimmski opened this issue Jan 6, 2022 · 3 comments · Fixed by #73
Closed

Add examples to the README #61

zimmski opened this issue Jan 6, 2022 · 3 comments · Fixed by #73

Comments

@zimmski
Copy link

zimmski commented Jan 6, 2022

We are currently looking for a solution that allows us to document our binaries (description of options/arguments, usage, tutorials, ...) + Go packages + packages of other languages + Rest/... APIs.

I stumbled upon this project and the description seems nice. However, i do not see any linked examples for documentation sites that are generated. Could you please add some?
@shakefu
Copy link

shakefu commented Jan 27, 2022

The README.md of this repository is generated using the tool. :)

@princjef princjef mentioned this issue Jul 7, 2022
Merged
@princjef
Copy link
Owner

princjef commented Jul 7, 2022

This tool does use itself to generate all of the README files in this repository. #73 adds some documentation mentioning that this tool uses itself and where to find the commands it runs.

@zimmski
Copy link
Author

zimmski commented Jul 7, 2022

Great, thanks!

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

Successfully merging a pull request may close this issue.

docs(readme): add section with usage examples princjef/gomarkdoc
3 participants
@shakefu @zimmski @princjef