Skip to content
/ exocco Public

Exocco is an Elixir port of Docco, the original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.

License

Notifications You must be signed in to change notification settings

bitchef/exocco

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Exocco

Exocco is an Elixir port of 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 while code is passed through Pygments for syntax highlighting.

Usage

exocco is a self contained elixir script. You can run it from the command line as follow:

 exocco lib/foo.ex

...or

 exocco lib/

This will generate linked HTML documentation for the named source files (or first level files in a directory), saving it into a folder.

To get more information about the available options, run:

 exocco --help

Building

To build Exocco:

Install Elixir...

grab the latest Exocco source...

 git clone https://github.com/bitchef/exocco.git

and build the project:

 cd exocco
 mix deps.get
 mix escript.build

Exocco is released under the MIT License.

About

Exocco is an Elixir port of Docco, the original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages