cutedoc

README

cutedoc

Cutedoc is a simple command line tool that allows you to generate beautiful static documentation using simple markdown files. You can learn more about the project at https://nickthedev.github.io/cutedoc.

Getting Started

If you already have Go installed, you can easily grab the latest version of Cutedoc by using the go get command in the console. If your GOPATH/bin env variable is set, the cutedoc command will be accessible without having to specify the executable path.

$ go get github.com/NickTheDev/cutedoc/cmd/cutedoc

If you do not have or wish to install Go, you can grab a pre-built binary from Github. However, with this method you will have to optionally add the executable to your env variables yourself.

Demo

Cutedoc's documentation was created with Cutedoc, and can be found at https://nickthedev.github.io/cutedoc/docs.

Documentation

Index

• func Run(doc *Doc) error
• type Branding
• type Build
• type Colors
• type Doc
  • func New() (*Doc, error)
• type Meta
• type Theme

Functions

func Run

func Run(doc *Doc) error

Run executes the documentation generation tasks.

Types

type Branding

type Branding struct {
	Logo string
	Icon string
}

Branding holds the paths to the branding of the documentation.

type Build

type Build struct {
	Dir    string
	Minify bool
}

Build represents options used during the build process.

type Colors

type Colors struct {
	Primary    string
	Secondary  string
	Text       string
	Nav        string
	Background string
}

Represents color scheme of the documentation.

type Doc

type Doc struct {
	Build    Build
	Meta     Meta
	Theme    Theme
	Articles yaml.MapSlice
}

Doc represents the current model of the documentation being created.

func New

func New() (*Doc, error)

New reads the doc config in the current directory and creates a doc model based on it.

type Meta

type Meta struct {
	Title       string
	Author      string
	Description string
	Branding    Branding
}

Meta holds metadata of the documentation.

type Theme

type Theme struct {
	Template string
	Colors   Colors
}

Represents theme of the documentation.