Skip to content
/ docco Public
forked from jashkenas/docco

Literate Programming can be Quick and Dirty.

License

Notifications You must be signed in to change notification settings

baoqianz/docco

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Groovy porting of Docco
======

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


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

http://ashkenas.com/docco/

Prerequisites:

  Make sure Java and Groovy are installed

    Java 11 and later

      Microsoft Windows: choco install temurin11

    Groovy 3 and later

      Microsoft Windows: choco install groovy

Installation:

  Download the Docco release and unzip it

    https://github.com/baoqianz/docco/releases/download/0.9.1/release.zip

Usage: groovy docco.groovy [options] files

    Options:
     -c,--css <file>         use a custom css file
     -e,--extension <ext>    assume a file extension for all inputs
     -h,--help               display help for command
     -L,--languages <file>   use a custom languages.json
     -l,--layout <name>      choose a layout (parallel, linear or classic)
     -m,--marked <file>      use custom marked options
     -o,--output <path>      output to a given folder
     -t,--template <file>    use a custom .jst template
     -V,--version            output the version number

About

Literate Programming can be Quick and Dirty.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 53.2%
  • Groovy 21.6%
  • CSS 20.4%
  • EJS 4.7%
  • PowerShell 0.1%