Skip to content

Commit

Permalink
docs: Add DocFX project to generate the API documentation (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
MrDave1999 authored Nov 13, 2023
1 parent a892991 commit 59fb345
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
/**/plugins
_site
5 changes: 5 additions & 0 deletions docs/api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest
80 changes: 80 additions & 0 deletions docs/docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
{
"metadata": [
{
"src": [
{
"src": "..",
"files": [
"src/Core/**.csproj"
]
},
{
"src": "..",
"files": [
"src/Attributes/**.csproj"
]
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml"
]
},
{
"files": [
"toc.yml",
"index.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"globalMetadata": {
"_appTitle": "CPlugin.Net",
"_enableNewTab": true,
"_appFooter": "Copyright ©2023 <b>CPlugin.Net</b>",
"_enableSearch": true,
"_gitContribute": {
"repo": "https://github.com/MrDave1999/CPlugin.Net",
"branch": "master"
}
},
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default",
"plugins/memberpage/content"
],
"postProcessors": ["ExtractSearchIndex"],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false,
"xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ]
}
}
11 changes: 11 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CPlugin.Net

[![CPlugin.Net](https://img.shields.io/nuget/vpre/CPlugin.Net?label=CPlugin.Net%20-%20nuget&color=red)](https://www.nuget.org/packages/CPlugin.Net)
[![downloads](https://img.shields.io/nuget/dt/CPlugin.Net?color=yellow)](https://www.nuget.org/packages/CPlugin.Net)

[![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)
[![downloads](https://img.shields.io/nuget/dt/CPlugin.Net.Attributes?color=yellow)](https://www.nuget.org/packages/CPlugin.Net.Attributes)

[![CPlugin.Net-logo](https://raw.githubusercontent.com/MrDave1999/CPlugin.Net/bd7e7c8787e5a1b4987cd5a506e680261dce19b0/plugin-logo.png)](https://github.com/MrDave1999/CPlugin.Net)

A simple library that implements a plugin loader for .NET. It also includes a `PluginAttribute` type to be used by plugins.
4 changes: 4 additions & 0 deletions docs/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- name: API Documentation
href: api/
- name: GitHub
href: https://github.com/MrDave1999/CPlugin.Net

0 comments on commit 59fb345

Please sign in to comment.