gocco

command
v0.0.0-...-d456788 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 16, 2020 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

**Gocco** is a Go port of [Docco](http://jashkenas.github.com/docco/): the original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. It produces HTML that displays your comments alongside your code. Comments are passed through [Markdown](http://daringfireball.net/projects/markdown/syntax), and code is passed through [Pygments](http://pygments.org/) syntax highlighting. This page is the result of running Gocco against its own source file.

If you install Gocco, you can run it from the command-line:

gocco *.go

...will generate an HTML documentation page for each of the named source files, with a menu linking to the other pages, saving it into a `docs` folder.

The [source for Gocco](http://github.com/nikhilm/gocco) is available on GitHub, and released under the MIT license.

To install Gocco, first make sure you have [Pygments](http://pygments.org/) Then, with the go tool:

go get github.com/nikhilm/gocco

**Gocco** is a Go port of [Docco](http://jashkenas.github.com/docco/): the original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. It produces HTML that displays your comments alongside your code. Comments are passed through [Markdown](http://daringfireball.net/projects/markdown/syntax), and code is passed through [Pygments](http://pygments.org/) syntax highlighting. This page is the result of running Gocco against its own source file.

If you install Gocco, you can run it from the command-line:

gocco *.go

...will generate an HTML documentation page for each of the named source files, with a menu linking to the other pages, saving it into a `docs` folder.

The [source for Gocco](http://github.com/nikhilm/gocco) is available on GitHub, and released under the MIT license.

To install Gocco, first make sure you have [Pygments](http://pygments.org/) Then, with the go tool:

go get github.com/nikhilm/gocco

Jump to

Keyboard shortcuts

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