Documentation ¶
Overview ¶
Copyright 2009 The Go Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
godoc2md converts godoc formatted package documentation into Markdown format.
Usage
godoc2md $PACKAGE > $GOPATH/src/$PACKAGE/README.md
Index ¶
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func ToMD ¶
ToMD converts comment text to formatted Markdown. The comment was prepared by DocReader, so it is known not to have leading, trailing blank lines nor to have trailing spaces at the end of lines. The comment markers have already been removed.
Each span of unindented non-blank lines is converted into a single paragraph. There is one exception to the rule: a span that consists of a single line, is followed by another paragraph span, begins with a capital letter, and contains no punctuation is formatted as a heading.
A span of indented lines is converted into a <pre> block, with the common indent prefix removed.
URLs in the comment text are converted into links.
Types ¶
This section is empty.