mirror of
https://gitee.com/dotnetchina/Furion.git
synced 2025-12-06 07:49:05 +08:00
😊 添加 API 文档项目
This commit is contained in:
9
references/.gitignore
vendored
Normal file
9
references/.gitignore
vendored
Normal file
@@ -0,0 +1,9 @@
|
||||
###############
|
||||
# folder #
|
||||
###############
|
||||
/**/DROP/
|
||||
/**/TEMP/
|
||||
/**/packages/
|
||||
/**/bin/
|
||||
/**/obj/
|
||||
_site
|
||||
15
references/README.md
Normal file
15
references/README.md
Normal file
@@ -0,0 +1,15 @@
|
||||
文档基于 [https://dotnet.github.io/docfx/index.html](https://dotnet.github.io/docfx/index.html) 构建。
|
||||
|
||||
### 本地运行
|
||||
|
||||
```bash
|
||||
# 安装 docfx
|
||||
dotnet tool update -g docfx
|
||||
|
||||
# 本地浏览
|
||||
docfx docfx.json --serve
|
||||
```
|
||||
|
||||
### 发布部署
|
||||
|
||||
部署 `_site` 目录即可。
|
||||
5
references/api/.gitignore
vendored
Normal file
5
references/api/.gitignore
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
###############
|
||||
# temp file #
|
||||
###############
|
||||
*.yml
|
||||
.manifest
|
||||
5
references/api/index.md
Normal file
5
references/api/index.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Furion
|
||||
|
||||
```bash
|
||||
docfx docfx.json --serve
|
||||
```
|
||||
41
references/articles/intro.md
Normal file
41
references/articles/intro.md
Normal file
@@ -0,0 +1,41 @@
|
||||
**中** | [En](https://github.com/MonkSoul/Furion) | 允许商用,慷慨[赞助](http://furion.baiqian.ltd/docs/donate)
|
||||
|
||||
# 先知
|
||||
|
||||
一个应用程序框架,您可以将它集成到任何 .NET/C# 应用程序中。
|
||||
|
||||
## 安装
|
||||
|
||||
```powershell
|
||||
dotnet add package Furion
|
||||
```
|
||||
|
||||
## 例子
|
||||
|
||||
我们在 [主页](http://furion.baiqian.ltd) 上有不少例子,这是让您入门的第一个:
|
||||
|
||||
```cs
|
||||
Serve.Run();
|
||||
|
||||
[DynamicApiController]
|
||||
public class HelloService
|
||||
{
|
||||
public string Say() => "Hello, Furion";
|
||||
}
|
||||
```
|
||||
|
||||
打开浏览器访问 `http://localhost:5000`。
|
||||
|
||||
## 文档
|
||||
|
||||
您可以在 [主页](http://furion.baiqian.ltd) 找到 [Furion](https://gitee.com/dotnetchina/Furion) 文档。
|
||||
|
||||
## 贡献
|
||||
|
||||
该存储库的主要目的是继续发展 [Furion](https://gitee.com/dotnetchina/Furion) 核心,使其更快、更易于使用。 [Furion](https://gitee.com/dotnetchina/Furion) 的开发在 [Gitee](https://gitee.com/dotnetchina/Furion) 上公开进行,我们感谢社区贡献错误修复和改进。
|
||||
|
||||
阅读 [贡献指南](http://furion.baiqian.ltd/docs/contribute) 内容,了解如何参与改进 [Furion](https://gitee.com/dotnetchina/Furion)。
|
||||
|
||||
## 协议
|
||||
|
||||
[Furion](https://gitee.com/dotnetchina/Furion) 采用 [MIT](https://gitee.com/dotnetchina/Furion/blob/v4/LICENSE.zh) 开源协议。
|
||||
2
references/articles/toc.yml
Normal file
2
references/articles/toc.yml
Normal file
@@ -0,0 +1,2 @@
|
||||
- name: Furion
|
||||
href: intro.md
|
||||
42
references/docfx.json
Normal file
42
references/docfx.json
Normal file
@@ -0,0 +1,42 @@
|
||||
{
|
||||
"metadata": [
|
||||
{
|
||||
"src": [
|
||||
{
|
||||
"files": ["**/bin/Release/**.dll"],
|
||||
"src": "../framework"
|
||||
}
|
||||
],
|
||||
"dest": "api",
|
||||
"includePrivateMembers": false,
|
||||
"disableGitFeatures": false,
|
||||
"disableDefaultFilter": false,
|
||||
"noRestore": false,
|
||||
"namespaceLayout": "flattened",
|
||||
"memberLayout": "separatePages",
|
||||
"allowCompilationErrors": false
|
||||
}
|
||||
],
|
||||
"build": {
|
||||
"content": [
|
||||
{
|
||||
"files": ["api/**.yml", "api/index.md"]
|
||||
},
|
||||
{
|
||||
"files": ["articles/**.md", "articles/**/toc.yml", "toc.yml", "*.md"]
|
||||
}
|
||||
],
|
||||
"resource": [
|
||||
{
|
||||
"files": ["images/**"]
|
||||
}
|
||||
],
|
||||
"output": "_site",
|
||||
"globalMetadataFiles": [],
|
||||
"fileMetadataFiles": [],
|
||||
"template": ["default", "modern"],
|
||||
"postProcessors": [],
|
||||
"keepFileLink": true,
|
||||
"disableGitFeatures": false
|
||||
}
|
||||
}
|
||||
41
references/index.md
Normal file
41
references/index.md
Normal file
@@ -0,0 +1,41 @@
|
||||
**中** | [En](https://github.com/MonkSoul/Furion) | 允许商用,慷慨[赞助](http://furion.baiqian.ltd/docs/donate)
|
||||
|
||||
# 先知
|
||||
|
||||
一个应用程序框架,您可以将它集成到任何 .NET/C# 应用程序中。
|
||||
|
||||
## 安装
|
||||
|
||||
```powershell
|
||||
dotnet add package Furion
|
||||
```
|
||||
|
||||
## 例子
|
||||
|
||||
我们在 [主页](http://furion.baiqian.ltd) 上有不少例子,这是让您入门的第一个:
|
||||
|
||||
```cs
|
||||
Serve.Run();
|
||||
|
||||
[DynamicApiController]
|
||||
public class HelloService
|
||||
{
|
||||
public string Say() => "Hello, Furion";
|
||||
}
|
||||
```
|
||||
|
||||
打开浏览器访问 `http://localhost:5000`。
|
||||
|
||||
## 文档
|
||||
|
||||
您可以在 [主页](http://furion.baiqian.ltd) 找到 [Furion](https://gitee.com/dotnetchina/Furion) 文档。
|
||||
|
||||
## 贡献
|
||||
|
||||
该存储库的主要目的是继续发展 [Furion](https://gitee.com/dotnetchina/Furion) 核心,使其更快、更易于使用。 [Furion](https://gitee.com/dotnetchina/Furion) 的开发在 [Gitee](https://gitee.com/dotnetchina/Furion) 上公开进行,我们感谢社区贡献错误修复和改进。
|
||||
|
||||
阅读 [贡献指南](http://furion.baiqian.ltd/docs/contribute) 内容,了解如何参与改进 [Furion](https://gitee.com/dotnetchina/Furion)。
|
||||
|
||||
## 协议
|
||||
|
||||
[Furion](https://gitee.com/dotnetchina/Furion) 采用 [MIT](https://gitee.com/dotnetchina/Furion/blob/v4/LICENSE.zh) 开源协议。
|
||||
5
references/toc.yml
Normal file
5
references/toc.yml
Normal file
@@ -0,0 +1,5 @@
|
||||
- name: 使用指南
|
||||
href: articles/
|
||||
- name: API 文档
|
||||
href: api/
|
||||
homepage: api/index.md
|
||||
@@ -6,6 +6,7 @@
|
||||
`├──` **`docs`** — 针对 `Github` 平台的 `Furion` 文档发布后代码<br>
|
||||
`├──` **`framework`** — `Furion` 框架代码<br>
|
||||
`├──` **`handbook`** — `Furion` 文档源码,内部的 `build` 文件夹是 `Gitee` 平台文档发布后代码<br>
|
||||
`├──` **`references`** — `Furion` API 文档源码<br>
|
||||
`├──` **`samples`** — `Furion` 框架演示例子<br>
|
||||
`├──` **`schema`** — `Furion` 配置文件 `JSON Schema`<br>
|
||||
`├──` **`snks`** — `Furion` 强签名密钥目录<br>
|
||||
|
||||
Reference in New Issue
Block a user