docgen

package

v1.0.1 Latest Latest Go to latest Published: May 25, 2023 License: MIT Imports: 7 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const FullPermissions = 0o777

FullPermissions sets permissions based on same model as gomarkdoc.

This section is empty.

This section is empty.

type Docs mg.Namespace

Docs contains all the Doc related tasks.

func (Docs) Generate(format string) error

📘 Docs generate md docs. Required: Format (azure-devops, github, gitlab).

func (Docs) Init() error

⚙️ Init initializes the tooling for Docs.