doc2md

package

v0.0.56 Latest Latest Go to latest Published: Mar 7, 2024 License: GPL-3.0, BSD-3-Clause Imports: 11 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

gitlab.science.ru.nl/cncz/go

Links

Open Source Insights

README ¶

doc2md

This is forked from https://github.com/davecheney/godoc2md. The primary difference being that this version is a library that can be used by other packages.

This a fork of a fork https://github.com/WillAbides/godoc2md. But cleanup and simplified. Point it to a Go repo on disk and generate markdown from it.

Further modified to just work for science.ru.nl URLs.

Documentation ¶

Overview ¶

Package doc2md creates a markdown representation of a package's godoc.

This is forked from https://github.com/davecheney/godoc2md. The primary difference being that this version is a library that can be used by other packages.

Index ¶

Variables
func Transform(out io.Writer, path string, config *Config) error
type Config

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// Funcs contains the functions used in the template. Of these only subdir_format might be
	// of interest to callers.
	Funcs = map[string]interface{}{
		"comment_md":    commentMdFunc,
		"base":          path.Base,
		"md":            mdFunc,
		"pre":           preFunc,
		"kebab":         kebabFunc,
		"bitscape":      bitscapeFunc,
		"subdir_format": path.Base,
	}
)

Functions ¶

func Transform ¶

func Transform(out io.Writer, path string, config *Config) error

Transform turns your godoc into markdown.The imp (import) path will be used for the generated import statement, the same string is also used for generating file 'files' links, but then it will be prefixed with 'https://'.

Types ¶

type Config ¶

type Config struct {
	SrcLinkHashFormat string
	SrcLinkFormat     string
	ShowTimestamps    bool
	DeclLinks         bool
	Verbose           bool
	Import            string
	SubPackage        string // If this is a subpackage, this hold the relative import
	GitRef            string // commit, tag, or branch of the repo.
}

Config contains config options for doc2md

Source Files ¶

View all Source files

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