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
API documentation generator with github-flavored-markdown output
The npm package ape receives a total of 14 weekly downloads. As such, ape popularity was classified as not popular.
We found that ape demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.