forked from JohnStarich/go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
doc.go
35 lines (35 loc) · 1.26 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// gopages generates static files for Go documentation, formatted with godoc.
//
// Installation:
// go get github.com/gdziwoki/go/gopages
//
// Generate documentation for your module by running without any flags.
//
// A 'go.mod' file must be present in the current directory.
// cd ./mymodule
// gopages
//
// Usage of gopages:
// -base string
// Base URL to use for static assets
// -brand-description string
// Branding description in the top left of documentation
// -brand-title string
// Branding title in the top left of documentation
// -gh-pages
// Automatically commit the output path to the gh-pages branch. The current branch
// must be clean.
// -gh-pages-token string
// The Git token to push with. Usually this is an API key.
// -gh-pages-user string
// The Git username to push with
// -out string
// Output path for static files (default "dist")
// -source-link string
// Custom source code link template. Disables built-in source code pages. For
// example, "https://github.com/gdziwoki/go/blob/master/gopages/{{.Path}}{{if .Line}}#L{{.Line}}{{end}}"
// generates links compatible with GitHub and GitLab. Must be a valid Go template
// and must generate valid URLs.
//
//
package main