Skip to content

Commit

Permalink
Add Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BigBang1112 committed Jan 1, 2024
1 parent d75d039 commit 4cd28d7
Show file tree
Hide file tree
Showing 10 changed files with 109 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "Docs/templates/DiscordFX"]
path = Docs/templates/DiscordFX
url = https://github.com/jbltx/DiscordFX
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
77 changes: 77 additions & 0 deletions Docs/docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
{
"metadata": [
{
"src": [
{
"src": "../Src",
"files": [
"**ManiaAPI.ManiaPlanetAPI.dll",
"**ManiaAPI.ManiaPlanetAPI.Extensions.Hosting.dll",
"**ManiaAPI.NadeoAPI.dll",
"**ManiaAPI.NadeoAPI.Extensions.Gbx.dll",
"**ManiaAPI.TMX.dll",
"**ManiaAPI.TrackmaniaAPI.dll",
"**ManiaAPI.TrackmaniaIO.dll",
"**ManiaAPI.XmlRpc.dll"
]
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"overwrite": [
{
"files": [
"apidoc/**.md"
],
"exclude": [
"obj/**",
"_site/**"
]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"globalMetadata": {
"_appName": "ManiaAPI.NET",
"_appTitle": "ManiaAPI.NET Documentation",
"_appFooter": "© 2024 BigBang1112"
},
"fileMetadataFiles": [],
"template": [
"default", "templates/DiscordFX/discordfx"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
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.
1 change: 1 addition & 0 deletions Docs/templates/DiscordFX
Submodule DiscordFX added at f209cd
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

0 comments on commit 4cd28d7

Please sign in to comment.