Browse Source

文档目录调整

haojianlong 4 years ago
parent
commit
6ba8596f7a

+ 8 - 6
docs/.vuepress/config.js

@@ -1,6 +1,7 @@
 const setupContent = require("../setup/index");
 const graphContent = require("../guides/index");
-const notionContent = require('../notion/index')
+// const notionContent = require('../notion/index');
+const standardContent = require('../standard/index');
 module.exports = {
     title: "博锐尚格 Web 组件开发文档",
     description: "博锐尚格 Web 组件开发文档",
@@ -91,10 +92,10 @@ module.exports = {
             {
                 text:"开发规范",
                 items: [
-                    // {text: "javascript", link: "/guides/standard/javascript.md"},
-                    // {text: "typescript", link: "/guides/standard/typescript.md"},
-                    {text: "约定", link: "/guides/standard/appoint.md"},
-                    {text: "git", link: "/guides/standard/git.md"}
+                    {text: "javascript", link: "/standard/javascript.md"},
+                    {text: "typescript", link: "/standard/typescript.md"},
+                    {text: "约定", link: "/standard/appoint.md"},
+                    {text: "git", link: "/standard/git.md"}
                 ]
             },
             {
@@ -147,7 +148,8 @@ module.exports = {
         sidebar: {
             "/setup/": setupContent,
             "/guides/": graphContent,
-            "/notion": notionContent
+            // "/notion": notionContent,
+            "/standard": standardContent
         }
     },
     module: {

+ 0 - 6
docs/guides/standard/README.md

@@ -1,6 +0,0 @@
-# 开发规范
-
-
-### [typescript 编写规范](./typescript.md)
-
-### [javascript 编写规范](./javascript.md)

+ 10 - 0
docs/standard/README.md

@@ -0,0 +1,10 @@
+# 开发规范
+
+
+### [typescript 编写规范](typescript.md)
+
+### [javascript 编写规范](javascript.md)
+
+### [约定](appoint.md)
+
+### [git 提交规范](git.md)

docs/guides/standard/appoint.md → docs/standard/appoint.md


docs/guides/standard/git.md → docs/standard/git.md


+ 24 - 0
docs/standard/index.js

@@ -0,0 +1,24 @@
+const content = [
+    {
+        title: '简介',
+        path: '/standard/'
+    },
+    {
+        title: "javascript",
+        path: '/standard/javascript.md'
+    },
+    {
+        title: "typescript",
+        path: '/standard/typescript.md'
+    },
+    {
+        title: "约定",
+        path: '/standard/appoint.md'
+    },
+    {
+        title: "git 提交规范",
+        path: '/standard/git.md'
+    },
+];
+
+module.exports = content;

docs/guides/standard/javascript.md → docs/standard/javascript.md


+ 1 - 1
docs/guides/standard/typescript.md

@@ -34,7 +34,7 @@
 
 ## 注释
 
-为函数,接口,枚举类型和类使用[JSDoc](./javascript.md)风格的注释。
+为函数,接口,枚举类型和类使用[JSDoc](javascript.md)风格的注释。
 
 ## 字符串