Browse Source

docs: 新增FAQ入口

richard1015 4 years ago
parent
commit
0762450a97
3 changed files with 17 additions and 17 deletions
  1. 1 1
      .github/ISSUE_TEMPLATE/bug_report.md
  2. 11 12
      src/docs/start.md
  3. 5 4
      src/sites/doc/views/Notice.vue

+ 1 - 1
.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,6 +1,6 @@
 ---
 name: 'Bug Report'
-about: '创建错误报告以帮助我们改进。'
+about: '创建错误报告以帮助我们改进。在提问之前可以看下是否为类似的问题 [查看文档](https://github.com/jdf2e/nutui/discussions/categories/q-a)'
 title: '[bug]'
 labels: 'bug'
 assignees: ''

+ 11 - 12
src/docs/start.md

@@ -22,6 +22,17 @@ npm i @nutui/nutui-taro
 
 ### NPM 使用示例
 
+#### 导入全部组件
+
+> 注意:这种方式将会导入所有组件,打包文件大小会很大,我们推荐使用按需加载
+```javascript
+import { createApp } from "vue";
+import App from "./App.vue";
+// 注意:这种方式将会导入所有组件
+import NutUI from "@nutui/nutui";
+import "@nutui/nutui/dist/style.css";
+createApp(App).use(NutUI).mount("#app");
+```
 
 #### Vite 构建工具 通过 vite-plugin 使用按需加载
 
@@ -107,18 +118,6 @@ import "@nutui/nutui/dist/style.css";
 createApp(App).use(Button).use(Icon).mount("#app");
 ```
 
-#### 导入全部组件
-
-> 注意:这种方式将会导入所有组件,打包文件大小会很大
-```javascript
-import { createApp } from "vue";
-import App from "./App.vue";
-// 注意:这种方式将会导入所有组件
-import NutUI from "@nutui/nutui";
-import "@nutui/nutui/dist/style.css";
-createApp(App).use(NutUI).mount("#app");
-```
-
 #### CDN 安装使用示例
 
 > 可以通过 CDN 的方式引入, 可以在 **jsdelivr** 和 **unpkg** 等公共 CDN 上获取到 NutUI。

+ 5 - 4
src/sites/doc/views/Notice.vue

@@ -14,7 +14,7 @@
       <div class="notice-main-content">
         <div class="notice-main-title">常见问题</div>
         <div class="notice-sub-title"
-          >以下为一些NutUi常见的问题和官方答复,在提问之前可以看下是否为类似的问题,可以直接点击链接查看文档</div
+          >以下为一些 NutUI 常见的问题和官方答复,在提问之前可以看下是否为类似的问题,可以直接点击链接查看文档</div
         >
         <div class="notice-main-line"></div>
         <div v-for="(item, index) in list" :key="index" class="notice-main-item" @click="link(item)">
@@ -36,7 +36,7 @@ import { ApiService } from '@/sites/service/ApiService';
 import Footer from '@/sites/doc/components/Footer.vue';
 import { RefData } from '@/sites/assets/util/ref';
 export default defineComponent({
-  name: 'doc',
+  name: 'notice',
   components: {
     [Header.name]: Header,
     [Footer.name]: Footer
@@ -86,6 +86,7 @@ export default defineComponent({
 <style lang="scss" scoped>
 .notice {
   background: #f7f8fa;
+  height: 100%;
   .notice-main {
     width: 1006px;
     margin: 30px auto;
@@ -136,10 +137,10 @@ export default defineComponent({
         color: rgba(26, 26, 26, 1);
       }
       .notice-sub-title {
-        line-height: 1;
+        line-height: 1.4;
         font-size: 15px;
+        margin-bottom: 10px;
         font-family: PingFangSC;
-        color: #1a1a1aad;
       }
       .notice-main-line {
         width: 644px;