Socket
Socket
Sign inDemoInstall

betterdocco

Package Overview
Dependencies
9
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    betterdocco

The (not so) quick and dirty literate programming documentation generator.


Version published
Maintainers
1
Install size
6.88 MB
Created

Readme

Source

Better Docco

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

https://github.com/igoramadas/betterdocco

What's different compared to the original Docco?

Better Docco will use the full path of source files on the menu and filenames. So you can have for instance a index.coffee under /mymodule and another index.coffee under /anothermodule and have both documented at the same batch.

Installation:

$ sudo npm install -g betterdocco

Usage

$ betterdocco [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

Keywords

FAQs

Last updated on 14 Dec 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc