Merge pull request #9 from swan-team/master

merge master

Author: zhangshao-qiang

.gitignore

@@ -12,4 +12,5 @@ package-lock.json
 .vscode
 .project
 miniapp_docs_*
-source/sitemap.txt
+source/sitemap.txt
+fis-conf.js

README.md

@@ -4,15 +4,16 @@
 ### 开启本地预览
 进入 swan-docs，终端执行 `npm start`;
 
-终端看到`Hexo is running at http://localhost:4000/docs/. Press Ctrl+C to stop.` 提示，启动成功。
+终端看到`VuePress dev server listening at http://localhost:4000/docs/` 提示，启动成功。
 
 访问 http://localhost:4000/docs/introduction/register/ 开始编辑（path与线上一致）。
 
 ### 编写
 编辑器打开模块，找到你要编辑的文档所在文件夹，修改刷新浏览器即可看到修改。
 
 #### 新增文档
-如果是新增文档，去到`source/_data/nav.yml`新增一份配置（nav.yml配置说明见编写规范）。然后到对应的目录下建立一个.md。
+如果是新增文档，去到`program-docs/nav/nav.yml`新增一份配置（nav.yml配置说明见编写规范）。
+然后到对应的目录下(`program-docs/docs/`)建立一个.md。
 
 ## 编写规范
 ### 导航配置

make-sitemap.js

@@ -1,42 +1,41 @@
 {
   "name": "swan-docs",
   "version": "1.0.0",
-  "private": true,
-  "description": "智能小程序文档",
-  "hexo": {
-    "version": "3.7.1"
-  },
+  "description": "",
+  "main": "index.js",
   "scripts": {
-    "prebuild": "npm install && hexo --safe && node make-sitemap.js",
-    "prestart": "npm install && hexo --safe",
-    "copy": "cp -r source/_posts output/miniappdocs/sourcedocs/ && cp -r source/_data/nav.yml output/miniappdocs/sourcedocs/",
-    "start": "node make-sitemap.js && npx hexo server",
-    "build": "npx hexo clean && NODE_OPTIONS=--max-old-space-size=4096 npx hexo generate && npm run copy"
+    "prestart": "npm i",
+    "prebuild": "npm i",
+    "predev:program": "npm i",
+    "prebuild:program": "npm i",
+    "dev:game": "cd game-docs && npm start",
+    "build:game": "cd game-docs && npm run build",
+    "dev:program": "vuepress dev program-docs/docs --no-cache",
+    "build:program": "vuepress build program-docs/docs --no-cache",
+    "build": "vuepress build program-docs/docs --no-cache",
+    "start": "vuepress dev program-docs/docs --no-cache"
   },
-  "dependencies": {
-    "cheerio": "1.0.0-rc.2",
-    "hexo": "3.7.1",
-    "hexo-generator-archive": "^0.1.4",
-    "hexo-generator-category": "^0.1.3",
-    "hexo-generator-index": "^0.2.0",
-    "hexo-generator-search": "^2.2.5",
-    "hexo-generator-tag": "^0.2.0",
-    "hexo-include-markdown": "1.0.2",
-    "hexo-neat": "^1.0.4",
-    "hexo-renderer-ejs": "^0.3.0",
-    "hexo-renderer-less": "^0.2.0",
-    "hexo-renderer-marked": "^0.3.0",
-    "hexo-server": "^0.2.0",
-    "uglify-js": "^2.8.29"
+  "directories": {
+    "doc": "docs",
+    "test": "test"
   },
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:swan-team/swan-docs.git"
+  "dependencies": {
+    "axios": "^0.19.0",
+    "fs-extra": "^8.1.0",
+    "globby": "^10.0.1",
+    "jquery": "^3.4.1",
+    "less": "^3.10.3",
+    "less-loader": "^5.0.0",
+    "markdown-it-task-checkbox": "^1.0.6",
+    "strip-ansi": "^6.0.0",
+    "qrcode.vue": "^1.7.0",
+    "qs": "^6.9.1",
+    "vue-clipboard2": "^0.3.1",
+    "vuepress": "^1.2.0",
+    "vuepress-plugin-container": "^2.1.2",
+    "vuepress-plugin-smooth-scroll": "0.0.9"
   },
-  "keywords": [
-    "swan",
-    "智能小程序",
-    "文档"
-  ],
-  "author": "swan-team"
+  "keywords": [],
+  "author": "swan-team",
+  "license": "ISC"
 }

package.json

@@ -0,0 +1,74 @@
+/**
+ * @file 配置文件
+ * @author wulinfei
+ */
+
+const router = require('./plugins/router.js');
+const navLoader = require('./utils/nav-loader');
+const preWrapper = require('./plugins/code-pre-wapper');
+const search = require('./plugins/gen-search');
+const container = require('./plugins/container');
+const path = require('path');
+
+module.exports = {
+    base: '/docs/',
+    title: '百度智能小程序文档',
+    head: [
+        ['link', {rel: 'shortcut icon', href: 'https://www.baidu.com/favicon.ico', type: 'image/x-icon'}],
+        ['link', {rel: 'dns-prefetch', href: '//smartprogram.baidu.com'}]
+    ],
+    port: 4000,
+    dest: 'output/miniappdocs-program',
+    cache: false,
+    shouldPrefetch: () => false,
+    extraWatchFiles: [
+        '../nav/nav.yml'
+    ],
+    themeConfig: {
+        navData: navLoader.getNavData(),
+        nav: {
+            navOther: [
+                {text: '服务市场', link: 'https://smartprogram.baidu.com/developer/servicemarket.html'}
+            ],
+            smartDocs: 'https://smartprogram.baidu.com/docs/',
+            smartProgram: 'https://smartprogram.baidu.com/developer/index.html'
+        },
+        headerNavOther: [
+            {text: '社区', link: 'https://smartprogram.baidu.com/forum/'}
+        ]
+    },
+    plugins: [
+        router,
+        search,
+        container,
+        ['vuepress-plugin-smooth-scroll', false]
+    ],
+    patterns: [],
+    extendMarkdown: md => {
+        // Convert '\n' in paragraphs into <br>
+        md.set({breaks: true});
+        md.use(require('./plugins/md-loader'), md);
+        md.use(require('markdown-it-task-checkbox'), {
+            disabled: false,
+            ulClass: 'task-list',
+            liClass: 'task-list-item'
+        });
+
+    },
+    chainMarkdown(config) {
+        config.plugin('pre-wrapper').use(preWrapper);
+    },
+    devServer: {
+        disableHostCheck: true,
+        proxy: {
+            '/forum/api/*': {
+                target: 'http://cp01-lizhiguang.epc.baidu.com:8014',
+                ws: true,
+                changeOrigin: true
+            }
+        }
+    }
+};
+
+
+

program-docs/docs/.vuepress/config.js

@@ -0,0 +1,51 @@
+/**
+ * @file 客户端应用的增强
+ * @author wulinfei
+ */
+
+const VueClipboard = require('vue-clipboard2');
+
+const hashRegx = /^#(\d)/;
+export default ({Vue, router}) => {
+    // 代码片段支持复制
+    Vue.use(VueClipboard);
+
+    // 支持平滑滚动
+    router.options.scrollBehavior = (to, from, savedPosition) => {
+        if (savedPosition) {
+            return window.scrollTo({
+                top: savedPosition.y,
+                behavior: 'smooth'
+            });
+        }
+        else if (to.hash) {
+            // 将数字开头的hash前加上 _ 
+            const hashId = to.hash.replace(hashRegx, '#_$1').toLowerCase();
+
+            const targetElement = document.querySelector(hashId);
+            if (targetElement) {
+                return window.scrollTo({
+                    top: getElementPosition(targetElement).y - 120,
+                    behavior: 'smooth'
+                });
+            }
+            return false;
+        }
+        else {
+            return window.scrollTo({
+                top: 0,
+                behavior: 'smooth'
+            });
+        }
+    };
+};
+
+function getElementPosition(el) {
+    const docEl = document.documentElement;
+    const docRect = docEl.getBoundingClientRect();
+    const elRect = el.getBoundingClientRect();
+    return {
+        x: elRect.left - docRect.left,
+        y: elRect.top - docRect.top
+    };
+}

program-docs/docs/.vuepress/enhanceApp.js

@@ -0,0 +1,32 @@
+/**
+ * @file code代码重新包装
+ * @author wulinfei
+ */
+
+const extensionLanguageMap = {
+    swan: 'markup',
+    md: 'markdown',
+    ts: 'typescript',
+    py: 'python',
+    sh: 'bash',
+    yml: 'yaml'
+};
+
+const getLangExtension = exlang => {
+    const lowerlang = exlang.toLowerCase();
+    return extensionLanguageMap[lowerlang] || lowerlang;
+};
+
+module.exports = md => {
+    const fence = md.renderer.rules.fence;
+    md.renderer.rules.fence = (...args) => {
+        const [tokens, idx] = args;
+        const token = tokens[idx];
+        const rawlang = token.info.trim();
+        token.info = getLangExtension(rawlang);
+        const tabName = rawlang.toUpperCase() || 'TEXT';
+        const rawCode = fence(...args);
+        return `<!--beforebegin--><CodeTabContent name="${tabName}">`
+        + `<!--afterbegin-->${rawCode}<!--beforeend--></CodeTabContent><!--afterend-->`;
+    };
+};

program-docs/docs/.vuepress/plugins/code-pre-wapper.js

@@ -0,0 +1,45 @@
+/**
+ * @file container.js
+ * @description 文档内容组件
+ * @author wulinfei
+ */
+
+module.exports = {
+    plugins: [
+        // 代码块Tab
+        ['container', {
+            type: 'codeTab',
+            defaultTitle: '',
+            before: info => `<CodeTab>${info}`,
+            after: '</CodeTab>'
+        }],
+        // 二维码
+        ['container', {
+            type: 'qrcode',
+            defaultTitle: '',
+            before: info => `<QRCode ${info}>`,
+            after: '</QRCode>'
+        }],
+        // 提示中的error 用于bug等 红色
+        ['container', {
+            type: 'errorTip',
+            defaultTitle: 'Bug'
+        }],
+        // 提示中的info 用于tip等 绿色
+        ['container', {
+            type: 'infoTip',
+            defaultTitle: 'Tip'
+        }],
+        // 打开开发者工具
+        ['container', {
+            type: 'openIde',
+            before: info => `<OpenIde ${info}>`,
+            after: '</OpenIde>'
+        }],
+        // 设计指南
+        ['container', {
+            type: 'design',
+            defaultTitle: '设计指南'
+        }]
+    ]
+};