Skip to content

Commit

Permalink
docs: add open in plnkr & copy code.
Browse files Browse the repository at this point in the history
  • Loading branch information
cipchk committed Dec 9, 2017
1 parent bad3001 commit 6ecad15
Show file tree
Hide file tree
Showing 28 changed files with 347 additions and 88 deletions.
2 changes: 1 addition & 1 deletion docs/010-020-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: Advance

本次的变化对项目的改动其实不是很大,在开始阅读指引之前我建议先阅读入门指南序列文章(至少阅读 [关于 Delon](/docs/delon) 文章),这样会更好的理解为何我要这么做。

当前 `0.2` 是以[独立分支](https://github.com/cipchk/ng-alain/tree/0.2.0)在存在,而 [ng-alain](https://cipchk.github.io/ng-alain/) github预览已经是 `0.2` 版本了。
当前 `0.2` 是以[独立分支](//github.com/cipchk/ng-alain/tree/0.2.0)在存在,而 [ng-alain](//cipchk.github.io/ng-alain/) github预览已经是 `0.2` 版本了。

## 一、主题系统、服务、业务组件的变化

Expand Down
2 changes: 1 addition & 1 deletion docs/acl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: ACL
type: Advance
---

ACL 全称叫访问控制列表(Access Control List),是一种非常简单的基于角色权限控制方式,所以如果你需要它,则需要导入 `@delon/acl` 模块;另外你也可以在 [DEMO](https://cipchk.github.io/ng-alain/#/logics/acl) 中体验它。
ACL 全称叫访问控制列表(Access Control List),是一种非常简单的基于角色权限控制方式,所以如果你需要它,则需要导入 `@delon/acl` 模块;另外你也可以在 [DEMO](//cipchk.github.io/ng-alain/#/logics/acl) 中体验它。

```ts
import { AlainACLModule } from '@delon/acl';
Expand Down
2 changes: 1 addition & 1 deletion docs/data-render.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ registerLocaleData(localeZhHans);

## _date

基于 moment 日期格式化,显示更多细节参考:http://momentjs.com/docs/#/displaying
基于 moment 日期格式化,显示更多细节参考://momentjs.com/docs/#/displaying

最大好处是 moment 支持不同种类的时间格式,例如:

Expand Down
6 changes: 3 additions & 3 deletions docs/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ type: Basic
$ npm run build
```

ng-alain 本身是一个 Angular cli 项目,因此也可以参照 [WiKi](https://github.com/angular/angular-cli/wiki/build) 完整更复杂的构建需求。构建打包成功之后,会在根目录生成 `dist` 文件夹,里面就是构建打包好的文件,通常是若干 `*.js``*.css``index.html` 等静态文件。
ng-alain 本身是一个 Angular cli 项目,因此也可以参照 [WiKi](//github.com/angular/angular-cli/wiki/build) 完整更复杂的构建需求。构建打包成功之后,会在根目录生成 `dist` 文件夹,里面就是构建打包好的文件,通常是若干 `*.js``*.css``index.html` 等静态文件。

### 环境变量

Expand All @@ -32,7 +32,7 @@ $ ng serve -e=hmr
$ npm run analyze
```

然后通过 `webpack-bundle-analyzer dist/stats.json`https://webpack.github.io/analyse 查看体积分布数据。
然后通过 `webpack-bundle-analyzer dist/stats.json` 或 //webpack.github.io/analyse 查看体积分布数据。

![](./assets/screenshot/analyzer.png)

Expand Down Expand Up @@ -86,7 +86,7 @@ app.get('home', '/*', 'home.index');

### Docker

`ng-alain` 提供了一个基于 `nginx` WEB服务完整的构建Angular项目的镜像文件。其中 `nginx` 是采用 [nginx:1.13.5-alpine](https://github.com/nginxinc/docker-nginx/blob/master/mainline/alpine/Dockerfile) 的镜像,基本上可以满足 `ng-alain` 项目的良好运行环境,倘若有更多需求,你可以利用 `docker run` 轻易的指定 *nginx.conf*
`ng-alain` 提供了一个基于 `nginx` WEB服务完整的构建Angular项目的镜像文件。其中 `nginx` 是采用 [nginx:1.13.5-alpine](//github.com/nginxinc/docker-nginx/blob/master/mainline/alpine/Dockerfile) 的镜像,基本上可以满足 `ng-alain` 项目的良好运行环境,倘若有更多需求,你可以利用 `docker run` 轻易的指定 *nginx.conf*

#### 1、构建镜像

Expand Down
14 changes: 7 additions & 7 deletions docs/getting-started.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ ng-alain is a production-ready solution for admin interfaces based on ng-zorro-a

## Version

- ng-alain: [![NPM version](https://img.shields.io/npm/v/ng-alain.svg)](https://www.npmjs.com/package/ng-alain)
- `@delon/theme`: [![NPM version](https://img.shields.io/npm/v/@delon/theme.svg)](https://www.npmjs.com/package/@delon/theme)
- `@delon/abc`: [![NPM version](https://img.shields.io/npm/v/@delon/abc.svg)](https://www.npmjs.com/package/@delon/abc)
- `@delon/acl`: [![NPM version](https://img.shields.io/npm/v/@delon/acl.svg)](https://www.npmjs.com/package/@delon/acl)
- ng-alain: [![NPM version](//img.shields.io/npm/v/ng-alain.svg)](//www.npmjs.com/package/ng-alain)
- `@delon/theme`: [![NPM version](//img.shields.io/npm/v/@delon/theme.svg)](//www.npmjs.com/package/@delon/theme)
- `@delon/abc`: [![NPM version](//img.shields.io/npm/v/@delon/abc.svg)](//www.npmjs.com/package/@delon/abc)
- `@delon/acl`: [![NPM version](//img.shields.io/npm/v/@delon/acl.svg)](//www.npmjs.com/package/@delon/acl)

## Installation

Expand All @@ -24,13 +24,13 @@ There are two ways to install:
### Clone the Git Repository

```bash
$ git clone -b 0.2.0 --depth=1 https://github.com/cipchk/ng-alain.git my-project
$ git clone -b 0.2.0 --depth=1 //github.com/cipchk/ng-alain.git my-project
$ cd my-project
```

### Download the Package

Download [https://github.com/cipchk/ng-alain/archive/0.2.0.zip](https://github.com/cipchk/ng-alain/archive/0.2.0.zip), and un-archive.
Download [//github.com/cipchk/ng-alain/archive/0.2.0.zip](//github.com/cipchk/ng-alain/archive/0.2.0.zip), and un-archive.

## Scaffolding

Expand Down Expand Up @@ -79,6 +79,6 @@ or use HMR mode
$ npm run serve:hmr
```

open [http://localhost:4200](http://localhost:4200), If you see the following page then you have succeeded.
open [//localhost:4200](//localhost:4200), If you see the following page then you have succeeded.

![](./assets/screenshot/desktop.png | width=700)
16 changes: 8 additions & 8 deletions docs/getting-started.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ ng-alain 是一个基于 ng-zorro-antd 的企业级中后台前端脚手架,

## 版本

- ng-alain 脚手架:[![NPM version](https://img.shields.io/npm/v/ng-alain.svg)](https://www.npmjs.com/package/ng-alain)
- `@delon/theme`[![NPM version](https://img.shields.io/npm/v/@delon/theme.svg)](https://www.npmjs.com/package/@delon/theme)
- `@delon/abc`[![NPM version](https://img.shields.io/npm/v/@delon/abc.svg)](https://www.npmjs.com/package/@delon/abc)
- `@delon/acl`[![NPM version](https://img.shields.io/npm/v/@delon/acl.svg)](https://www.npmjs.com/package/@delon/acl)
- ng-alain 脚手架:[![NPM version](//img.shields.io/npm/v/ng-alain.svg)](//www.npmjs.com/package/ng-alain)
- `@delon/theme`[![NPM version](//img.shields.io/npm/v/@delon/theme.svg)](//www.npmjs.com/package/@delon/theme)
- `@delon/abc`[![NPM version](//img.shields.io/npm/v/@delon/abc.svg)](//www.npmjs.com/package/@delon/abc)
- `@delon/acl`[![NPM version](//img.shields.io/npm/v/@delon/acl.svg)](//www.npmjs.com/package/@delon/acl)

## 安装

Expand All @@ -24,13 +24,13 @@ ng-alain 是一个基于 ng-zorro-antd 的企业级中后台前端脚手架,
### 直接 clone git 仓库

```bash
$ git clone -b 0.2.0 --depth=1 https://github.com/cipchk/ng-alain.git my-project
$ git clone -b 0.2.0 --depth=1 //github.com/cipchk/ng-alain.git my-project
$ cd my-project
```

### 下载压缩包

点击 [https://github.com/cipchk/ng-alain/archive/0.2.0.zip](https://github.com/cipchk/ng-alain/archive/0.2.0.zip) 下载到本地后解压。
点击 [//github.com/cipchk/ng-alain/archive/0.2.0.zip](//github.com/cipchk/ng-alain/archive/0.2.0.zip) 下载到本地后解压。

## 目录结构

Expand Down Expand Up @@ -69,7 +69,7 @@ ng-alain 是一个标准的 Angular cli 构建的项目,因此你会非常熟
$ npm install
```

如果网络状况不佳,可以使用 [cnpm](https://cnpmjs.org/) 进行加速。
如果网络状况不佳,可以使用 [cnpm](//cnpmjs.org/) 进行加速。

```bash
$ npm start
Expand All @@ -81,6 +81,6 @@ $ npm start
$ npm run serve:hmr
```

启动完成后会打开浏览器访问 [http://localhost:4200](http://localhost:4200),你看到下面的页面就代表成功了。
启动完成后会打开浏览器访问 [//localhost:4200](//localhost:4200),你看到下面的页面就代表成功了。

![](./assets/screenshot/desktop.png | width=700)
4 changes: 2 additions & 2 deletions docs/graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ type: Advance

## 如何使用?

> 如果上面组件不能满足你的业务需求,可以直接试用 [G2](https://antv.alipay.com/zh-cn/g2/3.x/index.html) 封装自己的图表组件。
> 如果上面组件不能满足你的业务需求,可以直接试用 [G2](//antv.alipay.com/zh-cn/g2/3.x/index.html) 封装自己的图表组件。
### 引入 G2

Expand All @@ -51,4 +51,4 @@ npm install @antv/g2 @antv/data-set @antv/g2-plugin-slider --save

`@delon/abc` 提供了一个自定义G2组件的容器,可以减少不必要的组件渲染过程中所产生的奇怪问题。

一个完整的示例见 [chart.md](https://github.com/cipchk/delon/blob/master/src/core/abc/components/charts/demo/chart.md)
一个完整的示例见 [chart.md](//github.com/cipchk/delon/blob/master/src/core/abc/components/charts/demo/chart.md)
2 changes: 1 addition & 1 deletion docs/happy-coding.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ng-alain 默认配置了不生成样式文件&单元测试,因此,你会看

## snippets

vscode 是编写 Angular 最佳的选择,自然 ng-alain 也制作了相应 snippets 扩展插件:[ng-zorro-vscode](https://marketplace.visualstudio.com/items?itemName=cipchk.ng-zorro-vscode)。除了大量的 ng-zorro-antd 组件片断以外,还加入了部分 ng-alain 片断,例如:
vscode 是编写 Angular 最佳的选择,自然 ng-alain 也制作了相应 snippets 扩展插件:[ng-zorro-vscode](//marketplace.visualstudio.com/items?itemName=cipchk.ng-zorro-vscode)。除了大量的 ng-zorro-antd 组件片断以外,还加入了部分 ng-alain 片断,例如:

```
nz-button => 构建一个按钮
Expand Down
14 changes: 7 additions & 7 deletions docs/how-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ type: Basic

当你开始着手在 ng-alain 基础上进行业务开发时,我建议你先了解一下以下文档,这对于亦或是团队每个成员都非常有帮助。

+ [Ant Desig 指引文章](https://ant.design/docs/spec/introduce-cn)
+ [Ant Deisng for Angular](https://ng.ant.design/docs/angular/introduce)
+ [Antv 图表](https://antv.alipay.com/zh-cn/index.html)
+ [Ant Desig 指引文章](//ant.design/docs/spec/introduce-cn)
+ [Ant Deisng for Angular](//ng.ant.design/docs/angular/introduce)
+ [Antv 图表](//antv.alipay.com/zh-cn/index.html)

ng-alain 的基础组件库来自 ng-zorro-antd,因此对于这类组件的使用方式你可以通过其官网得到很细说 [API](https://ng.ant.design/) 文档说明,而对于 ng-alain 提供的组件则通过[组件页](/components)获取。
ng-alain 的基础组件库来自 ng-zorro-antd,因此对于这类组件的使用方式你可以通过其官网得到很细说 [API](//ng.ant.design/) 文档说明,而对于 ng-alain 提供的组件则通过[组件页](/components)获取。

> ng-alain 依赖了一个 [ng-zorro-antd-extra](https://cipchk.github.io/ng-zorro-antd-extra/) 类库,这是它和 ng-zorro-antd 一样,只是提供了一些 3.0 才会有的组件临时解决方案。
> ng-alain 依赖了一个 [ng-zorro-antd-extra](//cipchk.github.io/ng-zorro-antd-extra/) 类库,这是它和 ng-zorro-antd 一样,只是提供了一些 3.0 才会有的组件临时解决方案。
## 如何开始?

ng-alain 的目录非常简单,只有简单几个文件;默认情况下,包含了 [i18n](/docs/i18n)[acl](/docs/acl)[页面模板](/docs/template)等文件。

> 很多情况下,可能你不需要这些功能,上述每个链接中都包含着如何去删除它们的方法。
我们知道,项目从启动开始就需要从远程获取到一些配置信息(例如:菜单数据、用户数据等),ng-alain 的启动始于 [startup.service.ts](https://github.com/cipchk/ng-alain/blob/0.2.0/src/app/core/services/startup.service.ts);它返回的是一个 `Promise` 对象,因此你可以在这个方法体内做你想做的事,默认情况下做了很多有意思的事:
我们知道,项目从启动开始就需要从远程获取到一些配置信息(例如:菜单数据、用户数据等),ng-alain 的启动始于 [startup.service.ts](//github.com/cipchk/ng-alain/blob/0.2.0/src/app/core/services/startup.service.ts);它返回的是一个 `Promise` 对象,因此你可以在这个方法体内做你想做的事,默认情况下做了很多有意思的事:

```ts
// 应用信息:包括站点名、描述、年份
Expand Down Expand Up @@ -123,4 +123,4 @@ const routes: Routes = [
];
```

最终,你可以访问 [list](http://localhost:4200/#/trade/list) 页面。
最终,你可以访问 [list](//localhost:4200/#/trade/list) 页面。
8 changes: 4 additions & 4 deletions docs/layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@ title:
type: Basic
---

页面整体布局是指包含导航、侧边栏、内容区域、页脚等最外层的框架结构。在页面之中,也有很多区块的布局结构,目前 ng-zorro-antd 有两套布局方案:[Layout](https://ng.ant.design/components/layout)[Grid](https://ng.ant.design/components/grid);而后者是日常都需要的,诸如:表单、列表页、明细页等多多少少都会涉及。
页面整体布局是指包含导航、侧边栏、内容区域、页脚等最外层的框架结构。在页面之中,也有很多区块的布局结构,目前 ng-zorro-antd 有两套布局方案:[Layout](//ng.ant.design/components/layout)[Grid](//ng.ant.design/components/grid);而后者是日常都需要的,诸如:表单、列表页、明细页等多多少少都会涉及。

## 根据不同场景区分抽离布局组件

在大部分场景下,我们需要基于上面两个组件封装一些适用于当下具体业务的组件,包含了通用的导航、侧边栏、顶部通知、页面标题等元素。ng-alain 就已经包含了三种不同布局风格:

| 类型 | 位置 | 描述 |
| ---- | --- | ---- |
| 基础 | [LayoutComponent](https://github.com/cipchk/ng-alain/blob/0.2.0/src/app/layout/layout.component.ts) | - |
| 全屏 | [LayoutFullScreenComponent](https://github.com/cipchk/ng-alain/blob/0.2.0/src/app/layout/fullscreen/fullscreen.component.ts) | - |
| PRO用户授权 | [ProUserLayoutComponent](https://github.com/cipchk/ng-alain/blob/0.2.0/src/app/layout/pro/user/user.component.ts) |[pro](https://cipchk.github.io/ng-alain/#/pro/user/login) 用户相关 |
| 基础 | [LayoutComponent](//github.com/cipchk/ng-alain/blob/0.2.0/src/app/layout/layout.component.ts) | - |
| 全屏 | [LayoutFullScreenComponent](//github.com/cipchk/ng-alain/blob/0.2.0/src/app/layout/fullscreen/fullscreen.component.ts) | - |
| PRO用户授权 | [ProUserLayoutComponent](//github.com/cipchk/ng-alain/blob/0.2.0/src/app/layout/pro/user/user.component.ts) |[pro](//cipchk.github.io/ng-alain/#/pro/user/login) 用户相关 |

## 如何使用

Expand Down
2 changes: 1 addition & 1 deletion docs/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ng-alain 默认下有两处对任何网络请求进行一些处理。

## 一、扩展 HttpClient

`@delon/theme` 包含了一个叫 [_HttpClient](https://github.com/cipchk/delon/blob/master/src/core/theme/services/http/http.client.ts) 类,其本质还是调用 Angular 的 `HttpClient`,只是包裹了一个 `loading`
`@delon/theme` 包含了一个叫 [_HttpClient](//github.com/cipchk/delon/blob/master/src/core/theme/services/http/http.client.ts) 类,其本质还是调用 Angular 的 `HttpClient`,只是包裹了一个 `loading`

我们知道 ng-zorro-antd 充斥着大量 `nzLoading` 属性,它可以让网络请求的加载有更友好的体验,这样我们无须在每一个业务页面维护一个 `loadind` 变量。

Expand Down
2 changes: 1 addition & 1 deletion docs/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: Advance

## Web 图标

默认除了 ng-zorro-antd 自带 Web 图标,额外增加了 [font-awesome](http://fontawesome.io/)[simple-line-icons](http://simplelineicons.com/)[weather-icons](http://erikflowers.github.io/weather-icons/) 三个图标库,如果你明确不需要,可以删除:
默认除了 ng-zorro-antd 自带 Web 图标,额外增加了 [font-awesome](//fontawesome.io/)[simple-line-icons](//simplelineicons.com/)[weather-icons](//erikflowers.github.io/weather-icons/) 三个图标库,如果你明确不需要,可以删除:

+ 移除 `src/styles.less` 引用样式文件
+ 移除相应包体
Expand Down
Loading

0 comments on commit 6ecad15

Please sign in to comment.