From 742392025e1416297a99f5be297f3bb25b0c7bee Mon Sep 17 00:00:00 2001 From: MrDave1999 Date: Mon, 13 Nov 2023 10:19:00 -0500 Subject: [PATCH] docs: Add DocFX project to generate the API documentation --- docs/.gitignore | 10 ++++++ docs/api/.gitignore | 5 +++ docs/docfx.json | 80 +++++++++++++++++++++++++++++++++++++++++++++ docs/index.md | 11 +++++++ docs/toc.yml | 4 +++ 5 files changed, 110 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/api/.gitignore create mode 100644 docs/docfx.json create mode 100644 docs/index.md create mode 100644 docs/toc.yml diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..1bbee07 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,10 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +/**/plugins +_site diff --git a/docs/api/.gitignore b/docs/api/.gitignore new file mode 100644 index 0000000..e8079a3 --- /dev/null +++ b/docs/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 0000000..1ad0952 --- /dev/null +++ b/docs/docfx.json @@ -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 CPlugin.Net", + "_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}" ] + } +} \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..2f4961d --- /dev/null +++ b/docs/index.md @@ -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. diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..f85de8a --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,4 @@ +- name: API Documentation + href: api/ +- name: GitHub + href: https://github.com/MrDave1999/CPlugin.Net