@modern-js/module-tools-docs 2.32.1 → 2.33.0
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.
- package/.eslintrc.js +1 -1
- package/CHANGELOG.md +11 -0
- package/docs/en/api/config/build-config.mdx +17 -16
- package/docs/en/api/config/build-preset.mdx +11 -72
- package/docs/en/guide/advance/asset.mdx +1 -1
- package/docs/en/guide/advance/copy.md +17 -18
- package/docs/en/guide/advance/external-dependency.mdx +1 -1
- package/docs/en/guide/advance/in-depth-about-build.md +27 -28
- package/docs/en/guide/advance/in-depth-about-dev-command.md +1 -1
- package/docs/en/guide/basic/before-getting-started.md +1 -1
- package/docs/en/guide/basic/modify-output-product.md +44 -70
- package/docs/en/guide/basic/test-your-project.mdx +0 -2
- package/docs/en/guide/basic/use-micro-generator.md +12 -37
- package/docs/en/guide/basic/using-storybook.mdx +15 -0
- package/docs/en/guide/best-practices/components.mdx +5 -198
- package/docs/en/guide/best-practices/use-tailwindcss.mdx +289 -0
- package/docs/en/plugins/guide/setup-function.mdx +0 -1
- package/docs/zh/api/config/build-config.mdx +19 -20
- package/docs/zh/api/config/build-preset.mdx +12 -69
- package/docs/zh/guide/advance/asset.mdx +3 -6
- package/docs/zh/guide/advance/copy.md +0 -2
- package/docs/zh/guide/advance/external-dependency.mdx +1 -1
- package/docs/zh/guide/advance/in-depth-about-build.md +30 -56
- package/docs/zh/guide/basic/before-getting-started.md +1 -1
- package/docs/zh/guide/basic/modify-output-product.md +46 -69
- package/docs/zh/guide/basic/use-micro-generator.md +13 -33
- package/docs/zh/guide/basic/using-storybook.mdx +16 -5
- package/docs/zh/guide/best-practices/components.mdx +1 -196
- package/docs/zh/guide/best-practices/use-tailwindcss.mdx +289 -0
- package/docs/zh/plugins/guide/setup-function.mdx +0 -1
- package/package.json +7 -6
- package/rspress.config.ts +130 -0
- package/theme/index.ts +3 -2
- package/tsconfig.json +1 -1
- package/docs/en/api/config/design-system.md +0 -1166
- package/docs/en/guide/advance/theme-config.mdx +0 -60
- package/docs/zh/api/config/design-system.md +0 -1166
- package/docs/zh/guide/advance/theme-config.mdx +0 -64
- package/modern.config.ts +0 -124
|
@@ -1,64 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
sidebar_position: 6
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# 主题配置
|
|
6
|
-
|
|
7
|
-
Module Tools 通过 [`designSystem`](/api/config/design-system) 选项,提供了配置 Tailwind CSS 主题的能力。
|
|
8
|
-
|
|
9
|
-
## 动机和原理
|
|
10
|
-
|
|
11
|
-
主题配置有些类似组件库中的定制主题功能,主要用于开发样式。当你使用 `designSystem` 时,它会作为 Tailwind CSS 的 `theme` 配置。因此你可以使用:
|
|
12
|
-
|
|
13
|
-
- Tailwind CSS 支持的 CSS 类名。
|
|
14
|
-
- 在 CSS/Less/Sass 下通过 `@apply` 自定义指令使用与 Tailwind CSS 支持的 CSS 类名同名的字符串。
|
|
15
|
-
|
|
16
|
-
关于 `designSystem` 的默认值,可以查看 [`designSystem` API](/api/config/design-system)。
|
|
17
|
-
|
|
18
|
-
## 使用示例
|
|
19
|
-
|
|
20
|
-
在使用 Tailwind CSS 的时候,可以通过 `designSystem` 来设置它的 [`theme`](https://tailwindcss.com/docs/theme) 配置。
|
|
21
|
-
|
|
22
|
-
例如在下面的配置中扩展了原有的颜色配置:
|
|
23
|
-
|
|
24
|
-
```ts title="modern.config.ts"
|
|
25
|
-
export default {
|
|
26
|
-
designSystem: {
|
|
27
|
-
extend: {
|
|
28
|
-
colors: {
|
|
29
|
-
primary: '#1677ff',
|
|
30
|
-
},
|
|
31
|
-
},
|
|
32
|
-
},
|
|
33
|
-
};
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
在代码中,我们可以有两种使用 Tailwind CSS 的方式。
|
|
37
|
-
|
|
38
|
-
#### CSS 类名
|
|
39
|
-
|
|
40
|
-
```tsx title="./src/index.tsx"
|
|
41
|
-
import 'tailwindcss/utilities.css';
|
|
42
|
-
|
|
43
|
-
export default () => {
|
|
44
|
-
return <div className="bg-primary"></div>;
|
|
45
|
-
};
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
#### `@apply` 指令
|
|
49
|
-
|
|
50
|
-
关于 [`@apply`](https://tailwindcss.com/docs/functions-and-directives#apply)。
|
|
51
|
-
|
|
52
|
-
```tsx title="./src/index.tsx"
|
|
53
|
-
import './index.css';
|
|
54
|
-
|
|
55
|
-
export default () => {
|
|
56
|
-
return <div className="btn-primary"></div>;
|
|
57
|
-
};
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
```css title="./src/index.css"
|
|
61
|
-
.btn-primary {
|
|
62
|
-
@apply bg-primary;
|
|
63
|
-
}
|
|
64
|
-
```
|
package/modern.config.ts
DELETED
|
@@ -1,124 +0,0 @@
|
|
|
1
|
-
import path from 'path';
|
|
2
|
-
import { docTools, defineConfig, NavItem } from '@modern-js/doc-tools';
|
|
3
|
-
import { pluginAutoSidebar } from '@modern-js/doc-plugin-auto-sidebar';
|
|
4
|
-
|
|
5
|
-
const { version } = require('./package.json');
|
|
6
|
-
|
|
7
|
-
function getI18nHelper(lang: 'zh' | 'en') {
|
|
8
|
-
const cn = lang === 'zh';
|
|
9
|
-
const prefix = cn ? '' : '/en';
|
|
10
|
-
const getLink = (str: string) => `${prefix}${str}`;
|
|
11
|
-
const getText = (cnText: string, enText: string) => (cn ? cnText : enText);
|
|
12
|
-
return { getText, getLink };
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
function getNavbar(lang: 'zh' | 'en'): NavItem[] {
|
|
16
|
-
const { getLink, getText } = getI18nHelper(lang);
|
|
17
|
-
|
|
18
|
-
return [
|
|
19
|
-
{
|
|
20
|
-
text: getText('指南', 'Guide'),
|
|
21
|
-
link: getLink('/guide/intro/welcome'),
|
|
22
|
-
activeMatch: '^/guide/',
|
|
23
|
-
},
|
|
24
|
-
{
|
|
25
|
-
text: getText('API', 'API'),
|
|
26
|
-
link: getLink('/api/'),
|
|
27
|
-
activeMatch: '^/api/',
|
|
28
|
-
},
|
|
29
|
-
{
|
|
30
|
-
text: getText('插件', 'Plugins'),
|
|
31
|
-
link: getLink('/plugins/guide/getting-started'),
|
|
32
|
-
activeMatch: '^/plugins/',
|
|
33
|
-
},
|
|
34
|
-
{
|
|
35
|
-
text: `v${version}`,
|
|
36
|
-
items: [
|
|
37
|
-
{
|
|
38
|
-
text: getText('更新日志', 'Changelog'),
|
|
39
|
-
link: 'https://github.com/web-infra-dev/modern.js/tree/main/packages/solutions/module-tools/CHANGELOG.md',
|
|
40
|
-
},
|
|
41
|
-
{
|
|
42
|
-
text: getText('贡献指南', 'Contributing'),
|
|
43
|
-
link: 'https://modernjs.dev/en/community/contributing-guide.html',
|
|
44
|
-
},
|
|
45
|
-
],
|
|
46
|
-
},
|
|
47
|
-
];
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
export default defineConfig({
|
|
51
|
-
plugins: [docTools()],
|
|
52
|
-
doc: {
|
|
53
|
-
root: path.join(__dirname, 'docs'),
|
|
54
|
-
lang: 'zh',
|
|
55
|
-
base: '/module-tools/',
|
|
56
|
-
title: 'Module Tools',
|
|
57
|
-
icon: 'https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/logo-1x-0104.png',
|
|
58
|
-
// The plugins for doc tools.
|
|
59
|
-
plugins: [
|
|
60
|
-
pluginAutoSidebar({
|
|
61
|
-
root: path.join(__dirname, 'docs'),
|
|
62
|
-
categories: ['zh', 'en']
|
|
63
|
-
.map(lang =>
|
|
64
|
-
['guide', 'api', 'plugins'].map(category => `${lang}/${category}`),
|
|
65
|
-
)
|
|
66
|
-
.flat(),
|
|
67
|
-
collapsed: false,
|
|
68
|
-
}),
|
|
69
|
-
],
|
|
70
|
-
markdown: {
|
|
71
|
-
checkDeadLinks: true,
|
|
72
|
-
experimentalMdxRs: true,
|
|
73
|
-
},
|
|
74
|
-
themeConfig: {
|
|
75
|
-
footer: {
|
|
76
|
-
message: 'Copyright © 2023 ByteDance.',
|
|
77
|
-
},
|
|
78
|
-
socialLinks: [
|
|
79
|
-
{
|
|
80
|
-
icon: 'github',
|
|
81
|
-
mode: 'link',
|
|
82
|
-
content:
|
|
83
|
-
'https://github.com/web-infra-dev/modern.js/tree/main/packages/solutions/module-tools',
|
|
84
|
-
},
|
|
85
|
-
],
|
|
86
|
-
locales: [
|
|
87
|
-
{
|
|
88
|
-
lang: 'zh',
|
|
89
|
-
label: '简体中文',
|
|
90
|
-
nav: getNavbar('zh'),
|
|
91
|
-
title: 'Module Tools',
|
|
92
|
-
outlineTitle: '目录',
|
|
93
|
-
prevPageText: '上一页',
|
|
94
|
-
nextPageText: '下一页',
|
|
95
|
-
description: '模块工程解决方案',
|
|
96
|
-
},
|
|
97
|
-
{
|
|
98
|
-
lang: 'en',
|
|
99
|
-
label: 'English',
|
|
100
|
-
nav: getNavbar('en'),
|
|
101
|
-
title: 'Module Tools',
|
|
102
|
-
description: 'Module Engineering Solutions',
|
|
103
|
-
},
|
|
104
|
-
],
|
|
105
|
-
editLink: {
|
|
106
|
-
docRepoBaseUrl:
|
|
107
|
-
'https://github.com/web-infra-dev/modern.js/tree/main/packages/document/module-doc/docs',
|
|
108
|
-
text: 'Edit this page on GitHub',
|
|
109
|
-
},
|
|
110
|
-
},
|
|
111
|
-
builderConfig: {
|
|
112
|
-
dev: {
|
|
113
|
-
startUrl: 'http://localhost:<port>/module-tools/',
|
|
114
|
-
},
|
|
115
|
-
source: {
|
|
116
|
-
alias: {
|
|
117
|
-
'@site-docs': path.join(__dirname, './docs/zh'),
|
|
118
|
-
'@site-docs-en': path.join(__dirname, './docs/en'),
|
|
119
|
-
'@site': require('path').resolve(__dirname),
|
|
120
|
-
},
|
|
121
|
-
}
|
|
122
|
-
},
|
|
123
|
-
},
|
|
124
|
-
});
|