cutedoc

package module

v0.0.0-...-038cc0d Latest Latest Go to latest Published: Jun 24, 2018 License: Apache-2.0 Imports: 13 Imported by: 1

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/nickthedev/cutedoc

Links

Open Source Insights

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 ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
cutedoc
template

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