Browse Source

Update document

pull/4326/head
liangshiwei 6 years ago
parent
commit
a530566e22
  1. 29
      docs/en/Modules/Docs.md
  2. 8
      docs/en/Modules/Virtual-File-Explorer.md
  3. 30
      docs/zh-Hans/Modules/Docs.md
  4. 8
      docs/zh-Hans/Modules/Virtual-File-Explorer.md

29
docs/en/Modules/Docs.md

@ -58,14 +58,18 @@ Now an empty ABP project has been created! You can now run your project and see
To login your website enter `admin` as the username and `1q2w3E*` as the password.
### 2- Referencing Docs Module Packages
### 3- Installation Module
Docs module packages are hosted on NuGet. There are 4 packages that needs be to installed to your application. Each package has to be installed to the relevant project.
#### 3.1- Use ABP CLI
It is recommended to use the ABP CLI to install the module, open the CMD window in the solution file (`.sln`) directory, and run the following command:
`abp add-module Volo.Docs`
#### 3.2- Manually install
Or you can also manually install nuget package to each project:
* Install [Volo.Docs.Domain](https://www.nuget.org/packages/Volo.Docs.Domain/) nuget package to `Acme.MyProject.Domain` project.
@ -84,7 +88,7 @@ Or you can also manually install nuget package to each project:
`Install-Package Volo.Docs.Web`
### 3- Adding Module Dependencies
##### 3.2.1- Adding Module Dependencies
An ABP module must declare `[DependsOn]` attribute if it has a dependency upon another module. Each module has to be added in`[DependsOn]` attribute to the relevant project.
@ -165,6 +169,27 @@ An ABP module must declare `[DependsOn]` attribute if it has a dependency upon a
}
```
##### 3.2.2- Adding NPM Package
Open `package.json` and add `@abp/docs": "^2.9.0` as shown below:
```json
{
"version": "1.0.0",
"name": "my-app",
"private": true,
"dependencies": {
"@abp/aspnetcore.mvc.ui.theme.basic": "^2.9.0",
"@abp/docs": "^2.9.0"
}
}
```
Then open the command line terminal in the `Acme.MyProject.Web` project folder and run the following command:
1. `yarn`
2. `gulp`
### 4- Database Integration
#### 4.1- Entity Framework Integration

8
docs/en/Modules/Virtual-File-Explorer.md

@ -8,19 +8,21 @@ Virtual File Explorer Module provided a simple UI to view all files in [virtual
### Installation
#### 1- Referencing Virtual File Explorer Module Packages
#### 1- Use ABP CLI
It is recommended to use the ABP CLI to install the module, open the CMD window in the solution file (`.sln`) directory, and run the following command:
`abp add-module Volo.VirtualFileExplorer`
#### 2- Manually install
Or you can also manually install nuget package to `Acme.MyProject.Web` project:
* Install [Volo.Abp.VirtualFileExplorer.Web](https://www.nuget.org/packages/Volo.Abp.VirtualFileExplorer.Web/) nuget package to `Acme.MyProject.Web` project.
`Install-Package Volo.Abp.VirtualFileExplorer.Web`
#### 2- Adding Module Dependencies
##### 2.1- Adding Module Dependencies
* Open `MyProjectWebModule.cs`and add `typeof(AbpVirtualFileExplorerWebModule)` as shown below;
@ -40,7 +42,7 @@ Or you can also manually install nuget package to `Acme.MyProject.Web` project:
}
```
#### 3- Adding NPM Package
##### 2.2- Adding NPM Package
* Open `package.json` and add `@abp/virtual-file-explorer": "^2.9.0` as shown below:

30
docs/zh-Hans/Modules/Docs.md

@ -58,14 +58,18 @@ ABP框架的[文档](docs.abp.io)也是使用的此模块.
输入用户名 `admin` 密码 `1q2w3E*` 登录到网站.
### 2- 引用文档模块包
### 3- 安装模块
文档模块包托管在Nuget上面. 需要有四个包安装到你的应用程序中. 每个包必须安装到相关的项目.
#### 3.1- 使用ABP CLI
建议使用ABP CLI安装模块,在解决方案文件 (`.sln`) 目录打开 `CMD` 窗口,运行以下命令:
`abp add-module Volo.Docs`
#### 3.2- 手动安装
或者你也可以手动安装nuget包到每个项目:
* 安装[Volo.Docs.Domain](https://www.nuget.org/packages/Volo.Docs.Domain/) nuget包到 `Acme.MyProject.Domain` 项目.
@ -83,7 +87,7 @@ ABP框架的[文档](docs.abp.io)也是使用的此模块.
* 安装[Volo.Docs.Web](https://www.nuget.org/packages/Volo.Docs.Domain/) nuget包到 `Acme.MyProject.Web` 项目.
`Install-Package Volo.Docs.Web`
### 3- 添加模块依赖
##### 3.2.1- 添加模块依赖
一个ABP模块必须声明 `[DependsOn]` attribute 如果它依赖于另一个模块. 每个模块都必须在相关的项目的`[DependsOn]`Attribute 中添加.
@ -122,7 +126,6 @@ ABP框架的[文档](docs.abp.io)也是使用的此模块.
}
```
* 打开 `MyProjectApplicationModule.cs`并且添加 `typeof(DocsApplicationModule)` 如下所示;
```csharp
@ -165,6 +168,27 @@ ABP框架的[文档](docs.abp.io)也是使用的此模块.
}
```
##### 3.2.2- 添加NPM包
打开 `package.json` 添加 `@abp/docs` 如下所示:
```json
{
"version": "1.0.0",
"name": "my-app",
"private": true,
"dependencies": {
"@abp/aspnetcore.mvc.ui.theme.basic": "^2.9.0",
"@abp/docs": "^2.9.0"
}
}
```
然后在 `Acme.MyProject.Web` 项目目录打开命令行终端运行以下命令:
1. `yarn`
2. `gulp`
### 4- 数据库集成
#### 4.1- Entity Framework 集成

8
docs/zh-Hans/Modules/Virtual-File-Explorer.md

@ -8,19 +8,21 @@
### 安装
#### 1- 引用虚拟文件浏览器模块包
#### 1- 使用ABP CLI
建议使用ABP CLI安装模块,在解决方案文件 (`.sln`) 目录打开 `CMD` 窗口,运行以下命令:
`abp add-module Volo.VirtualFileExplorer`
#### 2- 手动安装
或者你也可以手动安装nuget包到 `Acme.MyProject.Web` 项目:
* 安装[Volo.Abp.VirtualFileExplorer.Web](https://www.nuget.org/packages/Volo.Abp.VirtualFileExplorer.Web/) nuget包到 `Acme.MyProject.Web` 项目.
`Install-Package Volo.Abp.VirtualFileExplorer.Web`
#### 2- 添加模块依赖
##### 2.1- 添加模块依赖
* 打开 `MyProjectWebModule.cs` 并且添加 `typeof(AbpVirtualFileExplorerWebModule)` 如下所示;
@ -40,7 +42,7 @@
}
```
#### 3- 添加NPM包
##### 2.2- 添加NPM包
* 打开 `package.json` 添加 `@abp/virtual-file-explorer": "^2.9.0` 如下所示:

Loading…
Cancel
Save