Skip to content

Commit

Permalink
build: initialize docfx
Browse files Browse the repository at this point in the history
  • Loading branch information
R-unic committed Jan 21, 2025
1 parent beb6c0b commit df2985e
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docfx.json
Original file line number Diff line number Diff line change
@@ -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
}
}
}
6 changes: 6 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
_layout: landing
---

# Welcome to the Heir docs!
Here you will find all of the API reference for the Heir codebase.
2 changes: 2 additions & 0 deletions toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: API Reference
href: api/

0 comments on commit df2985e

Please sign in to comment.