Skip to content

Commit dbb4267

Browse files
authored
feat: modify document prompt style (#3826)
1 parent f812a45 commit dbb4267

File tree

6 files changed

+37
-22
lines changed

6 files changed

+37
-22
lines changed

examples/sites/demos/pc/webdoc/import-components-en.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,10 @@ For more information about automatic on-demand imports, please refer to [unplugi
4545
## Multi-component introduction
4646

4747
<div class="tip custom-block">
48-
<p>Warm reminder: Exporting components with Tiny prefix is ​​supported since 3.17.0. If using previous versions, you need to use aliases.</p>
49-
<p>For example:<code>import { Button as TinyButton } from '@opentiny/vue'</code></p>
48+
<div class="custom-block-content">
49+
<p>Warm reminder: Exporting components with Tiny prefix is ​​supported since 3.17.0. If using previous versions, you need to use aliases.</p>
50+
<p>For example:<code>import { Button as TinyButton } from '@opentiny/vue'</code></p>
51+
</div>
5052
</div>
5153

5254
Multi-component reference is from the dependency package.`@opentiny/vue`Multiple components are referenced in. The following is an example (in the following figure)`Button`and`Alert`Component as an example):

examples/sites/demos/pc/webdoc/import-components.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,10 @@ public-hoist-pattern[]=@opentiny/*
8888
## 多组件引入
8989

9090
<div class="tip custom-block">
91-
<p>温馨提示:带有 Tiny 前缀的组件导出自 3.17.0 开始支持。若使用之前版本,需使用别名。</p>
92-
<p>例如:<code>import { Button as TinyButton } from '@opentiny/vue'</code></p>
91+
<div class="custom-block-content">
92+
<p>温馨提示:带有 Tiny 前缀的组件导出自 3.17.0 开始支持。若使用之前版本,需使用别名。</p>
93+
<p>例如:<code>import { Button as TinyButton } from '@opentiny/vue'</code></p>
94+
</div>
9395
</div>
9496

9597
多组件引用即从依赖包 `@opentiny/vue` 中引用多个组件,参考示例如下(以 `TinyButton``TinyAlert` 组件为例):

examples/sites/demos/pc/webdoc/installation-en.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,11 @@ export default defineConfig({
4848
```
4949

5050
<div class="tip custom-block">
51-
<p> To avoid the uncertainty associated with monthly (minor) upgrades of <code> @opentiny/vue </code>, it is recommended to use ~ before relying on the version number of the package in <code> package.json </code> in your project.
52-
For example, <code>"@opentiny/vue": "~3.12.0</code>. </p>
53-
<p><code> @opentiny/vue </code> supports multiple modes. If your project is not a mobile project, you can declare the value of <code>TINY_MODE</code> in <code>process.env</code> in the above configuration code. In order to make the project during construction, the mobile side code can be shaken off and the volume of the packaged product can be optimized. For example, <code>'process.env': {... env,TINY_MODE:'pc'}</code>. </p>
51+
<div class="custom-block-content">
52+
<p> To avoid the uncertainty associated with monthly (minor) upgrades of <code> @opentiny/vue </code>, it is recommended to use ~ before relying on the version number of the package in <code> package.json </code> in your project.
53+
For example, <code>"@opentiny/vue": "~3.12.0</code>. </p>
54+
<p><code> @opentiny/vue </code> supports multiple modes. If your project is not a mobile project, you can declare the value of <code>TINY_MODE</code> in <code>process.env</code> in the above configuration code. In order to make the project during construction, the mobile side code can be shaken off and the volume of the packaged product can be optimized. For example, <code>'process.env': {... env,TINY_MODE:'pc'}</code>. </p>
55+
</div>
5456
</div>
5557

5658
## Import through CDN

examples/sites/demos/pc/webdoc/installation.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,11 @@ export default defineConfig({
4848
```
4949

5050
<div class="tip custom-block">
51-
<p>为了避免<code> @opentiny/vue </code> 的月度版本 (minor) 升级带来的不确定因素,因此推荐在您的工程中的<code> package.json </code> 中依赖包的版本号前使用 ~,
52-
比如 <code>"@opentiny/vue": "~3.12.0</code>。</p>
53-
<p><code> @opentiny/vue </code> 支持多种模式。如果您的工程非移动端工程,可以在上面配置代码中的<code>process.env</code>中,声明<code>TINY_MODE</code>的值,以使工程在构建时,能将移动端模式的代码摇掉,优化打包产物的体积。比如 <code>'process.env': { TINY_MODE:'pc' }</code>。</p>
51+
<div class="custom-block-content">
52+
<p>为了避免<code> @opentiny/vue </code> 的月度版本 (minor) 升级带来的不确定因素,因此推荐在您的工程中的<code> package.json </code> 中依赖包的版本号前使用 ~,
53+
比如 <code>"@opentiny/vue": "~3.12.0</code>。</p>
54+
<p><code> @opentiny/vue </code> 支持多种模式。如果您的工程非移动端工程,可以在上面配置代码中的<code>process.env</code>中,声明<code>TINY_MODE</code>的值,以使工程在构建时,能将移动端模式的代码摇掉,优化打包产物的体积。比如 <code>'process.env': { TINY_MODE:'pc' }</code>。</p>
55+
</div>
5456
</div>
5557

5658
## 通过 CDN 方式引入 (v3.16.0 及之前的版本可用)

examples/sites/demos/pc/webdoc/theme-en.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Theme configuration
22

33
<div class="tip custom-block">
4-
This section of the document only supports theme customization after <code> @opentiny/vue@3.19.0 </code>. For historical theme configuration, see <a href='# Historical version of the theme configuration '> Archive information </a> at the bottom of the current document.
4+
<div class="custom-block-content">
5+
This section of the document only supports theme customization after <code> @opentiny/vue@3.19.0 </code>. For historical theme configuration, see <a href='# Historical version of the theme configuration '> Archive information </a> at the bottom of the current document.
6+
</div>
57
</div>
68

79
537/5000
@@ -71,10 +73,10 @@ themeTool.changeTheme({
7173
```
7274

7375
<div class="info custom-block">
74-
In many historical projects, many developers will write component styles by <code>important</code> and <code>:deep()</code> to override certain component library styles. These styles are scattered throughout the components. When later versions of the component library are upgraded, the component structure or class name may be adjusted, resulting in an override failure. <br><br>
75-
76-
You are advised to use <code>TinyThemeTool</code> to override component styles. In this way, modified CSS rules are centralized to facilitate subsequent maintenance. Users can also introduce 'CSS files' to override styles, but make sure that the styles in them take precedence over the component library.
77-
76+
<div class="custom-block-content">
77+
In many historical projects, many developers will write component styles by <code>important</code> and <code>:deep()</code> to override certain component library styles. These styles are scattered throughout the components. When later versions of the component library are upgraded, the component structure or class name may be adjusted, resulting in an override failure. <br><br>
78+
You are advised to use <code>TinyThemeTool</code> to override component styles. In this way, modified CSS rules are centralized to facilitate subsequent maintenance. Users can also introduce 'CSS files' to override styles, but make sure that the styles in them take precedence over the component library.
79+
</div>
7880
</div>
7981

8082
## Micro Frontends scene

examples/sites/demos/pc/webdoc/theme.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# 主题配置
22

33
<div class="warning custom-block">
4-
本节文档仅支持 <code> @opentiny/vue@3.19.0 </code> 及其之后版本的主题定制,更早的历史版本的主题配置,请参阅当前文档底部的 <a href='#历史版本的主题配置'>历史版本的主题配置</a>
4+
<div class="custom-block-content">
5+
本节文档仅支持 <code> @opentiny/vue@3.19.0 </code> 及其之后版本的主题定制,更早的历史版本的主题配置,请参阅当前文档底部的 <a href='#历史版本的主题配置'>历史版本的主题配置</a>
6+
</div>
57
</div>
68

79
为了给开发者带来更好的用户体验,从 <code> @opentiny/vue@3.19.0 </code> 版本开始,组件库的整体风格切换为 `Opentiny Design` 新风格。
@@ -73,10 +75,10 @@ themeTool.changeTheme({
7375
```
7476

7577
<div class="tip custom-block">
76-
在一些用户项目中,许多开发者会在编写组件和页面的样式时,通过<code>important</code> 和 <code>:deep()</code> 来覆盖某些组件库的样式,这些样式就会散落在各个组件里。在组件库后续版本升级时,可能会调整组件结构或类名,造成样式覆盖失效,不建议这样做。 <br><br>
77-
78-
我们建议用户使用 <code>TinyThemeTool</code> 的方法来覆盖组件样式,这样 CSS 规则会集中在一起,方便后续维护。除此之外,用户也可以将自定义样式统一写在一个 `CSS文件` 中并引入项目,但要保证其中的样式优先级高于组件库的优先级。
79-
78+
<div class="custom-block-content">
79+
在一些用户项目中,许多开发者会在编写组件和页面的样式时,通过<code>important</code> 和 <code>:deep()</code> 来覆盖某些组件库的样式,这些样式就会散落在各个组件里。在组件库后续版本升级时,可能会调整组件结构或类名,造成样式覆盖失效,不建议这样做。 <br><br>
80+
我们建议用户使用 <code>TinyThemeTool</code> 的方法来覆盖组件样式,这样 CSS 规则会集中在一起,方便后续维护。除此之外,用户也可以将自定义样式统一写在一个 `CSS文件` 中并引入项目,但要保证其中的样式优先级高于组件库的优先级。
81+
</div>
8082
</div>
8183

8284
## 微前端场景
@@ -116,8 +118,11 @@ const themeTool = new TinyThemeTool(tinyOldTheme)
116118
```
117119

118120
<div class="warning custom-block">
119-
<p> 旧主题不能 100% 还原历史版本的所有细节,如果用户升级后有较大的影响,可以跟我们反馈,也可以回退使用<code> @opentiny/vue@3.18.0 </code> 版本。</p>
120-
<p> 如果需要切换 <code>Aurora</code> 主题,可以从上面导出 <code>tinyAuroraTheme</code> 的主题。 </p>
121+
<div class="custom-block-content">
122+
<p> 旧主题不能 100% 还原历史版本的所有细节,如果用户升级后有较大的影响,可以跟我们反馈,也可以回退使用<code> @opentiny/vue@3.18.0 </code> 版本。</p>
123+
<br>
124+
<p> 如果需要切换 <code>Aurora</code> 主题,可以从上面导出 <code>tinyAuroraTheme</code> 的主题。 </p>
125+
</div>
121126
</div>
122127

123128
## 历史版本的主题配置

0 commit comments

Comments
 (0)