-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathdefault.txt
63 lines (59 loc) · 2.01 KB
/
default.txt
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
USAGE: doc2go [OPTIONS] PATTERN ...
Generates API documentation for packages matching PATTERNs.
Specify ./... to match the package in the current directory
and all its descendants.
doc2go ./...
OPTIONS
-basename NAME
base name of generated files. Defaults to index.html.
-out DIR
write files to DIR. Defaults to _site.
-subdir NAME
generate output to DIR/NAME instead of DIR.
An index of siblings of NAME will be generated in DIR.
Use for generating versioned documentation.
-pkg-version VERSION
include VERSION in the generated HTML.
Applies only to the standalone website.
-home PATH
import path for the home page of the documentation.
Packages that aren't descendants of this path will be omitted.
-pagefind[=auto|true|false|PATH]
enable or disable client-side page search.
See -help=pagefind for more information.
Defaults to auto.
-embed
generate partial HTML pages fit for embedding.
-internal
include internal packages in package listings.
-frontmatter FILE
generate front matter in HTML files via template in FILE.
See -help=frontmatter for more information.
-rel-link-style STYLE
use STYLE for relative links. One of:
plain: render as-is (e.g. ../foo)
directory: render as a directory (e.g. ../foo/)
Defaults to plain.
-highlight [MODE:][THEME]
use THEME to highlight code blocks.
MODE, if any, is one of 'auto', 'inline', and 'classes'
and specifies the method of highlighting.
See -help=highlight for more information.
-highlight-list-themes
print a list of available themes.
-highlight-print-css
print the CSS for the THEME specified in -highlight.
-pkg-doc PATH=TEMPLATE
generate links for PATH and its children via TEMPLATE.
See -help=pkg-doc for more information.
-config RC
read configuration from the given file. Defaults to doc2go.rc.
See -help=config for more information.
-tags TAG,...
list of comma-separated build tags.
-debug[=FILE]
print debugging output to stderr or FILE, if specified.
-version
report the tool version.
-h, -help
prints this message.