,---.
/__./| ,---. ,---.
,---.; ; | ' ,'\ ' ,'\
/___/ \ | | / / | ,---. ,---. / / |
\ ; \ ' |. ; ,. : / \ / \. ; ,. :
\ \ \: |' | |: : / / ' / / '' | |: :
; \ ' .' | .; :. ' / . ' / ' | .; :
\ \ '| : |' ; :__ ' ; :__| : |
\ ` ; \ \ / ' | '.'|' | '.'|\ \ /
: \ | `----' | : :| : : `----'
'---" \ \ / \ \ /
`----' `----'
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Quick and dirty documentation using Vim
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Vocco is a super patchy literate programming-style documentation generator using Vim’s :TOhtml feature. It renders groups of files as syntax highlighted HTML, using your everyday Vim settings.
<http://jbe.github.com/vocco/README.html>
Make sure you have gvim or macvim and a nice default color scheme installed for optimum roi.
USAGE vocco [options]
writes html to the directory
given by --out, for all files
matching the --file globs.
OPTIONS --files '**/*.rb' README LICENCE
and
defaults --out ./docs
--notes ./notes
--name from gemspec, or use
current directory name.
--site from gemspec, or none
--vim macvim gvim vim
RUBYGEM $ gem install vocco
Vocco.run :out => './website'
NOTES Vocco can include notes for
each file.
Given
-- files 'tra/la/**/*.rb'
and that there is a file at
'tra/la/bup/fum.rb',
and that
-- notes='./notes'
Then you can put notes at
'notes/bup/fum.rb.md', or
'tra/la/bup/fum.md'
Instead of .md (markdown), you
can also use .textile and
.rdoc.
Bonus points for noticing that
the static part of the globs
are automagically trimmed off
the paths.
GREETS Docco: <http://jashkenas.github.com/docco/>
Rocco: <http://rtomayko.github.com/rocco/>
Shocco: <http://rtomayko.github.com/shocco/>
COPYING Copyright (c) 2011 Jostein Berre
Eliassen. Released under an MIT
license. See LICENSE.txt for info.