Add shell of docfx files

This commit is contained in:
Daniel J. Summers 2025-04-08 18:53:34 -04:00
parent 98f216d6db
commit 004f91bc01
7 changed files with 73 additions and 0 deletions

4
.gitignore vendored
View File

@ -400,3 +400,7 @@ FodyWeavers.xsd
# Test run files
src/*-tests.txt
# Documentation builds and intermediate files
_site/
api/

48
docfx.json Normal file
View File

@ -0,0 +1,48 @@
{
"$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
"metadata": [
{
"src": [
{
"src": "./src",
"files": [
"Common/bin/Release/net9.0/*.dll",
"Postgres/bin/Release/net9.0/*.dll",
"Sqlite/bin/Release/net9.0/*.dll"
]
}
],
"dest": "api"
}
],
"build": {
"content": [
{
"files": [
"api/*.{md,yml}"
],
"exclude": [
"_site/**"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"output": "_site",
"template": [
"default",
"modern"
],
"globalMetadata": {
"_appName": "BitBadger.Documents",
"_appTitle": "BitBadger.Documents",
"_enableSearch": true,
"pdf": false
}
}
}

1
docs/getting-started.md Normal file
View File

@ -0,0 +1 @@
# Getting Started

1
docs/introduction.md Normal file
View File

@ -0,0 +1 @@
# Introduction

4
docs/toc.yml Normal file
View File

@ -0,0 +1,4 @@
- name: Introduction
href: introduction.md
- name: Getting Started
href: getting-started.md

11
index.md Normal file
View File

@ -0,0 +1,11 @@
---
_layout: landing
---
# This is the **HOMEPAGE**.
Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
## Quick Start Notes:
1. Add images to the *images* folder if the file is referencing an image.

4
toc.yml Normal file
View File

@ -0,0 +1,4 @@
- name: Docs
href: docs/
- name: API
href: api/