Browse Source

Merge pull request #20 from emqx/doc_build

Add document build
jinfahua 5 years atrás
parent
commit
f4f4049df9
7 changed files with 2931 additions and 0 deletions
  1. 3 0
      .gitignore
  2. 2 0
      docs/LANGS.md
  3. 45 0
      docs/book.json
  4. 9 0
      docs/en_US/SUMMARY.md
  5. 24 0
      docs/package.json
  6. 2843 0
      docs/yarn.lock
  7. 5 0
      docs/zh_CN/SUMMARY.md

+ 3 - 0
.gitignore

@@ -18,6 +18,9 @@ log/*
 
 .git/
 .idea/
+.DS_Store
+_book
+node_modules/
 
 go.sum
 _build

+ 2 - 0
docs/LANGS.md

@@ -0,0 +1,2 @@
+* [中文](zh_CN/)
+* [English](en_US/)

+ 45 - 0
docs/book.json

@@ -0,0 +1,45 @@
+{
+  "plugins": [
+    "prism",
+    "-highlight",
+    "-sharing",
+    "simple-page-toc",
+    "anchors",
+    "copy-code-button",
+    "anchor-navigation-ex",
+    "cuav-chapters",
+    "local-pagefooter"
+  ],
+  "pluginsConfig": {
+    "prism": {
+      "lang": {
+        "shell": "bash"
+      }
+    },
+    "anchor-navigation-ex": {
+      "showLevel": false
+    },
+    "local-pagefooter": {
+      "copyright": "© Copyright 2016-2019, EMQ Technologies Co., Ltd.",
+      "islocal": true,
+      "modify_label": "The document reversion time: ",
+      "modify_format": "YYYY-MM-DD HH:mm:ss"
+    }
+  },
+  "styles": {
+    "website": "styles/website.css",
+    "ebook": "styles/ebook.css",
+    "pdf": "styles/pdf.css",
+    "mobi": "styles/mobi.css",
+    "epub": "styles/epub.css"
+  },
+  "title": "Kuiper",
+  "author": "EMQX Team",
+  "language": "zh",
+  "links": {
+    "sharing": {
+      "facebook": false,
+      "twitter": false
+    }
+  }
+}

+ 9 - 0
docs/en_US/SUMMARY.md

@@ -0,0 +1,9 @@
+- [Introduction](./README.md)
+- [Getting started](./getting_started.md)
+
+- [Reference Guide](./reference.md)
+  - [Install and operation](operation/overview.md)
+  - [Command line interface tools - CLI](cli/overview.md)
+  - [Kuiper SQL reference](sqls/overview.md)
+  - [Rules](rules/overview.md)
+  - [Extend Kuiper](extension/overview.md)

+ 24 - 0
docs/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "emqx-kuiper-docs",
+  "version": "1.0.0",
+  "description": "EMQ X Kuiper Docs",
+  "main": "index.js",
+  "author": "emqx team",
+  "license": "Apache 2.0",
+  "private": true,
+  "scripts": {
+    "build:before": "cp ../README.md en_US/ && mv zh_CN/index.md zh_CN/README.md && mv en_US/index.md en_US/reference.md",
+    "build:after": "mv zh_CN/README.md zh_CN/index.md && rm -rf en_US/README.md && mv en_US/reference.md en_US/index.md",
+    "serve": "npm run build:before && gitbook serve",
+    "reset": "npm run build:after",
+    "docs": "npm run build:before && gitbook install && gitbook serve",
+    "html": "npm run build:before && gitbook install && gitbook build . _book && npm run build:after",
+    "pdf": "npm run build:before && gitbook install && gitbook pdf . _book.pdf && npm run build:after"
+  },
+  "dependencies": {
+    "gitbook-cli": "^2.3.2",
+    "glob": "^7.1.3",
+    "node-xlsx": "^0.15.0",
+    "pangu": "^3.3.0"
+  }
+}

File diff suppressed because it is too large
+ 2843 - 0
docs/yarn.lock


+ 5 - 0
docs/zh_CN/SUMMARY.md

@@ -0,0 +1,5 @@
+- [安装与操作](operation/overview.md)
+- [命令行界面工具-CLI](cli/overview.md)
+- [Kuiper SQL参考](sqls/overview.md)
+- [规则](rules/overview.md)
+- [扩展Kuiper](extension/overview.md)