diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b1a571e..365bfe5 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,9 @@ jobs: run: dotnet tool install -g docfx - name: Generate Documentation - run: docfx build + run: | + docfx metadata + docfx build - name: Clean up _site folder run: | @@ -45,7 +47,7 @@ jobs: git config --global user.email "github-actions[bot]@users.noreply.github.com" git checkout --orphan docs git --work-tree _site add --all - git --work-tree _site commit -m "Update documentation" + git --work-tree _site commit -m "docs: automatic update" git push https://github-actions:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }} HEAD:docs --force - name: Upload artifact 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/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 0000000..8f99b43 --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1,3 @@ +# Getting started + +TODO \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..c02ca04 --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,2 @@ +- name: Getting Started + href: getting-started/ diff --git a/index.md b/index.md new file mode 100644 index 0000000..cd295bb --- /dev/null +++ b/index.md @@ -0,0 +1,6 @@ +--- +_layout: landing +--- + +# Heir Docs +Welcome to the Heir docs! \ No newline at end of file diff --git a/toc.yml b/toc.yml new file mode 100644 index 0000000..061acc6 --- /dev/null +++ b/toc.yml @@ -0,0 +1,4 @@ +- name: Docs + href: docs/ +- name: API + href: api/ \ No newline at end of file