Top 2.2% dependent packages on proxy.golang.org
Top 2.3% dependent repos on proxy.golang.org
Top 6.9% forks on proxy.golang.org
proxy.golang.org : github.com/jimmyfrasche/autoreadme
Automatically generate a github README.md for each package in your Go module. Create a README.md for each package in the current module (Warning: this will overwrite any existing README.md files!) Get a copy of the default template for customization Templates are executed by Go's text/template. The dot is set to a struct containing (each explained below) ProjectRoot is a boolean which is true if the current package is in the same directory as go.mod. The Repository entry consists solely of .Data, which may contain optional arbitrary data set by JSON in .github/autoreadme/README.md.data. The Module entry contains: The Package entry contains: Name is the package name for libraries. However, for commands that is always "main" so for commands it uses the name of the directory. Documentation entries contain additionally Documentation has a method that renders .Doc as markdown. Each heading in Doc is set to headingLevel, allowing them to be properly nested in context. For packages, the documentation is computed in the standard way by comments attached to the package token. For modules, similar logic is used for the comments attached to the module token (note: any Deprecated: comment is not included, but can be accessed from .Module.Deprecated). Example entries contain and the lists of examples have a few methods Note entries collect the "KIND(uid): body" notes from the package (per go/doc) The list of notes has two methods, Kind and UID, which take a string and return a list of notes matching the respective Kind/UID. A number of files can be added to a .github/autoreadme directory at the root of your repository. Two files can be added to the directory of each package for one-off customizations
Registry
-
Source
- Documentation
- JSON
- codemeta.json
purl: pkg:golang/github.com/jimmyfrasche/autoreadme
License: BSD-2-Clause
Latest release: over 4 years ago
First release: over 4 years ago
Namespace: github.com/jimmyfrasche
Dependent packages: 6
Dependent repositories: 5
Stars: 66 on GitHub
Forks: 8 on GitHub
See more repository details: repos.ecosyste.ms
Last synced: 2 months ago