
Product
Secure Your AI-Generated Code with Socket MCP
Socket MCP brings real-time security checks to AI-generated code, helping developers catch risky dependencies before they enter the codebase.
components-to-markdown
Advanced tools
Highly customizable open source tool for generating component documentation.
Read The Docs | Explore the Demo
You can use directly as command line tool or as a library.
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.
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.
FAQs
Components to Markdown
The npm package components-to-markdown receives a total of 0 weekly downloads. As such, components-to-markdown popularity was classified as not popular.
We found that components-to-markdown 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.
Product
Socket MCP brings real-time security checks to AI-generated code, helping developers catch risky dependencies before they enter the codebase.
Security News
As vulnerability data bottlenecks grow, the federal government is formally investigating NIST’s handling of the National Vulnerability Database.
Research
Security News
Socket’s Threat Research Team has uncovered 60 npm packages using post-install scripts to silently exfiltrate hostnames, IP addresses, DNS servers, and user directories to a Discord-controlled endpoint.