https://github.com/bem/ts-docgen-next

Webpack loader for generating documentation from typescript files.
https://github.com/bem/ts-docgen-next

Last synced: about 1 year ago
JSON representation

Webpack loader for generating documentation from typescript files.

• Host: GitHub
• URL: https://github.com/bem/ts-docgen-next
• Owner: bem
• License: mit
• Created: 2020-12-14T10:39:13.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-11T11:41:01.000Z (almost 5 years ago)
• Last Synced: 2025-03-29T04:33:48.704Z (about 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 102 KB
• Stars: 5
• Watchers: 27
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

README

          
# ts-docgen-next

[![npm](https://img.shields.io/npm/v/ts-docgen-next.svg?style=flat-square&labelColor=111)][npm]

## ✈️ Install

```sh

npm i -DE ts-docgen-next

```

## ☄️ Usage

### As webpack-loader

**component.tsx**

```ts

import { FC } from 'react'

interface ComponentProps {

  property: string

}

export const Component: FC = () => null

```

**documentation.mdx**

```tsx

import { ComponentProps } from '!!ts-docgen-next/loader!./component.tsx'

```

## 📜 License

Project is [MIT licensed](https://github.com/bem/ts-docgen-next/blob/master/license.md).

[npm]: https://www.npmjs.com/package/ts-docgen-next