From 5da42d608a5ed9600d2cc9e0ae68d99455eb1b38 Mon Sep 17 00:00:00 2001 From: Anairkoen Schno Date: Tue, 11 Jun 2019 16:44:09 -0500 Subject: [PATCH] Finalized DocFX theme Moved some articles and the like around --- docs/.vscode/tasks.json | 3 ++- docs/api/index.md | 6 ++++-- docs/articles/index.md | 5 +++++ docs/articles/intro.md | 1 - docs/articles/toc.yml | 4 +++- docs/docfx.json | 4 ++++ docs/index.md | 2 +- docs/templates/darkfx | 1 - docs/toc.yml | 1 + 9 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 docs/articles/index.md delete mode 100644 docs/articles/intro.md delete mode 160000 docs/templates/darkfx diff --git a/docs/.vscode/tasks.json b/docs/.vscode/tasks.json index fb3d737d..47e5debd 100644 --- a/docs/.vscode/tasks.json +++ b/docs/.vscode/tasks.json @@ -6,7 +6,8 @@ { "label": "build", "type": "shell", - "command": "docfx metadata; docfx build" + "command": "docfx metadata; docfx build", + "problemMatcher": [] } ] } \ No newline at end of file diff --git a/docs/api/index.md b/docs/api/index.md index 78dc9c00..03c4962f 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,2 +1,4 @@ -# PLACEHOLDER -TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*! +# BSIPA API Documentation + +Welcome to the full class documentation! To see guides, head over to the [Articles tab](xref:getting_started). +Select a namespace and a class on the left to get started. diff --git a/docs/articles/index.md b/docs/articles/index.md new file mode 100644 index 00000000..b87f00f8 --- /dev/null +++ b/docs/articles/index.md @@ -0,0 +1,5 @@ +--- +uid: getting_started +--- + +# Getting Started diff --git a/docs/articles/intro.md b/docs/articles/intro.md deleted file mode 100644 index 1333ed77..00000000 --- a/docs/articles/intro.md +++ /dev/null @@ -1 +0,0 @@ -TODO diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml index 4b5c4398..2b7147a7 100644 --- a/docs/articles/toc.yml +++ b/docs/articles/toc.yml @@ -1,2 +1,4 @@ +- name: Home + href: ../index.md - name: Getting Started - href: intro.md + href: index.md diff --git a/docs/docfx.json b/docs/docfx.json index 6cccdcfb..cbfa415f 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -53,6 +53,10 @@ "template": [ "default", "templates/material/material" ], + "globalMetadata": { + "_enableSearch": true, + "_enableNewTab": true + }, "postProcessors": [], "markdownEngineName": "dfm", "noLangKeyword": false, diff --git a/docs/index.md b/docs/index.md index b2c776f5..37dfa8f3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,6 +2,6 @@ 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. +Take a look at to see how to get going. TODO: finish diff --git a/docs/templates/darkfx b/docs/templates/darkfx deleted file mode 160000 index 7fa38147..00000000 --- a/docs/templates/darkfx +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 7fa3814713e17efc64e79ab9eab64e3dd5afc0c8 diff --git a/docs/toc.yml b/docs/toc.yml index 59f80104..30e21122 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -1,5 +1,6 @@ - name: Articles href: articles/ + homepage: articles/index.md - name: Api Documentation href: api/ homepage: api/index.md