doc

command module

v0.0.0-...-c18495b Latest Latest Go to latest Published: Jul 14, 2018 License: BSD-2-Clause Imports: 12 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

A modern lightweight markup language.

go get gitlab.com/brytonhall/doc

doc is currently refining its own standard.

There is a library:

md := markdown.New(markdown.XHTMLOutput(true), markdown.Nofollow(true))
fmt.Println(md.RenderToString([]byte("Header\n===\nText")))

and a command line tool.

The following options are supported:

Name	Type	Description	Default
HTML	bool	whether to enable raw HTML	false
Tables	bool	whether to enable GFM tables	true
Linkify	bool	whether to autoconvert plain-text URLs to links	true
Typographer	bool	whether to enable typographic replacements	true
Quotes	string	double + single quote replacement pairs for the typographer	“”‘’
MaxNesting	int	maximum nesting level	20
LangPrefix	string	CSS language prefix for fenced blocks	language-
Breaks	bool	whether to convert newlines inside paragraphs into `<br>`	false
Nofollow	bool	whether to add `rel="nofollow"` to links	false
XHTMLOutput	bool	whether to output XHTML instead of HTML	false

Improve performance with the raw HTML option enabled
Write an URL parser/encoder that would support decoding punycode and counting matching [( and )] in URLs

An example command-line tool that uses opennota/markdown to process markdown input.

Path	Synopsis
byteutil Package byteutil provides various operations on bytes and byte strings.	Package byteutil provides various operations on bytes and byte strings.
html
linkify Package linkify provides a way to find links in plain text.	Package linkify provides a way to find links in plain text.
genfsm
markdown Package markdown provides CommonMark-compliant markdown parser and renderer.	Package markdown provides CommonMark-compliant markdown parser and renderer.