From 7f7eaad414bb66678e540ec325d8199a03c0841f Mon Sep 17 00:00:00 2001 From: xudafeng Date: Sun, 6 Jan 2019 18:32:52 +0800 Subject: [PATCH] chore: add docs --- .travis.yml | 7 ++ README.zh-CN.md | 2 +- docs/.vuepress/config.js | 111 ++++++++++++++++++ docs/.vuepress/override.styl | 4 + docs/README.md | 15 +++ .../{ => archive}/integrate-with-gitlab-ci.md | 0 .../integrate-with-gitlab-ci.zh-CN.md | 0 docs/{ => archive}/integrate-with-jenkins.md | 0 .../integrate-with-jenkins.zh-CN.md | 0 docs/{ => archive}/jenkins-android.md | 0 docs/{ => archive}/jenkins-android.zh-CN.md | 0 docs/{ => archive}/jenkins-ios.md | 0 docs/{ => archive}/jenkins-ios.zh-CN.md | 0 docs/{ => archive}/jenkins-web.md | 0 docs/{ => archive}/jenkins-web.zh-CN.md | 0 docs/{ => archive}/marmot-web-deploy.md | 0 docs/{ => archive}/marmot-web-deploy.zh-CN.md | 0 docs/guide/README.md | 3 + docs/zh/README.md | 15 +++ docs/zh/guide/README.md | 1 + package.json | 8 +- 21 files changed, 163 insertions(+), 3 deletions(-) create mode 100644 docs/.vuepress/config.js create mode 100644 docs/.vuepress/override.styl create mode 100644 docs/README.md rename docs/{ => archive}/integrate-with-gitlab-ci.md (100%) rename docs/{ => archive}/integrate-with-gitlab-ci.zh-CN.md (100%) rename docs/{ => archive}/integrate-with-jenkins.md (100%) rename docs/{ => archive}/integrate-with-jenkins.zh-CN.md (100%) rename docs/{ => archive}/jenkins-android.md (100%) rename docs/{ => archive}/jenkins-android.zh-CN.md (100%) rename docs/{ => archive}/jenkins-ios.md (100%) rename docs/{ => archive}/jenkins-ios.zh-CN.md (100%) rename docs/{ => archive}/jenkins-web.md (100%) rename docs/{ => archive}/jenkins-web.zh-CN.md (100%) rename docs/{ => archive}/marmot-web-deploy.md (100%) rename docs/{ => archive}/marmot-web-deploy.zh-CN.md (100%) create mode 100644 docs/guide/README.md create mode 100644 docs/zh/README.md create mode 100644 docs/zh/guide/README.md diff --git a/.travis.yml b/.travis.yml index b20f8dc..97752b7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -17,6 +17,13 @@ install: - npm i npminstall && npminstall script: + - npm run docs:build + - cd ./docs_dist + - git init + - git add --all . + - git commit -m "Travis CI Auto Builder" + - git push --quiet --force https://$REPO_TOKEN@github.com/macacajs/reliable.git master:gh-pages + - cd .. - MYSQL_PORT=13306 npm run ci after_script: diff --git a/README.zh-CN.md b/README.zh-CN.md index 3d3e0f2..3e3c56c 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -2,7 +2,7 @@ --- -> 持续交付测试套件 +> Macaca 的持续交付服务套件 ## 文档 diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js new file mode 100644 index 0000000..58c434e --- /dev/null +++ b/docs/.vuepress/config.js @@ -0,0 +1,111 @@ +'use strict'; + +const macacaEcosystem = require('macaca-ecosystem'); + +const name = 'reliable'; + +const title = 'Reliable'; + +module.exports = { + dest: 'docs_dist', + base: `/${name}/`, + + locales: { + '/': { + lang: 'en-US', + title, + description: 'Testing management suite with continuous delivery support.', + }, + '/zh/': { + lang: 'zh-CN', + title, + description: 'Macaca 的持续交付服务套件。', + }, + }, + head: [ + ['link', { + rel: 'icon', + href: 'https://macacajs.github.io/assets/favicon.ico' + }], + ['script', { + async: true, + src: 'https://www.googletagmanager.com/gtag/js?id=UA-49226133-2', + }, ''], + ['script', {}, ` + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'UA-49226133-2'); + `], + ['style', {}, ` + img { + width: 100%; + } + `] + ], + serviceWorker: true, + themeConfig: { + repo: `macacajs/${name}`, + editLinks: true, + docsDir: 'docs_src', + locales: { + '/': { + label: 'English', + selectText: 'Languages', + editLinkText: 'Edit this page on GitHub', + lastUpdated: 'Last Updated', + serviceWorker: { + updatePopup: { + message: 'New content is available.', + buttonText: 'Refresh', + }, + }, + nav: [ + { + text: 'Guide', + link: '/guide/' + }, + macacaEcosystem.en, + ], + sidebar: { + '/guide/': genSidebarConfig('Guide', 'Usage', 'Advanced'), + }, + }, + '/zh/': { + label: '简体中文', + selectText: '选择语言', + editLinkText: '在 GitHub 上编辑此页', + lastUpdated: '上次更新', + serviceWorker: { + updatePopup: { + message: '发现新内容可用', + buttonText: '刷新', + }, + }, + nav: [ + { + text: '指南', + link: '/zh/guide/' + }, + macacaEcosystem.zh, + ], + sidebar: { + '/zh/guide/': genSidebarConfig('指南'), + }, + }, + }, + }, +}; + +function genSidebarConfig(guide) { + return [ + { + title: guide, + collapsable: false, + children: [ + '', + 'usage', + ], + }, + ]; +} diff --git a/docs/.vuepress/override.styl b/docs/.vuepress/override.styl new file mode 100644 index 0000000..4e547a7 --- /dev/null +++ b/docs/.vuepress/override.styl @@ -0,0 +1,4 @@ +$textColor = #2c3e50 +$borderColor = #eaecef +$accentColor = #ee6723 +$codeBgColor = #282c34 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..00b9f3b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +--- + +home: true +heroImage: https://macacajs.github.io/reliable-logo/svg/logo-2.svg +actionText: Try it Out → +actionLink: /guide/ +footer: MIT Licensed | Copyright © 2015-present Macaca + +--- + +::: tip +UITest support running in the browser. +::: + +![](http://ww3.sinaimg.cn/large/6d308bd9gw1f6wsic5dmxj20rl0qqtbi.jpg) diff --git a/docs/integrate-with-gitlab-ci.md b/docs/archive/integrate-with-gitlab-ci.md similarity index 100% rename from docs/integrate-with-gitlab-ci.md rename to docs/archive/integrate-with-gitlab-ci.md diff --git a/docs/integrate-with-gitlab-ci.zh-CN.md b/docs/archive/integrate-with-gitlab-ci.zh-CN.md similarity index 100% rename from docs/integrate-with-gitlab-ci.zh-CN.md rename to docs/archive/integrate-with-gitlab-ci.zh-CN.md diff --git a/docs/integrate-with-jenkins.md b/docs/archive/integrate-with-jenkins.md similarity index 100% rename from docs/integrate-with-jenkins.md rename to docs/archive/integrate-with-jenkins.md diff --git a/docs/integrate-with-jenkins.zh-CN.md b/docs/archive/integrate-with-jenkins.zh-CN.md similarity index 100% rename from docs/integrate-with-jenkins.zh-CN.md rename to docs/archive/integrate-with-jenkins.zh-CN.md diff --git a/docs/jenkins-android.md b/docs/archive/jenkins-android.md similarity index 100% rename from docs/jenkins-android.md rename to docs/archive/jenkins-android.md diff --git a/docs/jenkins-android.zh-CN.md b/docs/archive/jenkins-android.zh-CN.md similarity index 100% rename from docs/jenkins-android.zh-CN.md rename to docs/archive/jenkins-android.zh-CN.md diff --git a/docs/jenkins-ios.md b/docs/archive/jenkins-ios.md similarity index 100% rename from docs/jenkins-ios.md rename to docs/archive/jenkins-ios.md diff --git a/docs/jenkins-ios.zh-CN.md b/docs/archive/jenkins-ios.zh-CN.md similarity index 100% rename from docs/jenkins-ios.zh-CN.md rename to docs/archive/jenkins-ios.zh-CN.md diff --git a/docs/jenkins-web.md b/docs/archive/jenkins-web.md similarity index 100% rename from docs/jenkins-web.md rename to docs/archive/jenkins-web.md diff --git a/docs/jenkins-web.zh-CN.md b/docs/archive/jenkins-web.zh-CN.md similarity index 100% rename from docs/jenkins-web.zh-CN.md rename to docs/archive/jenkins-web.zh-CN.md diff --git a/docs/marmot-web-deploy.md b/docs/archive/marmot-web-deploy.md similarity index 100% rename from docs/marmot-web-deploy.md rename to docs/archive/marmot-web-deploy.md diff --git a/docs/marmot-web-deploy.zh-CN.md b/docs/archive/marmot-web-deploy.zh-CN.md similarity index 100% rename from docs/marmot-web-deploy.zh-CN.md rename to docs/archive/marmot-web-deploy.zh-CN.md diff --git a/docs/guide/README.md b/docs/guide/README.md new file mode 100644 index 0000000..4de752e --- /dev/null +++ b/docs/guide/README.md @@ -0,0 +1,3 @@ +# Introduction + + diff --git a/docs/zh/README.md b/docs/zh/README.md new file mode 100644 index 0000000..2f4c32c --- /dev/null +++ b/docs/zh/README.md @@ -0,0 +1,15 @@ +--- + +home: true +heroImage: https://macacajs.github.io/reliable-logo/svg/logo-2.svg +actionText: 使用文档 +actionLink: /zh/guide/ +footer: MIT Licensed | Copyright © 2015-present Macaca + +--- + +::: tip +当然，UITest 也支持在命令行环境运行。 +::: + +![](http://ww1.sinaimg.cn/large/6d308bd9gw1f6wsibnfldg20nk0gr7kg.gif) diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md new file mode 100644 index 0000000..fb5ab53 --- /dev/null +++ b/docs/zh/guide/README.md @@ -0,0 +1 @@ +# 简单介绍 diff --git a/package.json b/package.json index 964f1e9..390f780 100644 --- a/package.json +++ b/package.json @@ -25,9 +25,11 @@ "eslint-config-antife": "^1.0.3", "eslint-config-egg": "^6.0.0", "git-contributor": "^1.0.8", + "macaca-ecosystem": "*", "mysql2": "^1.6.4", "sinon": "^6.1.4", - "uuid": "^3.3.2" + "uuid": "^3.3.2", + "vuepress": "^0.14.8" }, "engines": { "node": ">=8.9.0" @@ -55,7 +57,9 @@ "db:seed:all": "sequelize db:seed:all", "db:seed:undo:all": "sequelize db:seed:undo:all", "migration:generate": "sequelize migration:generate --name", - "seed:generate": "sequelize seed:generate --name" + "seed:generate": "sequelize seed:generate --name", + "docs:dev": "vuepress dev docs", + "docs:build": "vuepress build docs" }, "repository": { "type": "git",