https://github.com/willfaught/rundown
Print package documentation as Markdown
https://github.com/willfaught/rundown
go markdown readme
Last synced: about 1 month ago
JSON representation
Print package documentation as Markdown
- Host: GitHub
- URL: https://github.com/willfaught/rundown
- Owner: willfaught
- License: osl-3.0
- Created: 2023-07-10T01:26:15.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-30T04:21:55.000Z (almost 3 years ago)
- Last Synced: 2025-05-03T04:46:04.449Z (about 1 year ago)
- Topics: go, markdown, readme
- Language: Go
- Homepage: https://pkg.go.dev/github.com/willfaught/rundown
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rundown
Package rundown prints package documentation as Markdown.
Usage:
Usage of rundown:
-package string
Package path (default ".")
The package path is passed directly to [golang.org/x/tools/go/packages.Load](https://pkg.go.dev/golang.org/x/tools/go/packages#Load).
Using rundown on itself prints this to standard output:
# rundown
Package rundown prints package documentation as Markdown.
Usage:
Usage of rundown:
-package string
Package path (default ".")
The package path is passed directly to [golang.org/x/tools/go/packages.Load](https://pkg.go.dev/golang.org/x/tools/go/packages#Load).
Using rundown on itself prints this to standard output:
[...]
Save the output to README.md:
rundown >README.md