markdown

package

v0.1.1 Latest Latest Go to latest Published: Oct 15, 2023 License: MIT Imports: 12 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

Repository

github.com/error-fyi/fyictl

Documentation ¶

Index ¶

type Generator
- func New(opts *Options) *Generator
- func (g *Generator) GenerateDocumentation(ctx context.Context, manifest *api.Manifest) error
type Options

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Generator ¶

type Generator struct {
	// contains filtered or unexported fields
}

func New ¶

func New(opts *Options) *Generator

func (*Generator) GenerateDocumentation ¶

func (g *Generator) GenerateDocumentation(ctx context.Context, manifest *api.Manifest) error

type Options ¶

type Options struct {
	Logger                      *logging.Logger
	Writer                      io.Writer
	Output                      string
	InfoTmplFile, ErrorTmplFile string
}

Options contains the configuration options available to the Generator

Source Files ¶

View all Source files

markdown.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL