Skip to content

Commit 59fb345

Browse files
authored
docs: Add DocFX project to generate the API documentation (#4)
1 parent a892991 commit 59fb345

5 files changed

Lines changed: 110 additions & 0 deletions

File tree

docs/.gitignore

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
###############
2+
# folder #
3+
###############
4+
/**/DROP/
5+
/**/TEMP/
6+
/**/packages/
7+
/**/bin/
8+
/**/obj/
9+
/**/plugins
10+
_site

docs/api/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
###############
2+
# temp file #
3+
###############
4+
*.yml
5+
.manifest

docs/docfx.json

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
{
2+
"metadata": [
3+
{
4+
"src": [
5+
{
6+
"src": "..",
7+
"files": [
8+
"src/Core/**.csproj"
9+
]
10+
},
11+
{
12+
"src": "..",
13+
"files": [
14+
"src/Attributes/**.csproj"
15+
]
16+
}
17+
],
18+
"dest": "api",
19+
"disableGitFeatures": false,
20+
"disableDefaultFilter": false
21+
}
22+
],
23+
"build": {
24+
"content": [
25+
{
26+
"files": [
27+
"api/**.yml"
28+
]
29+
},
30+
{
31+
"files": [
32+
"toc.yml",
33+
"index.md"
34+
]
35+
}
36+
],
37+
"resource": [
38+
{
39+
"files": [
40+
"images/**"
41+
]
42+
}
43+
],
44+
"overwrite": [
45+
{
46+
"files": [
47+
"apidoc/**.md"
48+
],
49+
"exclude": [
50+
"obj/**",
51+
"_site/**"
52+
]
53+
}
54+
],
55+
"globalMetadata": {
56+
"_appTitle": "CPlugin.Net",
57+
"_enableNewTab": true,
58+
"_appFooter": "Copyright ©2023 <b>CPlugin.Net</b>",
59+
"_enableSearch": true,
60+
"_gitContribute": {
61+
"repo": "https://github.com/MrDave1999/CPlugin.Net",
62+
"branch": "master"
63+
}
64+
},
65+
"dest": "_site",
66+
"globalMetadataFiles": [],
67+
"fileMetadataFiles": [],
68+
"template": [
69+
"default",
70+
"plugins/memberpage/content"
71+
],
72+
"postProcessors": ["ExtractSearchIndex"],
73+
"markdownEngineName": "markdig",
74+
"noLangKeyword": false,
75+
"keepFileLink": false,
76+
"cleanupCacheHistory": false,
77+
"disableGitFeatures": false,
78+
"xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ]
79+
}
80+
}

docs/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CPlugin.Net
2+
3+
[![CPlugin.Net](https://img.shields.io/nuget/vpre/CPlugin.Net?label=CPlugin.Net%20-%20nuget&color=red)](https://www.nuget.org/packages/CPlugin.Net)
4+
[![downloads](https://img.shields.io/nuget/dt/CPlugin.Net?color=yellow)](https://www.nuget.org/packages/CPlugin.Net)
5+
6+
[![CPlugin.Net.Attributes](https://img.shields.io/nuget/vpre/CPlugin.Net.Attributes?label=CPlugin.Net.Attributes%20-%20nuget&color=red)](https://www.nuget.org/packages/CPlugin.Net.Attributes)
7+
[![downloads](https://img.shields.io/nuget/dt/CPlugin.Net.Attributes?color=yellow)](https://www.nuget.org/packages/CPlugin.Net.Attributes)
8+
9+
[![CPlugin.Net-logo](https://raw.githubusercontent.com/MrDave1999/CPlugin.Net/bd7e7c8787e5a1b4987cd5a506e680261dce19b0/plugin-logo.png)](https://github.com/MrDave1999/CPlugin.Net)
10+
11+
A simple library that implements a plugin loader for .NET. It also includes a `PluginAttribute` type to be used by plugins.

docs/toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- name: API Documentation
2+
href: api/
3+
- name: GitHub
4+
href: https://github.com/MrDave1999/CPlugin.Net

0 commit comments

Comments
 (0)