🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
DemoInstallSign in
Socket

components-to-markdown

Package Overview
Dependencies
Maintainers
1
Versions
11
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

components-to-markdown

Components to Markdown

0.3.0
latest
Source
npm
Version published
Weekly downloads
0
Maintainers
1
Weekly downloads
 
Created
Source

Components to Markdown

goat

Highly customizable open source tool for generating component documentation.


Read The Docs | Explore the Demo


CircleCI codecov npm

Usage

You can use directly as command line tool or as a library.

CLI Usage

You can use it directly from NPX:

npx components-to-markdown --help

Use @latest after the script to enforce the latest stable release, example:

npx components-to-markdown@latest --version

Example:

npx components-to-markdown@latest -w -o ./output-path ./components-path

See API documentation for more details.

Library Usage

You can install it as a NPM package:

# with NPM:
npm install components-to-markdown --save-dev

# with Yarn:
yarn add components-to-markdown --dev

And import it:

// comp2mark.js

import { componentsToMarkdown } from 'components-to-markdown';

componentsToMarkdown({
  sources: ['./components-path'],
  output: './output-path',
});

Then just run your script:

node comp2mark.js

See API documentation for more details.

License

MIT

Keywords

components-to-markdown

FAQs

Package last updated on 20 Sep 2022

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