components-to-markdown

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #golang #go #macos #nodejs #windows #awesome #awesome-list #ios #open-source

components-to-markdown

(★ 10)

Generate markdown documentation of React components

components-to-markdown Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
<h1>Components to Markdown</h1>

<p>Highly customizable open source tool for generating component documentation.</p>

<br />

[**Read The Docs**](http://components-to-markdown.vercel.app) |
[Explore the Demo](https://components-to-markdown.vercel.app/demo/introduction)

<hr />

[![CircleCI](https://img.shields.io/circleci/build/github/megatroom/components-to-markdown?label=CircleCI)](https://circleci.com/gh/megatroom/components-to-markdown)
[![codecov](https://codecov.io/gh/megatroom/components-to-markdown/branch/main/graph/badge.svg?token=RCNN1XMSN4)](https://codecov.io/gh/megatroom/components-to-markdown)
[![npm](https://img.shields.io/npm/v/components-to-markdown)](https://www.npmjs.com/package/components-to-markdown)

## Usage

You can use directly as [command line tool](#cli-usage) or [as a library](#library-usage).

### CLI Usage

You can use it directly from NPX:

```bash
npx components-to-markdown --help
```

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

```bash
npx components-to-markdown@latest --version
```

Example:

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

See [API documentation](https://components-to-markdown.vercel.app/docs/api/cli) for more details.

### Library Usage

You can install it as a NPM package:

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

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

And import it:

```js
// comp2mark.js

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

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

Then just run your script:

```bash
node comp2mark.js
```

See [API documentation](https://components-to-markdown.vercel.app/docs/api/library) for more details.

## License

[MIT](https://github.com/megatroom/components-to-markdown/blob/main/LICENSE)

components-to-markdown

components-to-markdown Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

components-to-markdown

components-to-markdown Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README