README
¶
doc2go
doc2go is a command line tool that generates static HTML documentation from your Go code. It is a self-hosted static alternative to https://pkg.go.dev/ and https://godocs.io/.
Documentation for the tool is available at https://abhinav.github.io/doc2go/.
Installation
See https://abhinav.github.io/doc2go/docs/install/, but in short, use one of the following methods:
# Homebrew/Linuxbrew:
brew install abhinav/tap/doc2go
# ArchLinux User Repository
yay -S doc2go-bin
# Build from source
go install go.abhg.dev/doc2go@latest
Getting Started
To get started with doc2go, see https://abhinav.github.io/doc2go/docs/start/.
If you just want a copy-paste-friendly setup to publish your documentation to GitHub Pages, see https://abhinav.github.io/doc2go/docs/publish/github-pages/.
License
This software is licensed under the Apache 2.0 License with the exception of the following files.
internal/godoc/synopsis.go
internal/godoc/synopsis_test.go
The license for those files is noted inside them.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
errdefer
Package errdefer provides functions for running operations that must be deferred until the end of a function, but which may return errors that should be returned from the function.
|
Package errdefer provides functions for running operations that must be deferred until the end of a function, but which may return errors that should be returned from the function. |
|
flagvalue
Package flagvalue provides flag.Value implementations.
|
Package flagvalue provides flag.Value implementations. |
|
godoc
Package godoc provides the means of converting parsed Go source information into a documentation subset of it.
|
Package godoc provides the means of converting parsed Go source information into a documentation subset of it. |
|
gosrc
Package gosrc is the part of the pipeline of doc2go responsible for finding Go packages and loading information about them.
|
Package gosrc is the part of the pipeline of doc2go responsible for finding Go packages and loading information about them. |
|
highlight
Package highlight provides support to highlight source code blocks.
|
Package highlight provides support to highlight source code blocks. |
|
html
Package html renders HTML from godoc.Package.
|
Package html renders HTML from godoc.Package. |
|
iotest
Package iotest provides utilities for testing IO-related code.
|
Package iotest provides utilities for testing IO-related code. |
|
linebuf
Package linebuf provides line-buffered IO utilities.
|
Package linebuf provides line-buffered IO utilities. |
|
must
Package must provides helper functions to assert program invariants.
|
Package must provides helper functions to assert program invariants. |
|
pagefind
Package pagefind provides access to the pagefind CLI.
|
Package pagefind provides access to the pagefind CLI. |
|
pathtree
Package pathtree provides a data structure that stores values organized under a tree-like hierarchy where values from higher levels cascade down to lower levels unless the lower levels define their own values.
|
Package pathtree provides a data structure that stores values organized under a tree-like hierarchy where values from higher levels cascade down to lower levels unless the lower levels define their own values. |
|
pathx
Package pathx provides extensions to the path package.
|
Package pathx provides extensions to the path package. |
|
ptr
Package ptr provides [Of], to turn literals into pointers.
|
Package ptr provides [Of], to turn literals into pointers. |
|
relative
Package relative turns paths and file paths relative with string manipulation exclusively.
|
Package relative turns paths and file paths relative with string manipulation exclusively. |
|
sliceutil
Package sliceutil contains generic functions for working with slices.
|
Package sliceutil contains generic functions for working with slices. |
Click to show internal directories.
Click to hide internal directories.