From 6e333186bbf535bbbff99c160bc7a524706bb6b6 Mon Sep 17 00:00:00 2001 From: Anairkoen Schno Date: Tue, 11 Jun 2019 15:21:22 -0500 Subject: [PATCH] Removed material DocFX template in favor of DarkFX --- .gitmodules | 5 +-- docs/docfx.json | 73 ++++++++++++++++++----------------------- docs/index.md | 11 ++++--- docs/templates/material | 1 - 4 files changed, 40 insertions(+), 50 deletions(-) delete mode 160000 docs/templates/material diff --git a/.gitmodules b/.gitmodules index dc10da9e..79edf281 100644 --- a/.gitmodules +++ b/.gitmodules @@ -3,10 +3,7 @@ url = https://github.com/nike4613/UnityDoorstop-BSIPA [submodule "BuildTools"] path = BuildTools - url = https://github.com/beat-saber-modding-group/BS-Plugin-BuildTools.git -[submodule "docs/templates/material"] - path = docs/templates/material - url = https://github.com/ovasquez/docfx-material.git + url = https://github.com/beat-saber-modding-group/BS-Plugin-BuildTools.git [submodule "docs/templates/darkfx"] path = docs/templates/darkfx url = https://github.com/steffen-wilke/darkfx.git diff --git a/docs/docfx.json b/docs/docfx.json index 472c600d..2bae1f62 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -1,28 +1,23 @@ { - "metadata": [ - { - "src": [ - { - "src": "..", - "files": [ - "**.csproj" - ], - "exclude": [ - "**/IPA.csproj", - "**/IPA.Tests.csproj", - "BuildTools/**.csproj", - "Doorstop/**.csproj" - ] - } + "metadata": [{ + "src": [{ + "src": "..", + "files": [ + "**.csproj" ], - "dest": "api", - "disableGitFeatures": false, - "disableDefaultFilter": false - } - ], + "exclude": [ + "**/IPA.csproj", + "**/IPA.Tests.csproj", + "BuildTools/**.csproj", + "Doorstop/**.csproj" + ] + }], + "dest": "api", + "disableGitFeatures": false, + "disableDefaultFilter": false + }], "build": { - "content": [ - { + "content": [{ "files": [ "api/**.yml", "api/index.md" @@ -37,29 +32,25 @@ ] } ], - "resource": [ - { - "files": [ - "images/**" - ] - } - ], - "overwrite": [ - { - "files": [ - "override/**.md" - ], - "exclude": [ - "obj/**", - "_site/**" - ] - } - ], + "resource": [{ + "files": [ + "images/**" + ] + }], + "overwrite": [{ + "files": [ + "override/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + }], "dest": "_site", "globalMetadataFiles": [], "fileMetadataFiles": [], "template": [ - "default" + "default", "templates/darkfx/darkfx" ], "postProcessors": [], "markdownEngineName": "markdig", diff --git a/docs/index.md b/docs/index.md index 3ae25063..b2c776f5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,7 @@ -# 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. +# Beat Saber IPA Reloaded + +The game-agnostic mod injector for Unity, that happens to have been written for Beat Saber! + +Take a look at the [getting started guide](articles/intro.md) to see how to get going. + +TODO: finish diff --git a/docs/templates/material b/docs/templates/material deleted file mode 160000 index 7cb98dbd..00000000 --- a/docs/templates/material +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 7cb98dbd78928915ec86069297ed2c358f55079c