feat: Doctools (#6)

Author: thonatos

.github/actions-node/Dockerfile

@@ -0,0 +1,17 @@
+FROM node:lts-slim
+
+LABEL "com.github.actions.name"="node"
+LABEL "com.github.actions.description"="Deploy to Github Pages"
+LABEL "com.github.actions.icon"="mic"
+LABEL "com.github.actions.color"="purple"
+
+LABEL "repository"="https://github.com/eggjs/eggjs.github.io"
+LABEL "homepage"="https://github.com/eggjs/eggjs.github.io"
+LABEL "maintainer"="Suyi <[email protected]>"
+
+RUN \
+    apt-get update -y && \
+    apt-get install -y git
+
+ADD entrypoint.sh /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]

.github/actions-node/entrypoint.sh

@@ -0,0 +1,5 @@
+#!/bin/sh -l
+
+sh -c "env";
+
+sh -c "$*";

.github/main.workflow

@@ -0,0 +1,24 @@
+workflow "Push" {
+  on = "push"
+  resolves = ["Deployment"]
+}
+
+action "Installation" {
+  needs = "Filters for GitHub Actions"
+  uses = "./.github/actions-node/"
+  args = "yarn"
+}
+
+action "Deployment" {
+  needs = "Installation"
+  uses = "./.github/actions-node/"
+  args = "yarn deploy"
+  secrets = ["GITHUB_TOKEN"]
+}
+
+# Filter for 1.0 branch
+action "Filters for GitHub Actions" {
+  uses = "actions/bin/filter@3c0b4f0e63ea54ea5df2914b4fabf383368cd0da"
+  secrets = ["GITHUB_TOKEN"]
+  args = "branch 1.0"
+}

.gitignore

@@ -1,3 +1,4 @@
 checklist
 node_modules/
 yarn.lock
+run/

config.js

@@ -0,0 +1,117 @@
+module.exports = {
+  clearScreen: false,
+  siteConfig: {
+    title: 'Egg',
+    host: '0.0.0.0',
+    description: 'Egg 文档',
+    evergreen: true,
+    locales: {
+      '/': {
+        lang: 'en-US',
+        title: 'Egg',
+        description:
+          'Born to build better enterprise frameworks and apps with Node.js & Koa',
+      },
+      '/zh/': {
+        lang: 'zh-CN',
+        title: 'Egg',
+        description: '为企业级框架和应用而生',
+      },
+    },
+    markdown: {
+      lineNumbers: true,
+    },
+    devServer: {
+      overlay: {
+        // warnings: true,
+        errors: true,
+      },
+    },
+    themeConfig: {
+      locales: {
+        '/': {
+          selectText: 'Languages',
+          label: 'English',
+          editLinkText: 'Edit this page on GitHub',
+          serviceWorker: {
+            updatePopup: {
+              message: 'New content is available.',
+              buttonText: 'Refresh',
+            },
+          },
+          nav: [
+            { text: 'Home', link: '/' },
+            { text: 'QuickStart', link: '/quickstart/' },
+            { text: 'Guide', link: '/guide/' },
+          ],
+          sidebar: {
+            '/quickstart/': [['./', 'QuickStart'], 'egg'],
+
+            '/guide/': [
+              ['./', 'Description'],
+              // 'directory',
+              // 'middleware',
+              // 'controller',
+              // 'router',
+              // 'service',
+              // 'application',
+              // 'context',
+              // 'config',
+              // 'logger',
+              // 'cookie',
+              // 'session',
+              // 'helper',
+              // 'httpclient',
+              // 'error_handler',
+              // 'lifecycle',
+              // 'plugin',
+              // 'upload',
+              // 'i18n',
+            ],
+          },
+        },
+        '/zh/': {
+          selectText: '选择语言',
+          label: '简体中文',
+          editLinkText: '在 GitHub 上编辑此页',
+          serviceWorker: {
+            updatePopup: {
+              message: '发现新内容可用.',
+              buttonText: '刷新',
+            },
+          },
+          nav: [
+            { text: '首页', link: '/zh/' },
+            { text: '快速开始', link: '/zh/quickstart/' },
+            { text: '教程', link: '/zh/guide/' },
+          ],
+          sidebar: {
+            '/zh/quickstart/': [['./', '快速开始'], 'egg'],
+
+            '/zh/guide/': [
+              ['./', '概述'],
+              'directory',
+              'middleware',
+              'controller',
+              'router',
+              'service',
+              'application',
+              'context',
+              'config',
+              'logger',
+              'cookie',
+              'session',
+              'helper',
+              'httpclient',
+              'error_handler',
+              'lifecycle',
+              'plugin',
+              'upload',
+              'i18n',
+            ],
+          },
+        },
+      },
+    },
+  },
+};

docs/.vuepress/config.js

@@ -0,0 +1,3 @@
+---
+title: Simple Egg Application
+---

docs/quickstart/egg.md

@@ -4,8 +4,9 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "dev": "vuepress dev docs",
-    "build": "vuepress build docs"
+    "dev": "doctools dev --configPath config.js",
+    "build": "doctools build --configPath config.js",
+    "deploy": "doctools deploy --configPath config.js --githubToken=true"
   },
   "repository": {
     "type": "git",
@@ -18,6 +19,9 @@
   },
   "homepage": "https://github.com/eggjs/eggjs.github.io#readme",
   "dependencies": {
-    "vuepress": "^1.0.0-alpha.47"
+    "@eggjs/doctools": "^1.0.7"
+  },
+  "devDependencies": {
+    "chokidar": "^3.0.2"
   }
 }