diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 0000000..93451d8 --- /dev/null +++ b/docs/docfx.json @@ -0,0 +1,42 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ "src/Atrea.PolicyEngine/Atrea.PolicyEngine.csproj" ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "../src" + } + ], + "dest": "../site/yml/api", + "properties": { + "TargetFramework": "netstandard2.1" + } + } + ], + "build": { + "content": [ + { + "files": [ "**/*.yml" ], + "src": "../site/yml/api", + "dest": "api" + }, + { + "files": [ + "*.md", + "toc.yml" + ] + } + ], + "template": [ + "default" + ], + "globalMetadata": { + "_appTitle": "Atrea.PolicyEngine", + "_enableSearch": true + }, + "markdownEngineName": "markdig", + "dest": "../site/html", + "xrefService": [ "https://xref.docs.microsoft.com/query?uid={uid}" ] + } +} diff --git a/docs/index.md b/docs/index.md index 8545aaf..4a081fc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ -# Docs +# Atrea.PolicyEngine Documentation -A spring-board index file for starting work on documentation via DocFx. +Interactive documentation for the Atrea.PolicyEngine library. + +Check out the API Documentation tab for detailed technical documentation with source code links! diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..97a29da --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,4 @@ +- name: Home + href: index.md +- name: API Documentation + href: ../site/yml/api/