Skip to content

Commit

Permalink
docs: add boilerplate type desc (#2250)
Browse files Browse the repository at this point in the history
  • Loading branch information
QC-L authored and atian25 committed Mar 21, 2018
1 parent 9007b58 commit 5b059db
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/en/intro/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,8 @@ That is all of it, for more detail, see [Unit Testing](../core/unittest.md).

We can only touch the tip of the iceberg of Egg with the above short sections.
Where to go from here? read our documentation to better understand the framework.

- About Egg boilerplate type, See [Boilerplate Type Description](../tutorials/index.md).
- Egg provides a powerful mechanism for extending features. See [Plugin](../basics/plugin.md).
- Egg framework allows small or large teams to work together as fast as possible under the well-documented conventions and coding best practices. In addition, the teams can build up logics on top of the framework to better suit their special needs. See more on [Frameworks].(../advanced/framework.md).
- Egg framework provides code reusabilities and modularities. See details at [Progressive](../tutorials/progressive.md).
Expand Down
16 changes: 16 additions & 0 deletions docs/source/en/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ title: Tutorials
- [Progressive Development](./progressive.md)
- [RESTful API](./restful.md)

## Boilerplate Type Description

You can use boilerplate type like this:

```bash
$ egg-init --type=simple
```
### Options

boilerplate type | Description
:----: | ----:
simple | Simple egg app boilerplate
empty | Empty egg app boilerplate
plugin | egg plugin boilerplate
framework | egg framework boilerplate

## Template Engines

Build in [egg-view] as template engine solution and support multiple render, which is called by plugin but keeping the consistent render API. Refer to [how to use templates](../core/view.md),More details on [template plugin development](../advanced/view-plugin.md).
Expand Down
1 change: 1 addition & 0 deletions docs/source/zh-cn/intro/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,7 @@ $ npm test

短短几章内容,只能讲 Egg 的冰山一角,我们建议开发者继续阅读其他章节:

- 关于骨架类型,参见[骨架说明](../tutorials/index.md)
- 提供了强大的扩展机制,参见[插件](../basics/plugin.md)
- 一个大规模的团队需要遵循一定的约束和约定,在 Egg 里我们建议封装适合自己团队的上层框架,参见 [框架开发](../advanced/framework.md)
- 这是一个渐进式的框架,代码的共建,复用和下沉,竟然可以这么的无痛,建议阅读 [渐进式开发](../tutorials/progressive.md)
Expand Down
17 changes: 17 additions & 0 deletions docs/source/zh-cn/tutorials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ title: 教程
- [渐进式开发](./progressive.md)
- [RESTful API](./restful.md)

## 骨架类型说明

你可以使用骨架类型,像下面这样:

```bash
$ egg-init --type=simple
```

### 选项

骨架类型 | 说明
:----: | ----:
simple | 简单 egg 应用程序骨架
empty | 空的 egg 应用程序骨架
plugin | egg plugin 骨架
framework | egg framework 骨架

## 模板引擎

框架内置 [egg-view] 作为模板解决方案,并支持多模板渲染,每个模板引擎都以插件的方式引入,但保持渲染的 API 一致。查看[如何使用模板](../core/view.md),如果想更深入的了解,可以查看[模板插件开发](../advanced/view-plugin.md)
Expand Down

0 comments on commit 5b059db

Please sign in to comment.