Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

apidoc-markdown3

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

apidoc-markdown3

Generate API documentation in markdown format from apidoc data.

  • 1.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
8
increased by60%
Maintainers
1
Weekly downloads
 
Created
Source

apidoc-markdown3

NOTE: forked and updated vulnerable ejs to latest version (filters are no longer supported)

Generate API documentation in markdown from apidoc data.

Installation

npm install apidoc-markdown3

Usage

Usage: apidoc-markdown3 -p [path] -o [output file]

Options:
  --path, -p      Path to generated apidoc output. Where api_data.json & api_project.json resides.  [required]
  --output, -o    Output file to write.                                                             [required]
  --template, -t  Path to EJS template file, if not specified default template will be used.
  --prepend       Prepend file after TOC.

Examples

Generate from included example data

apidoc-markdown3 -p examples -o examples/example.md

View generated example

Why apidoc-markdown3

apidoc-markdown is not maintained for long time. New tags of apidoc are not supported. This version is applied pull request for supporting new tags.

Keywords

FAQs

Package last updated on 21 Aug 2018

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc