Skip to content
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

Merged
merged 15 commits into from
Mar 1, 2024

Conversation

Alex-huxiyang
Copy link
Collaborator

@Alex-huxiyang Alex-huxiyang commented Feb 20, 2024

使用规范(以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.复杂语义使用中文的原则

🤔 这个变动的性质是?

  • 新特性提交
  • 日常 bug 修复
  • 站点、文档改进
  • 演示代码改进
  • 组件样式/交互改进
  • TypeScript 定义更新
  • 包体积优化
  • 性能优化
  • 功能增强
  • 国际化改进
  • 重构
  • 代码风格优化
  • 测试用例
  • 分支合并
  • 其他改动(是关于什么的改动?)

🔗 相关 Issue

💡 需求背景和解决方案

☑️ 请求合并前的自查清单

⚠️ 请自检并全部勾选全部选项⚠️

  • 文档已补充或无须补充
  • 代码演示已提供或无须提供
  • TypeScript 定义已补充或无须补充
  • fork仓库代码是否为最新避免文件冲突
  • Files changed 没有 package.json lock 等无关文件

Copy link

codecov bot commented Feb 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.91%. Comparing base (a766510) to head (cf99d0d).
Report is 2 commits behind head on next.

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.
📢 Have feedback on the report? Share it here.

@Alex-huxiyang Alex-huxiyang changed the title fix: 演示doc引入demo的方法(以button为例) feat(MDX): 演示doc引入demo的方法(以button为例) Feb 21, 2024
@Alex-huxiyang Alex-huxiyang changed the title feat(MDX): 演示doc引入demo的方法(以button为例) refactor(MDX): 演示doc引入demo的方法(以button为例) Feb 21, 2024
@oasis-cloud
Copy link
Collaborator

在文档中补充方案的实现思路,以及方案实现依赖的一些制约条件,可能是 demo 文件存放路径,demo 文件如何引入到 markdown 文件等。

@oasis-cloud
Copy link
Collaborator

同步文档到 nutui-docs 的逻辑需要先实现,不然没办法合并这个 PR

@eiinu
Copy link
Member

eiinu commented Feb 23, 2024

../../button -> @nutui/nutui-react 的替换逻辑:
建议从「正则替换」更换为「项目 alias 配置」

@oasis-cloud oasis-cloud changed the title refactor(MDX): 演示doc引入demo的方法(以button为例) refactor(docs): 文档支持通过标签使用已有的 demo 代码 Feb 29, 2024
@oasis-cloud oasis-cloud merged commit a67ebf6 into jdf2e:next Mar 1, 2024
4 of 5 checks passed
@Alex-huxiyang Alex-huxiyang deleted the hxy/2020/md-test branch March 13, 2024 06:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants