build

package

v0.0.9 Latest Latest Go to latest Published: Mar 11, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

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/lukeshay/gocden

Links

Open Source Insights

Documentation ¶

Index ¶

func Build(c *cli.Context) error
func BuildAllFiles(c *cli.Context) (*[]DocFile, *[]*assets.NavSection, error)
func BuildFile(files []DocFile, conf *config.Config, navSections []*assets.NavSection, ...) error
type DocFile
- func CreateDocFile(conf *config.Config, srcDir string, outDir string, path string, ...) (*DocFile, error)
type DocMatter

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Build ¶

func Build(c *cli.Context) error

func BuildAllFiles ¶

func BuildAllFiles(c *cli.Context) (*[]DocFile, *[]*assets.NavSection, error)

func BuildFile ¶

func BuildFile(files []DocFile, conf *config.Config, navSections []*assets.NavSection, idx int, file DocFile) error

Types ¶

type DocFile ¶

type DocFile struct {
	Path     string
	OutPath  string
	InPath   string
	Matter   DocMatter
	File     *os.File
	Contents string
	ModTime  time.Time
}

func CreateDocFile ¶

func CreateDocFile(conf *config.Config, srcDir string, outDir string, path string, info os.FileInfo) (*DocFile, error)

type DocMatter ¶

type DocMatter struct {
	Title       string `yaml:"title" validate:"required"`
	Description string `yaml:"description" `
	Path        string `yaml:"path"`
	Section     string `yaml:"section"`
}

Source Files ¶

View all Source files

build.go

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