https://github.com/webclipper/bisheng-plugin-typescript-interface

Generate Document from comment in typescript interface for Markdown files in bisheng.
https://github.com/webclipper/bisheng-plugin-typescript-interface

Last synced: 11 months ago
JSON representation

Generate Document from comment in typescript interface for Markdown files in bisheng.

• Host: GitHub
• URL: https://github.com/webclipper/bisheng-plugin-typescript-interface
• Owner: webclipper
• License: mit
• Created: 2019-02-20T16:20:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-25T07:01:27.000Z (over 7 years ago)
• Last Synced: 2025-02-28T18:04:35.075Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 316 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# bisheng-plugin-typescript-interface

[![NPM version][npm-image]][npm-url]

[![build status][travis-image]][travis-url]

[![Test coverage][codecov-image]][codecov-url]

[npm-image]: https://img.shields.io/npm/v/bisheng-plugin-typescript-interface.svg?style=flat-square

[npm-url]: https://npmjs.org/package/bisheng-plugin-typescript-interface

[travis-image]: https://img.shields.io/travis/yuquewebclipper/bisheng-plugin-typescript-interface.svg?style=flat-square

[travis-url]: https://travis-ci.org/yuquewebclipper/bisheng-plugin-typescript-interface

[codecov-image]: https://codecov.io/gh/yuquewebclipper/bisheng-plugin-typescript-interface/branch/master/graph/badge.svg

[codecov-url]: https://codecov.io/gh/yuquewebclipper/bisheng-plugin-typescript-interface

Generate Document from comment in typescript interface for Markdown files in [`bisheng`](https://github.com/benjycui/bisheng).

## Usage

Install:

```bash

npm i --save bisheng-plugin-typescript-interface

```

In Markdown:


```typescriptInterface

{

    "filePath":"posts/fixtures.tsx",

    "interfaceName":"ITestInterface",

    "language":"zh-CN"

}

```



## API

### lang: String

> default: 'typescriptInterface'

## License

MIT