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

foxydoc

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

foxydoc

Docblock parser with custom tags

  • 1.0.1
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

FoxyDoc

Docblock parser with custom tags. Automatically generates markdown files.

Allows any type of docblock tag e.g. @param, @option, @foo, @bar

Install

npm install -g foxydoc

Usage

foxydoc --included-paths foo bar --exclude-pattern demo --output-directory docs

Command Line Arguments

NameTypeDescription
--included-pathsArrayPaths to generate from
--exclude-patternStringRegex pattern to exclude
--output-directoryStringLocation of markdown output

FAQs

Package last updated on 24 Oct 2017

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