markdown

package

v1.3.0 Latest Latest Go to latest Published: Mar 14, 2024 License: MIT Imports: 13 Imported by: 0

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

Package markdown is a Ferrite mode that generates usage documentation in markdown format.

This section is empty.

This section is empty.

func Run(cfg mode.Config, options ...Option)

Run generates environment variable usage instructions in markdown format.

type Option func(*renderer)

Option is a function that changes the behavior of a renderer.

func WithoutExplanatoryText() Option

WithoutExplanatoryText disables the inclusion of the informational paragraphs in the rendered output.

func WithoutIndex() Option

WithoutIndex disables the inclusion of the index in the rendered output.

func WithoutUsageExamples() Option

WithoutUsageExamples disables the inclusion of usage examples in the rendered output.