Skip to content
This repository has been archived by the owner on Sep 20, 2022. It is now read-only.

Better docs #3

Merged
merged 1 commit into from
Nov 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site
5 changes: 5 additions & 0 deletions docs/api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
###############
# temp file #
###############
*.yml
.manifest
2 changes: 2 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# PLACEHOLDER
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
1 change: 1 addition & 0 deletions docs/articles/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Add your introductions here!
2 changes: 2 additions & 0 deletions docs/articles/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: Introduction
href: intro.md
104 changes: 62 additions & 42 deletions docs/docfx.json
Original file line number Diff line number Diff line change
@@ -1,46 +1,66 @@
{
"metadata": [{
"src": [{
"files": [
"**.csproj"
]
}],
"dest": "api",
"filter": "filter.yml"
}],
"build": {
"content": [{
"files": ["api/**.yml", "api/index.md"]
},
{
"files": ["toc.yml", "index.md"]
},
{
"files": ["faq/**.md", "faq/**/toc.yml"]
},
{
"files": ["guides/**.md", "guides/**/toc.yml"]
}
],
"resource": [],
"dest": "_site",
"template": [
"default",
"_template/light-dark-theme",
"_template/last-modified",
"_template/description-generator"
"metadata": [
{
"src": [
{
"files": [
"**.csproj"
],
"src": ".."
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false,
"filter": "filter.yml"
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"postProcessors": ["ExtractSearchIndex", "LastModifiedPostProcessor", "DescriptionPostProcessor"],
"overwrite": "_overwrites/**/**.md",
"globalMetadata": {
"_appTitle": "Doshboard Documentation",
"_appFooter": "Melefo Halfa (c) 2021-2021 1.0.0",
"_enableSearch": true,
"_appLogoPath": "doshboard.svg",
"_appFaviconPath": "favicon.ico"
},
"xrefService": [
"https://xref.docs.microsoft.com/query?uid={uid}"
"exclude": [
"obj/**",
"_site/**"
]
}
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
3 changes: 2 additions & 1 deletion docs/filter.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@

apiRules:
- exclude:
- exclude:
uidRegex: ^Doshboard\.Test$
type: Namespace
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# 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.
5 changes: 5 additions & 0 deletions docs/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- name: Articles
href: articles/
- name: Api Documentation
href: api/
homepage: api/index.md