mirror of
https://gitlab.acidiclight.dev/sociallydistant/sociallydistant.git
synced 2025-01-22 09:31:47 -05:00
Add docfx for documentation generation
This commit is contained in:
parent
e5ac222268
commit
2706a00dcc
7 changed files with 69 additions and 0 deletions
4
.gitignore
vendored
4
.gitignore
vendored
|
@ -1,3 +1,7 @@
|
|||
# docfx
|
||||
api/
|
||||
public/
|
||||
|
||||
## Ignore Visual Studio temporary files, build results, and
|
||||
## files generated by popular Visual Studio add-ons.
|
||||
##
|
||||
|
|
44
docfx.json
Normal file
44
docfx.json
Normal file
|
@ -0,0 +1,44 @@
|
|||
{
|
||||
"metadata": [
|
||||
{
|
||||
"src": [
|
||||
{
|
||||
"src": "src",
|
||||
"files": [
|
||||
"**/*.csproj"
|
||||
]
|
||||
}
|
||||
],
|
||||
"dest": "api"
|
||||
}
|
||||
],
|
||||
"build": {
|
||||
"content": [
|
||||
{
|
||||
"files": [
|
||||
"**/*.{md,yml}"
|
||||
],
|
||||
"exclude": [
|
||||
"public/**"
|
||||
]
|
||||
}
|
||||
],
|
||||
"resource": [
|
||||
{
|
||||
"files": [
|
||||
"images/**"
|
||||
]
|
||||
}
|
||||
],
|
||||
"output": "public",
|
||||
"template": [
|
||||
"default",
|
||||
"modern"
|
||||
],
|
||||
"globalMetadata": {
|
||||
"_appName": "Socially Distant OS",
|
||||
"_appTitle": "Socially Distant OS",
|
||||
"_enableSearch": true,
|
||||
}
|
||||
}
|
||||
}
|
1
docs/getting-started.md
Normal file
1
docs/getting-started.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Getting Started
|
1
docs/introduction.md
Normal file
1
docs/introduction.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Introduction
|
4
docs/toc.yml
Normal file
4
docs/toc.yml
Normal file
|
@ -0,0 +1,4 @@
|
|||
- name: Introduction
|
||||
href: introduction.md
|
||||
- name: Getting Started
|
||||
href: getting-started.md
|
11
index.md
Normal file
11
index.md
Normal 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
4
toc.yml
Normal file
|
@ -0,0 +1,4 @@
|
|||
- name: Docs
|
||||
href: docs/
|
||||
- name: API
|
||||
href: api/
|
Loading…
Reference in a new issue