Socket
Socket
Sign inDemoInstall

@emdaer/plugin-documentation

Package Overview
Dependencies
Maintainers
4
Versions
130
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@emdaer/plugin-documentation

An emdaer plugin to generate documentation from your code comments using documentationjs


Version published
Weekly downloads
20
decreased by-86.39%
Maintainers
4
Weekly downloads
 
Created
Source

@emdaer/plugin-documentation · Travis Documented with emdaer Maintained with lerna

An emdaer plugin to generate documentation from your code comments using documentationjs

Usage

@emdaer/plugin-documentation is an emdaer plugin – see the emdaer monorepo for more information

Documentation

Example

documentationPlugin

Render documentation from specified source code.

Parameters

  • options any
    • options.sources array? Globs that specify the paths to the documentation sources.

Examples

<!--emdaer-p
  - '@emdaer/plugin-documentation'
  - sources:
    - ./src/index.js
-->

Returns Promise<string> The rendered documentation

Usage in README

<!--emdaer-p
  - '@emdaer/plugin-documentation'
  - sources:
    - ./src/index.js
-->

Keywords

FAQs

Package last updated on 09 Apr 2020

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