😊 添加 API 文档项目

This commit is contained in:
百小僧
2023-07-01 17:55:02 +08:00
parent 6cffcbe333
commit 0f80b32904
10 changed files with 166 additions and 0 deletions

9
references/.gitignore vendored Normal file
View File

@@ -0,0 +1,9 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site

15
references/README.md Normal file
View 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
View File

@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest

5
references/api/index.md Normal file
View File

@@ -0,0 +1,5 @@
# Furion
```bash
docfx docfx.json --serve
```

View 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) 开源协议。

View File

@@ -0,0 +1,2 @@
- name: Furion
href: intro.md

42
references/docfx.json Normal file
View 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
View 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
View File

@@ -0,0 +1,5 @@
- name: 使
href: articles/
- name: API
href: api/
homepage: api/index.md

View File

@@ -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>