docs

package
v0.0.0-...-e6fb8a6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 16, 2022 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Body

func Body(elements ...Documentation) *body

func Divider

func Divider() *divider

func List

func List(elements ...Documentation) *list

func Ordinal

func Ordinal(n int) string

func Paragraph

func Paragraph(elements ...Documentation) *paragraph

func RenderDocumentation

func RenderDocumentation(d Documentation, w io.Writer)

func Section

func Section(header string, body Documentation) *section

func Text

func Text(txt string) *text

Types

type Documentation

type Documentation interface {
	// contains filtered or unexported methods
}

type Documented

type Documented interface {
	Document() Documentation
}

Jump to

Keyboard shortcuts

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