# my-doc-jsx-plugin-api

> my-doc-jsx的一个插件，用于根据注释、typescript接口生成api表格。

Latest version **0.1.1** (published 2018-09-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install my-doc-jsx-plugin-api
pnpm add my-doc-jsx-plugin-api
yarn add my-doc-jsx-plugin-api
bun add my-doc-jsx-plugin-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2018-09-09 |
| First published | 2018-02-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 1 |
| Unpacked size | 4.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | laden666666 |
| Maintainers | laden666666 |
| Keywords | blog, doc, jsx, api, plugin |

## Links

- npm: https://www.npmjs.com/package/my-doc-jsx-plugin-api
- Repository: https://github.com/laden666666/my-doc-jsx-plugin-api
- Homepage: https://github.com/laden666666/my-doc-jsx-plugin-pai#readme
- Issues: https://github.com/laden666666/my-doc-jsx-plugin-pai/issues
- npm.io page: https://npm.io/package/my-doc-jsx-plugin-api

## Dependencies (1)

- [my-doc-jsx](https://npm.io/package/my-doc-jsx.md) ^0.2.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2018-09-09
- 0.1.0 — 2018-09-07
- 0.0.3 — 2018-04-25
- 0.0.2 — 2018-02-14
- 0.0.1 — 2018-02-14

## README

# my-doc-jsx-plugin-api
my-doc-jsx-plugin-api是一个my-doc-jsx的插件，用于生成API文档。

## 使用
```javascript
npm instlal my-doc-jsx-plugin-api --D
```
如果是在nodejs或者浏览器中执行，使用jsxdoc的myDocJsx方法集成，nodejs：

```javascript
const Plugin = require('my-doc-jsx-plugin-api')
myDocJsx.usePlugin(new Plugin)
```
浏览器中：

```javascript
myDocJsx.usePlugin(new myDocJsxPluginAPI())
```
cli环境下使用

```javascript
docjsx c html --plugin my-doc-jsx-plugin-api index.jsx ./
```

## 项目logo
用于展示项目的logo


## npm信息
用于展示项目的logo，主要是基于img.shields.io这个网站来生成项目和npm相关的信息。

<p class="mydoc_api_npm-info" align="center">
            <a href="https://www.npmjs.com/package/my-doc-jsx-plugin-api"><img src="https://img.shields.io/npm/v/my-doc-jsx-plugin-api.svg" alt="Version"></a>
            <a href="https://www.npmjs.com/package/my-doc-jsx-plugin-api"><img src="https://img.shields.io/npm/dm/my-doc-jsx-plugin-api.svg" alt="Downloads"></a>
            <a href="https://www.npmjs.com/package/my-doc-jsx-plugin-api"><img src="https://img.shields.io/npm/l/my-doc-jsx-plugin-api.svg" alt="License"></a>
        </p>```javascript
<npm-info version downloads license name="my-doc-jsx-plugin-api"></npm-info>
```

## 浏览器兼容性
用于生成一个展示项目浏览器兼容性表格的标签

<table cellspacing="1" style="margin: 0 auto;font-size: 14px;background-color: #f9f9f9;color: #036;padding: 3px;border-radius: 4px;border: 1px solid rgba(220, 220, 220, .5);">
    <colgroup width="100" span="7" align="center"></colgroup>
    <tr style="height: 30px;">
        <th align="center">Android</td><th align="center">Firefox</td><th align="center">Chrome</td><th align="center">IE</td><th align="center">iPhone</td><th align="center">Edge</td><th align="center">Safari</td>
    </tr>
    <tr style="color: #000;line-height: 28px;font-weight: bold;">
        <td align="center" style="background-color: #60d848">>4.4</td><td align="center" style="background-color: #60d848">√</td><td align="center" style="background-color: #60d848">√</td><td align="center" style="background-color: #60d848">>8</td><td align="center" style="background-color: #60d848">√</td><td align="center" style="background-color: #60d848">√</td><td align="center" style="background-color: #60d848">√</td>
    </tr>
</table>```javascript
<browser-list Android=">4.4" Firefox Chrome IE=">8" iPhone Edge Safari/>
```

## 注释生成函数文档
该功能可以将函数的注释生成为说明函数用途、参数、返回值的文档，以table表格的形式展示，具体使用方法为：

```javascript
<api>{`
* 根据字符串模糊查询key，并返回匹配的缓存数组
* @param {string} searchText    key的模糊检索条件
* @return {Array<string>}      返回匹配的数组
`}</api>
```
生成的效果为：


>
根据字符串模糊查询key，并返回匹配的缓存数组


##### 参数
|参数名|参数类型|参数说明|
|-|-|-|
|searchText|string|key的模糊检索条件|



##### 返回值
|参数类型|参数说明|
|-|-|-|
|Array&lt;string&gt;|返回匹配的数组|


## 展示HTML形式的例子
该控件的功能为，运行HTML代码的显示效果，类似于jsfiddle这样的网站，不过该功能比jsfiddle简单很多，单机即可使用，同时可以展示HTML例子的代码。

该控件基于HTML的iframe标签总的srcdoc属性，因此在markdown、CSP策略中设置了child-src的页面、部分浏览器中无法使用。

具体使用方法为：

```javascript
<html-example code>{
`
<div id="app">
    {{ message }}
</div>
<script src="https://cdn.jsdelivr.net/npm/vue"></script>
<script>
    var app = new Vue({
        el: '#app',
        data: {
            message: '运行了vue!'
        }
    })
</script>
`
}</html-example>
```
效果为：

---
_Source: https://npm.io/package/my-doc-jsx-plugin-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._