docco-extended

The Quick and Dirty Literate Programming Documentation Generator

Usage no npm install needed!

<script type="module">
  import doccoExtended from 'https://cdn.skypack.dev/docco-extended';
</script>

README

 ____
/\  _`\
\ \ \/\ \        ___         ___         ___         ___
 \ \ \ \ \      / __`\      /'___\      /'___\      / __`\
  \ \ \_\ \    /\ \ \ \    /\ \__/     /\ \__/     /\ \ \ \
   \ \____/    \ \____/    \ \____\    \ \____\    \ \____/
    \/___/      \/___/      \/____/     \/____/     \/___/

This is a fork of Jeremy Ashkenas' great docco tool, adding support for (recursive) subdirectories, CJSX, emojis and other nice-to-haves ;)

Docco is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. For more information, see:

http://jashkenas.github.com/docco/

Installation:

  sudo npm install -g docco

Usage:

  docco [options] FILES

  Options:

    -h, --help             output usage information
    -V, --version          output the version number
    -l, --layout [layout]  choose a built-in layouts (parallel, linear)
    -c, --css [file]       use a custom css file
    -o, --output [path]    use a custom output path
    -t, --template [file]  use a custom .jst template
    -e, --extension [ext]  use the given file extension for all inputs
    -L, --languages [file] use a custom languages.json
    -m, --marked [file]    use custom marked options