bisheng-plugin-antd icon indicating copy to clipboard operation
bisheng-plugin-antd copied to clipboard

Add README.md

Open benjycui opened this issue 7 years ago • 0 comments

browser.js

Markdown 在浏览器端渲染时:

  • h[n] 标记自动添加锚点
  • video 标签自动使用 react-sublime-video 包裹
  • 判断超链接是否站内链接,若是,则渲染为 Link,并且会处理 locale 标记,如:/changelog[-cn]
  • 自动给 [className=preview-img] 的图片或则图片组添加预览功能

node.js

demo

  • demo 基本格式
---
// meta data in YAML
title: ...
---

// demo description

hello world

\```jsx
// demo
\ ```

\```css
// 需要嵌入页面的 CSS,会在代码高亮里面出现
\```

<style>
// 需要嵌入页面的 CSS,不会在代码高亮里面出现
</style>
  • 支持 debug 模式,设置了 debug: true 的 demo 只会在开发时展示,构建后会被扔掉
  • 支持 iframe 模式,设置了 iframe: true 的 demo 会以 iframe 的形式预览
  • demo 描述支持单语和双语
    ## zh-CN
    // Chinese description
    ## en-US
    // English description
    

普通文档

## API 为分界,把文档分成上下两部分,对应官网里面的位置。

benjycui avatar Feb 16 '17 02:02 benjycui