From 004f91bc014381ed6101798ea3414df1230c9488 Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Tue, 8 Apr 2025 18:53:34 -0400 Subject: [PATCH] Add shell of docfx files --- .gitignore | 4 ++++ docfx.json | 48 +++++++++++++++++++++++++++++++++++++++++ docs/getting-started.md | 1 + docs/introduction.md | 1 + docs/toc.yml | 4 ++++ index.md | 11 ++++++++++ toc.yml | 4 ++++ 7 files changed, 73 insertions(+) create mode 100644 docfx.json create mode 100644 docs/getting-started.md create mode 100644 docs/introduction.md create mode 100644 docs/toc.yml create mode 100644 index.md create mode 100644 toc.yml diff --git a/.gitignore b/.gitignore index 06998cb..47c72c2 100644 --- a/.gitignore +++ b/.gitignore @@ -400,3 +400,7 @@ FodyWeavers.xsd # Test run files src/*-tests.txt + +# Documentation builds and intermediate files +_site/ +api/ diff --git a/docfx.json b/docfx.json new file mode 100644 index 0000000..a99a721 --- /dev/null +++ b/docfx.json @@ -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 + } + } +} \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started.md new file mode 100644 index 0000000..8b3a794 --- /dev/null +++ b/docs/getting-started.md @@ -0,0 +1 @@ +# Getting Started \ No newline at end of file diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 0000000..f6ecaa6 --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1 @@ +# Introduction \ No newline at end of file diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..d7e9ea8 --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,4 @@ +- name: Introduction + href: introduction.md +- name: Getting Started + href: getting-started.md \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 0000000..f9859f8 --- /dev/null +++ b/index.md @@ -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. \ 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