diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..1304fc2 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "Docs/templates/DiscordFX"] + path = Docs/templates/DiscordFX + url = https://github.com/jbltx/DiscordFX diff --git a/Docs/.gitignore b/Docs/.gitignore new file mode 100644 index 0000000..4378419 --- /dev/null +++ b/Docs/.gitignore @@ -0,0 +1,9 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_site diff --git a/Docs/api/.gitignore b/Docs/api/.gitignore new file mode 100644 index 0000000..e8079a3 --- /dev/null +++ b/Docs/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/Docs/api/index.md b/Docs/api/index.md new file mode 100644 index 0000000..78dc9c0 --- /dev/null +++ b/Docs/api/index.md @@ -0,0 +1,2 @@ +# PLACEHOLDER +TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! diff --git a/Docs/articles/intro.md b/Docs/articles/intro.md new file mode 100644 index 0000000..c0478ce --- /dev/null +++ b/Docs/articles/intro.md @@ -0,0 +1 @@ +# Add your introductions here! diff --git a/Docs/articles/toc.yml b/Docs/articles/toc.yml new file mode 100644 index 0000000..ff89ef1 --- /dev/null +++ b/Docs/articles/toc.yml @@ -0,0 +1,2 @@ +- name: Introduction + href: intro.md diff --git a/Docs/docfx.json b/Docs/docfx.json new file mode 100644 index 0000000..c241537 --- /dev/null +++ b/Docs/docfx.json @@ -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 + } +} \ No newline at end of file diff --git a/Docs/index.md b/Docs/index.md new file mode 100644 index 0000000..3ae2506 --- /dev/null +++ b/Docs/index.md @@ -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. diff --git a/Docs/templates/DiscordFX b/Docs/templates/DiscordFX new file mode 160000 index 0000000..f209cd7 --- /dev/null +++ b/Docs/templates/DiscordFX @@ -0,0 +1 @@ +Subproject commit f209cd757dd8e553bd18d571357cc5d17f6197f0 diff --git a/Docs/toc.yml b/Docs/toc.yml new file mode 100644 index 0000000..b51ebfe --- /dev/null +++ b/Docs/toc.yml @@ -0,0 +1,5 @@ +- name: Articles + href: articles/ +- name: API Documentation + href: api/ + homepage: api/index.md