-
Notifications
You must be signed in to change notification settings - Fork 267
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(docs): 文档支持通过标签使用已有的 demo 代码 #1950
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## next #1950 +/- ##
==========================================
- Coverage 76.92% 76.91% -0.01%
==========================================
Files 215 215
Lines 8816 8817 +1
Branches 2483 2520 +37
==========================================
Hits 6782 6782
- Misses 2001 2002 +1
Partials 33 33 ☔ View full report in Codecov by Sentry. |
在文档中补充方案的实现思路,以及方案实现依赖的一些制约条件,可能是 demo 文件存放路径,demo 文件如何引入到 markdown 文件等。 |
同步文档到 nutui-docs 的逻辑需要先实现,不然没办法合并这个 PR |
|
…utui-react into hxy/2020/md-test
…utui-react into hxy/2020/md-test
使用规范(以button组件为例)
改造后的demo存放位置。
demo代码可以拆分或从之前doc对应区域复制 taro的demo放到button/demos/taro中,h5的demo放到button/demos/h5中。从上到下存入,h5第一个就是button/demos/h5/demo1.tsx
demo1.tsx中import写法
直接写import React from 'react'
import { Button } from '../../button' 在codeblock.tsx通过正则替换为import { Button } from '@nutui/nutui-react'
import { Button } from '../../button.taro ' 在codeblock.tsx通过正则替换为import { Button } from '@nutui/nutui-react-taro'
在doc中引入demo的方法
<CodeBlock src='h5/demo1.tsx'></CodeBlock>
在原来demo.tsx中使用的方法
import Demo1 from './demos/h5/demo1'
其他规范
demo使用唯一版本,不切换语言,doc三个语言版本不变。
因此在语言方面,使用1. 基本语义使用简短英文【英文方面(大驼峰+空格):Primary/Good Job】 2.复杂语义使用中文的原则
🤔 这个变动的性质是?
🔗 相关 Issue
💡 需求背景和解决方案
☑️ 请求合并前的自查清单