diff --git a/.autod.conf.js b/.autod.conf.js index b9c144ba66..6f857de46c 100644 --- a/.autod.conf.js +++ b/.autod.conf.js @@ -9,7 +9,8 @@ module.exports = { exclude: [ 'test/fixtures', 'examples', - "docs", + 'docs', + 'run', ], devdep: [ 'autod', @@ -17,6 +18,7 @@ module.exports = { 'eslint', 'eslint-config-egg', 'egg-bin', + 'egg-doctools', 'egg-plugin-puml', 'egg-view-nunjucks', ], diff --git a/docs/_config.yml b/docs/_config.yml index 37036bca26..f8b01257a5 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -23,8 +23,3 @@ theme: egg less: compress: true - -# Deployment -## Docs: https://hexo.io/docs/deployment.html -deploy: - type: diff --git a/docs/package.json b/docs/package.json deleted file mode 100644 index 2a0dbe33c8..0000000000 --- a/docs/package.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "name": "egg", - "version": "0.0.0", - "private": true, - "hexo": { - "version": "3.3.5" - }, - "dependencies": { - "hexo": "^3.2.0", - "hexo-generator-index": "^0.2.0", - "hexo-generator-tag": "^0.2.0", - "hexo-renderer-less": "^0.2.0", - "hexo-server": "^0.2.0", - "markdown-it": "^8.2.2", - "markdown-it-replace-link": "^1.0.0", - "markdown-it-toc-and-anchor": "^4.1.1" - } -} \ No newline at end of file diff --git a/docs/plugins.puml b/docs/plugins.puml deleted file mode 100644 index 8923fcdc9a..0000000000 --- a/docs/plugins.puml +++ /dev/null @@ -1,20 +0,0 @@ -@startuml -digraph plugins { - onerror - session - i18n - watcher - multipart - security - development - logrotator - schedule - static - jsonp - view - security -> session - development -> watcher - logrotator -> schedule - jsonp -> security [style=dotted] -} -@enduml diff --git a/docs/source/en/intro/index.md b/docs/source/en/intro/index.md index e590cfe0ea..372004ac69 100644 --- a/docs/source/en/intro/index.md +++ b/docs/source/en/intro/index.md @@ -20,7 +20,7 @@ Egg is a convention-over-configuration framework, follows the [Loader](../advanc - depth [customizd framework](../advanced/framework.md) - highly extensible [plug-in mechanism](../advanced/plugin.md) -- built-in [cluster](../advanced/cluster.md) +- built-in [cluster](../advanced/cluster-client.md) - based on [koa] with high performance - stable core framework with high test coverage. - [progressive development](../tutorials/progressive.md) diff --git a/docs/source/frameworks.md b/docs/source/frameworks.md deleted file mode 100644 index fd74e751f5..0000000000 --- a/docs/source/frameworks.md +++ /dev/null @@ -1,6 +0,0 @@ -title: Frameworks ---- - -# Popular Frameworks - -- [aliyun-egg](https://github.com/eggjs/aliyun-egg) diff --git a/docs/themes/egg/languages/en.yml b/docs/source/languages/en.yml similarity index 98% rename from docs/themes/egg/languages/en.yml rename to docs/source/languages/en.yml index 97f920f3c2..7f168d44c0 100644 --- a/docs/themes/egg/languages/en.yml +++ b/docs/source/languages/en.yml @@ -21,7 +21,7 @@ header: guide_toc: Intro: Guide - What is egg: What is Egg? + What is Egg: What is Egg? Egg and Koa: Egg and Koa Get Start: Quick Start Basics: Basis Function diff --git a/docs/themes/egg/languages/zh-cn.yml b/docs/source/languages/zh-cn.yml similarity index 100% rename from docs/themes/egg/languages/zh-cn.yml rename to docs/source/languages/zh-cn.yml diff --git a/docs/source/member_guide.md b/docs/source/member_guide.md deleted file mode 100644 index 269a8cf24c..0000000000 --- a/docs/source/member_guide.md +++ /dev/null @@ -1 +0,0 @@ -# Member Guide diff --git a/docs/source/plugins.puml b/docs/source/plugins.puml deleted file mode 100644 index a19b2ca8cd..0000000000 --- a/docs/source/plugins.puml +++ /dev/null @@ -1,7 +0,0 @@ - -@startuml -digraph world { - "onerror"; - "session"; -} -@enduml diff --git a/docs/source/zh-cn/core/deployment.md b/docs/source/zh-cn/core/deployment.md index c7aedb2ec2..e8110e4e5c 100644 --- a/docs/source/zh-cn/core/deployment.md +++ b/docs/source/zh-cn/core/deployment.md @@ -55,13 +55,13 @@ EGG_SERVER_ENV=prod nohup node dispatch.js > stdout.log 2> stderr.log & 注意: -- **生产环境使用的 `EGG_SERVER_ENV` 必须为 `prod`**,可查看[运行环境](./basics/env.md)获取更多内容。 +- **生产环境使用的 `EGG_SERVER_ENV` 必须为 `prod`**,可查看[运行环境](../basics/env.md)获取更多内容。 - 如果使用 Docker,可直接前台运行。 - 默认情况框架会创建和 CPU 核数相当的 app worker 数,可以充分的利用 CPU 资源。 ### 自定义框架启动 -如果应用使用了[自定义框架](./advanced/framework.md),还需要指定额外的参数,比如框架为 `yadan`。 +如果应用使用了[自定义框架](../advanced/framework.md),还需要指定额外的参数,比如框架为 `yadan`。 ```js // dispatch.js diff --git a/docs/source/zh-cn/intro/index.md b/docs/source/zh-cn/intro/index.md index 851a23bf65..8ae96a706f 100644 --- a/docs/source/zh-cn/intro/index.md +++ b/docs/source/zh-cn/intro/index.md @@ -23,7 +23,7 @@ Egg 奉行『**约定优于配置**』,按照[一套统一的约定](../advanc - 深度[框架定制](../advanced/framework.md) - 高度可扩展的[插件机制](../advanced/plugin.md) -- 内置[多进程管理](../advanced/cluster.md) +- 内置[多进程管理](../advanced/cluster-client.md) - 基于 [Koa] 开发,性能优异 - 框架稳定,测试覆盖率高 - [渐进式开发](../tutorials/progressive.md) diff --git a/docs/themes/egg/layout/index.swig b/docs/themes/egg/layout/index.swig deleted file mode 100644 index 0b8bf90598..0000000000 --- a/docs/themes/egg/layout/index.swig +++ /dev/null @@ -1,17 +0,0 @@ -