From df2985e7200d3fb4008bc5d395f641ed0893f42d Mon Sep 17 00:00:00 2001 From: R-unic Date: Mon, 20 Jan 2025 19:27:33 -0500 Subject: [PATCH] build: initialize docfx --- docfx.json | 46 ++++++++++++++++++++++++++++++++++++++++++++++ index.md | 6 ++++++ toc.yml | 2 ++ 3 files changed, 54 insertions(+) create mode 100644 docfx.json create mode 100644 index.md create mode 100644 toc.yml diff --git a/docfx.json b/docfx.json new file mode 100644 index 0000000..b4e9d08 --- /dev/null +++ b/docfx.json @@ -0,0 +1,46 @@ +{ + "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json", + "metadata": [ + { + "src": [ + { + "src": "../Heir", + "files": [ + "**/*.csproj" + ] + } + ], + "dest": "api" + } + ], + "build": { + "content": [ + { + "files": [ + "**/*.{md,yml}" + ], + "exclude": [ + "_site/**" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ] + } + ], + "output": "_site", + "template": [ + "default", + "modern" + ], + "globalMetadata": { + "_appName": "heir-docs", + "_appTitle": "heir-docs", + "_enableSearch": true, + "pdf": false + } + } +} \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 0000000..6e8f3f3 --- /dev/null +++ b/index.md @@ -0,0 +1,6 @@ +--- +_layout: landing +--- + +# Welcome to the Heir docs! +Here you will find all of the API reference for the Heir codebase. \ No newline at end of file diff --git a/toc.yml b/toc.yml new file mode 100644 index 0000000..ea85927 --- /dev/null +++ b/toc.yml @@ -0,0 +1,2 @@ +- name: API Reference + href: api/