Socket
Socket
Sign inDemoInstall

ape

Package Overview
Dependencies
1
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

ape

API documentation generator with github-flavored-markdown output

    0.3.8latest
    GitHub
    npm

Version published
Maintainers
1
Weekly downloads
16
decreased by-5.88%

Weekly downloads

Readme

Source

ape

API docs? Nope, ape docs!

ape generates API documentation in github-flavored-markup from comments in your code, and places them in line with the actual code. This allows for very easy integration with github. Optionally, ape can also output to html with a built-in jade template, or one you specify.

See lib/template.jade for an example template, lib/ape.html and lib/ape.md are example output.

To install:

sudo npm install -g ape

And how to use:

Usage: node ./bin/ape [input file|directory list]

Options:
  --md            Output as markdown        [boolean]  [default: true]
  --html          Output as HTML            [boolean]  [default: false]
  --template, -t  Template for HTML output  [string]
  --output, -o    Output directory          [string]

Currently python, javascript, ruby, lua, coffeescript, C, C++, Perl, PHP, C#, ObjC, SQL, Bash, CSS, and ActionScript are supported. Feel free to submit a pull request for additional languages!

FAQs

Last updated on 12 Mar 2013

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the 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