docsy

Documentation

Overview

Package docsy transforms raw documents via Hugo and a Docsy template into final documentation.

Index

• func New(hugoExe string, docsyDir string, docPath string) *docsy
• type Docsy

Functions

func New

func New(hugoExe string, docsyDir string, docPath string) *docsy

New returns an instance of *docsy.

Types

type Docsy

type Docsy interface {
	// Render the documentation in 'src' into 'dst' using Hugo and the Docsy
	// templates.
	Render(ctx context.Context, src, dst string) error
}

Docsy renders documentation against a Docsy template.