Browse Source

Finalized DocFX theme

Moved some articles and the like around
pull/13/head
Anairkoen Schno 5 years ago
parent
commit
5da42d608a
9 changed files with 20 additions and 7 deletions
  1. +2
    -1
      docs/.vscode/tasks.json
  2. +4
    -2
      docs/api/index.md
  3. +5
    -0
      docs/articles/index.md
  4. +0
    -1
      docs/articles/intro.md
  5. +3
    -1
      docs/articles/toc.yml
  6. +4
    -0
      docs/docfx.json
  7. +1
    -1
      docs/index.md
  8. +0
    -1
      docs/templates/darkfx
  9. +1
    -0
      docs/toc.yml

+ 2
- 1
docs/.vscode/tasks.json View File

@ -6,7 +6,8 @@
{
"label": "build",
"type": "shell",
"command": "docfx metadata; docfx build"
"command": "docfx metadata; docfx build",
"problemMatcher": []
}
]
}

+ 4
- 2
docs/api/index.md View File

@ -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.

+ 5
- 0
docs/articles/index.md View File

@ -0,0 +1,5 @@
---
uid: getting_started
---
# Getting Started

+ 0
- 1
docs/articles/intro.md View File

@ -1 +0,0 @@
TODO

+ 3
- 1
docs/articles/toc.yml View File

@ -1,2 +1,4 @@
- name: Home
href: ../index.md
- name: Getting Started
href: intro.md
href: index.md

+ 4
- 0
docs/docfx.json View File

@ -53,6 +53,10 @@
"template": [
"default", "templates/material/material"
],
"globalMetadata": {
"_enableSearch": true,
"_enableNewTab": true
},
"postProcessors": [],
"markdownEngineName": "dfm",
"noLangKeyword": false,


+ 1
- 1
docs/index.md View File

@ -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 <xref:getting_started> to see how to get going.
TODO: finish

+ 0
- 1
docs/templates/darkfx

@ -1 +0,0 @@
Subproject commit 7fa3814713e17efc64e79ab9eab64e3dd5afc0c8

+ 1
- 0
docs/toc.yml View File

@ -1,5 +1,6 @@
- name: Articles
href: articles/
homepage: articles/index.md
- name: Api Documentation
href: api/
homepage: api/index.md

Loading…
Cancel
Save