@modern-js/module-tools-docs 2.32.0 → 2.32.2-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/docs/en/api/config/build-config.mdx +22 -17
  3. package/docs/en/api/config/build-preset.mdx +11 -72
  4. package/docs/en/guide/advance/asset.mdx +1 -1
  5. package/docs/en/guide/advance/copy.md +17 -18
  6. package/docs/en/guide/advance/external-dependency.mdx +1 -1
  7. package/docs/en/guide/advance/in-depth-about-build.md +27 -28
  8. package/docs/en/guide/advance/in-depth-about-dev-command.md +1 -1
  9. package/docs/en/guide/basic/before-getting-started.md +1 -1
  10. package/docs/en/guide/basic/modify-output-product.md +44 -70
  11. package/docs/en/guide/basic/test-your-project.mdx +0 -2
  12. package/docs/en/guide/basic/use-micro-generator.md +12 -37
  13. package/docs/en/guide/basic/using-storybook.mdx +15 -0
  14. package/docs/en/guide/best-practices/components.mdx +5 -198
  15. package/docs/en/guide/best-practices/use-tailwindcss.mdx +289 -0
  16. package/docs/en/plugins/guide/setup-function.mdx +0 -1
  17. package/docs/zh/api/config/build-config.mdx +24 -21
  18. package/docs/zh/api/config/build-preset.mdx +12 -69
  19. package/docs/zh/guide/advance/asset.mdx +3 -6
  20. package/docs/zh/guide/advance/copy.md +0 -2
  21. package/docs/zh/guide/advance/external-dependency.mdx +1 -1
  22. package/docs/zh/guide/advance/in-depth-about-build.md +30 -56
  23. package/docs/zh/guide/basic/before-getting-started.md +1 -1
  24. package/docs/zh/guide/basic/modify-output-product.md +46 -69
  25. package/docs/zh/guide/basic/use-micro-generator.md +13 -33
  26. package/docs/zh/guide/basic/using-storybook.mdx +16 -5
  27. package/docs/zh/guide/best-practices/components.mdx +1 -196
  28. package/docs/zh/guide/best-practices/use-tailwindcss.mdx +289 -0
  29. package/docs/zh/plugins/guide/setup-function.mdx +0 -1
  30. package/modern.config.ts +8 -0
  31. package/package.json +3 -3
  32. package/docs/en/api/config/design-system.md +0 -1166
  33. package/docs/en/guide/advance/theme-config.mdx +0 -76
  34. package/docs/zh/api/config/design-system.md +0 -1166
  35. package/docs/zh/guide/advance/theme-config.mdx +0 -74
@@ -1,74 +0,0 @@
1
- ---
2
- sidebar_position: 6
3
- ---
4
-
5
- # 主题配置
6
-
7
- 模块工程通过 [`designSystem`](/api/config/design-system) API,提供了配置主题的能力。
8
-
9
- ## 动机和原理
10
-
11
- 主题配置有些类似组件库中的定制主题功能,主要用于样式开发中使用。我们可以通过 `designSystem` 配置在不同的样式开发环境下使用由它生成的 `designToken`。
12
-
13
- 所谓 `designToken` 在不同的样式开发环境下对应不同的东西:
14
-
15
- - tailwindcss: 以 `designSystem` 作为 tailwindcss 的 `theme` 配置。因此可以使用:
16
- - tailwindcss 支持的 HTML 类名。
17
- - 在 css/less/sass 下通过 `@apply` 自定义指令使用与 tailwindcss 支持的 HTML 类名同名的字符串。
18
- - css/less/scss: 通过 `designSystem` 生成全局的样式变量。
19
-
20
- `designSystem` API 的数据结构借鉴了 `tailwindcss` 配置对象中的 [theme API](https://tailwindcss.com/docs/theme),因此存在默认的一套 `designToken`。关于默认值,可以查看 [`designSystem` API](/api/config/design-system)。
21
-
22
- :::info
23
- 目前暂时还未支持 css/less/sass 全局变量。
24
- :::
25
-
26
- ## 使用示例
27
-
28
- ### tailwindcss
29
-
30
- 在使用 tailwindcss 的时候,可以通过 `designSystem` 来设置它的 [`theme`](https://v2.tailwindcss.com/docs/theme#extending-the-default-theme) 配置。
31
-
32
- 例如在下面的配置中扩展了原有的颜色配置:
33
-
34
- ```ts title="modern.config.ts"
35
- export default {
36
- designSystem: {
37
- extend: {
38
- colors: {
39
- primary: '#1677ff',
40
- },
41
- },
42
- },
43
- };
44
- ```
45
-
46
- 我们可以在代码中有两种使用 tailwindcss 的方式。
47
-
48
- #### HTML 类名
49
-
50
- ```tsx title="./src/index.tsx"
51
- import 'tailwindcss/utilities.css';
52
-
53
- export default () => {
54
- return <div className="bg-primary"></div>;
55
- };
56
- ```
57
-
58
- #### `@apply` 指令
59
-
60
- 关于 [`@apply`](https://tailwindcss.com/docs/functions-and-directives#apply)。
61
-
62
- ```tsx title="./src/index.tsx"
63
- import './index.css';
64
-
65
- export default () => {
66
- return <div className="btn-primary"></div>;
67
- };
68
- ```
69
-
70
- ```css title="./src/index.css"
71
- .btn-primary {
72
- @apply bg-primary;
73
- }
74
- ```