markdown

package

v0.0.0-...-a5c340a Latest Latest Go to latest Published: Nov 8, 2025 License: ISC Imports: 17 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/msantos/mdg

Links

Open Source Insights

Documentation ¶

Index ¶

type Metadata
type Opt
- func New(opt ...Option) *Opt
- func (o *Opt) Convert(r io.Reader, w io.Writer) error
- func (o *Opt) Format(r io.Reader, w io.Writer) error
type Option

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Metadata ¶

type Metadata struct {
	Author     string
	Title      string
	Creator    string
	Version    string
	VCS        string
	Date       string
	Footer     map[string]string
	Styles     []string
	DefaultCSS string
	Body       string
}

type Opt ¶

type Opt struct {
	goldmark.Markdown
	// contains filtered or unexported fields
}

func New ¶

func New(opt ...Option) *Opt

func (*Opt) Convert ¶

func (o *Opt) Convert(r io.Reader, w io.Writer) error

func (*Opt) Format ¶

func (o *Opt) Format(r io.Reader, w io.Writer) error

type Option ¶

type Option func(*Opt)

func WithCSS ¶

func WithCSS(s string) Option

WithCSS sets the CSS for the markdown template.

func WithLineWrap ¶

func WithLineWrap(t bool) Option

WithLineWrap enables or disables wrapping long lines.

func WithTemplate ¶

func WithTemplate(t *template.Template) Option

WithTemplate sets the markdown template.

Source Files ¶

View all Source files

markdown.go

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