https://github.com/cytle/vscode-react-docgen-typescript
https://github.com/cytle/vscode-react-docgen-typescript
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/cytle/vscode-react-docgen-typescript
- Owner: cytle
- Created: 2020-09-25T10:48:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-12T07:46:41.000Z (over 5 years ago)
- Last Synced: 2025-01-25T17:28:09.830Z (over 1 year ago)
- Language: TypeScript
- Size: 925 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# vscode-react-docgen-typescript
## Features
Generate TS React component document to clipboard
Insert TS React component documentation in Markdown
Convert the following Component:
``` ts
import * as React from "react";
import { Component } from "react";
/**
* Column properties.
*/
export interface IColumnProps {
/**
* prop1 description
* @default "red"
*/
prop1?: string;
/**
* prop2 description
* @see https://fusion.alibaba-inc.com/
*/
prop2: number;
/**
* prop3 description a | b
*/
prop3: () => void;
/** prop4 description 😄 */
prop4: "option1" | "option2" | "option3";
}
/**
* Form column.
*/
export class Column extends Component {
render() {
return
Test;
}
}
```
Into
``` markdown
### Column
Form column.
#### Props
| Name | Type | Default value | Description |
| ------------------ | ----------------------------------- | ------------- | ----------------------------------------------------------- |
| prop1 | string | "red" | prop1 description |
| prop2 _(required)_ | number | | prop2 description @see https://fusion.alibaba-inc.com/ |
| prop3 _(required)_ | () => void | | prop3 description a \| b |
| prop4 _(required)_ | "option1" \| "option2" \| "option3" | | prop4 description 😄 |
```
## Release Notes
### 1.0.6
- feat: support filterNodeModules
### 1.0.5
- feat: support switch language
### 1.0.4
- docs: add README
### 1.0.3
- fix: Typescript dependency
### 1.0.2
- feat: Insert TS React component documentation in Markdown
### 1.0.0
- feat: Generate TS React component document to clipboard
### For more information
* [react-docgen-typescript](https://github.com/styleguidist/react-docgen-typescript)
**Enjoy!**