فهرست منبع

docs: update umd script usage

pointhalo 3 سال پیش
والد
کامیت
f2b174f54e
3فایلهای تغییر یافته به همراه52 افزوده شده و 38 حذف شده
  1. 16 12
      content/start/getting-started/index-en-US.md
  2. 34 24
      content/start/getting-started/index.md
  3. 2 2
      test/semi.html

+ 16 - 12
content/start/getting-started/index-en-US.md

@@ -52,19 +52,23 @@ class Demo extends React.Component {
 Use script and link tags to import files directly in the browser, and use the global variable `SemiUI`、`SemiIcons`、`SemiIllustrations`
 
 1. Please make sure you have import `react` and `react-dom` in advance
-2. Import the JS file, the following example URL 2.0.0 is the version identifier, if you want to use a different version of Semi, just replace the corresponding value in version (note that the build file is only available after v1.3.0)
-    - semi-ui min:`https://unpkg.com/@douyinfe/[email protected]/dist/umd/semi-ui-react.min.js`
-    - semi-ui normal: `https://unpkg.com/@douyinfe/[email protected]/dist/umd/semi-ui-react.js`
+2. Import the JS file, the following example URL 2.1.4 is the version identifier, if you want to use a different version of Semi, just replace the corresponding value in version
 
+| Resource | URL |
+| --- | --- |
+| semi-ui (min) | https://unpkg.com/@douyinfe/[email protected]/dist/umd/semi-ui.min.js |
+| semi-icons (min) | https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.min.js |
+| semi-illustrations (min) | https://unpkg.com/@douyinfe/semi-illustrations@latest/dist/umd/semi-illustrations.min.js |
+| semi-ui (normal) | https://unpkg.com/@douyinfe/[email protected]/dist/umd/semi-ui.js |
+| semi-icons (normal) | https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.js |
+| semi-illustrations (normal) | https://unpkg.com/@douyinfe/semi-illustrations@latest/dist/umd/semi-illustrations.js |
 
-    - semi-icons min: `https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.min.js`
-    - semi-icons normal: `https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.js`
-
-    - semi-illustrations min: `https://unpkg.com/@douyinfe/semi-illustrations@latest/dist/umd/semi-illustrations.min.js`
-    - semi-illustrations normal: `https://unpkg.com/@douyinfe/semi-illustrations@latest/dist/umd/semi-illustrations.js`
 3. Import the CSS style file of the Semi default theme
-    - `https://unpkg.com/@douyinfe/[email protected]/dist/css/semi.css`
-    - `https://unpkg.com/@douyinfe/semi-icons@latest/dist/css/semi-icons.css`
+
+| Resource | URL |
+| --- | --- |
+| semi.css | https://unpkg.com/@douyinfe/[email protected]/dist/css/semi.css |
+| semi-icons.css | https://unpkg.com/@douyinfe/semi-icons@latest/dist/css/semi-icons.css |
 
 ```diff
 <!DOCTYPE html>
@@ -74,8 +78,8 @@ Use script and link tags to import files directly in the browser, and use the gl
 +       <script crossorigin src="https://unpkg.com/react@16/umd/react.development.js"></script>
 +       <script crossorigin src="https://unpkg.com/react-dom@16/umd/react-dom.development.js"></script>
 
-+       <script src="https://unpkg.com/@douyinfe/semi-ui@2.0.0/dist/umd/semi-ui-react.min.js"></script>
-+       <link rel="stylesheet" href="https://unpkg.com/@douyinfe/semi-ui@2.0.0/dist/css/semi.css">
++       <script src="https://unpkg.com/@douyinfe/semi-ui@2.1.4/dist/umd/semi-ui-react.min.js"></script>
++       <link rel="stylesheet" href="https://unpkg.com/@douyinfe/semi-ui@2.1.4/dist/css/semi.css">
 
 +       <script src="https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.min.js"></script>
 +       <link rel="stylesheet" href="https://unpkg.com/@douyinfe/semi-icons@latest/dist/css/semi-icons.css">

+ 34 - 24
content/start/getting-started/index.md

@@ -49,7 +49,7 @@ class Demo extends React.Component {
 
 在项目根目录安装 `@douyinfe/semi-next` 。
 
-``` shell
+```shell
 # 使用 npm
 npm i @douyinfe/semi-next --save-dev
 
@@ -66,7 +66,9 @@ pnpm add @douyinfe/semi-next --dev
 
 ```js
 // next.config.js
-const semi = require('@douyinfe/semi-next').default({/* the extension options */});
+const semi = require('@douyinfe/semi-next').default({
+    /* the extension options */
+});
 module.exports = semi({
     // your custom Next.js configuration
 });
@@ -78,7 +80,7 @@ module.exports = semi({
 
 在 `global.css` 中引入全量的 semi css。目前不支持按需引入。
 
-``` css
+```css
 /* styles/globals.css */
 @import '~@douyinfe/semi-ui/dist/css/semi.min.css';
 ```
@@ -96,19 +98,24 @@ module.exports = semi({
 
 在浏览器中使用 script 和 link 标签直接引入文件,并使用全局变量 `SemiUI`、`SemiIcons`、`SemiIllustrations`
 
-1. 请确保你已提前引入 react 以及 react-dom
-2. 引入 JS 文件,以下示例 URL 中 2.0.0 为 version 标识,希望使用不同版本 Semi 时,将 version 中对应的值替换即可(注意构建文件仅在 v1.3.0 后开始提供)
-    - semi-ui min:`https://unpkg.com/@douyinfe/[email protected]/dist/umd/semi-ui.min.js`
-    - semi-ui normal: `https://unpkg.com/@douyinfe/[email protected]/dist/umd/semi-ui.js`
+1、 请确保你已提前引入 react 以及 react-dom  
+2、 引入 JS 文件,以下示例 URL 中 2.1.4 为 version 标识,希望使用不同版本 Semi 时,将 version 中对应的值替换即可  
+
+| 资源 | URL |
+| --- | --- |
+| semi-ui (min) | https://unpkg.com/@douyinfe/[email protected]/dist/umd/semi-ui.min.js |
+| semi-icons (min) | https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.min.js |
+| semi-illustrations (min) | https://unpkg.com/@douyinfe/semi-illustrations@latest/dist/umd/semi-illustrations.min.js |
+| semi-ui (normal) | https://unpkg.com/@douyinfe/[email protected]/dist/umd/semi-ui.js |
+| semi-icons (normal) | https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.js |
+| semi-illustrations (normal) | https://unpkg.com/@douyinfe/semi-illustrations@latest/dist/umd/semi-illustrations.js |
 
-    - semi-icons min: `https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.min.js`
-    - semi-icons normal: `https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.js`
+3、 引入 Semi 默认主题的 CSS 样式文件
 
-    - semi-illustrations min: `https://unpkg.com/@douyinfe/semi-illustrations@latest/dist/umd/semi-illustrations.min.js`
-    - semi-illustrations normal: `https://unpkg.com/@douyinfe/semi-illustrations@latest/dist/umd/semi-illustrations.js`
-3. 引入 Semi 默认主题的 CSS 样式文件  
-    - `https://unpkg.com/@douyinfe/[email protected]/dist/css/semi.css`
-    - `https://unpkg.com/@douyinfe/semi-icons@latest/dist/css/semi-icons.css`
+| 资源 | URL |
+| --- | --- |
+| semi.css | https://unpkg.com/@douyinfe/[email protected]/dist/css/semi.css |
+| semi-icons.css | https://unpkg.com/@douyinfe/semi-icons@latest/dist/css/semi-icons.css |
 
 ```diff
 <!DOCTYPE html>
@@ -118,8 +125,8 @@ module.exports = semi({
 +       <script crossorigin src="https://unpkg.com/react@16/umd/react.development.js"></script>
 +       <script crossorigin src="https://unpkg.com/react-dom@16/umd/react-dom.development.js"></script>
 
-+       <script src="https://unpkg.com/@douyinfe/semi-ui@2.0.0/dist/umd/semi-ui.min.js"></script>
-+       <link rel="stylesheet" href="https://unpkg.com/@douyinfe/semi-ui@2.0.0/dist/css/semi.css">
++       <script src="https://unpkg.com/@douyinfe/semi-ui@2.1.4/dist/umd/semi-ui.min.js"></script>
++       <link rel="stylesheet" href="https://unpkg.com/@douyinfe/semi-ui@2.1.4/dist/css/semi.css">
 
 +       <script src="https://unpkg.com/@douyinfe/semi-icons@latest/dist/umd/semi-icons.min.js"></script>
 +       <link rel="stylesheet" href="https://unpkg.com/@douyinfe/semi-icons@latest/dist/css/semi-icons.css">
@@ -138,11 +145,14 @@ module.exports = semi({
     const { IconHome } = SemiIcons;
     const { IllustrationConstruction } = SemiIllustrations;
     ReactDOM.render(
-    <div>
-        <Button onClick={() => Toast.warning({ duration: 0, content: 'Semi Design' })}>test</Button>
-        <Input defaultValue="semi" onChange={value => Toast.info('hello semi')}></Input>
-        <IconHome size="large" />
-        <IllustrationConstruction style={{width: 150, height: 150}} />
-    </div>, document.getElementById("root"));
-</script>;
-```
+        <div>
+            <Button onClick={() => Toast.warning({ duration: 0, content: 'Semi Design' })}>test</Button>
+            <Input defaultValue="semi" onChange={value => Toast.info('hello semi')}></Input>
+            <IconHome size="large" />
+            <IllustrationConstruction style={{ width: 150, height: 150 }} />
+        </div>,
+        document.getElementById('root')
+    );
+</script>
+;
+```

+ 2 - 2
test/semi.html

@@ -14,8 +14,8 @@
     <script src="https://unpkg.com/[email protected]/babel.min.js"></script>
     <!-- <script src='../packages/semi-ui-react/dist/umd/semi-ui-react.js'></script>
     <link rel="stylesheet" href="../packages/semi-theme-default/css/semi.css"> -->
-    <script src="https://unpkg.com/@douyinfe/semi-ui@2.0.0/dist/umd/semi-ui.min.js"></script>
-    <link rel="stylesheet" href="https://unpkg.com/@douyinfe/semi-ui@2.0.0/dist/css/semi.css">
+    <script src="https://unpkg.com/@douyinfe/semi-ui@2.1.4/dist/umd/semi-ui.min.js"></script>
+    <link rel="stylesheet" href="https://unpkg.com/@douyinfe/semi-ui@2.1.4/dist/css/semi.css">
 </head>
 
 <body>