Fix some bugs with the documentation site.

MrKWatkins · May 11, 2023 · 3022e83 · 3022e83
1 parent 1c17c82
commit 3022e83
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 11 deletions.
diff --git a/.github/actions/documentation/action.yml b/.github/actions/documentation/action.yml
@@ -9,13 +9,10 @@ runs:
  using: composite
 
  steps:
- - name: Install DocFX
- shell: bash
- run: dotnet tool update -g docfx 
-
  - name: Build Documentation
  shell: bash
- run: docfx doc/docfx.json
+ working-directory: ./doc
+ run: ./build.sh
 
  - name: Setup Pages
  if: ${{ inputs.deploy == 'true' }}

diff --git a/doc/build.sh b/doc/build.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+echo "Installing DocFX..."
+dotnet tool update -g docfx
+
+echo "Building documentation..."
+docfx
+
+echo "Post-processing documentation..."
+rm _site/logo.svg
+sed _site/api/*.html -i -e 's|<a class="xref" href="MrKWatkins.html">MrKWatkins</a>.<a class="xref" href="MrKWatkins.Ast.html">Ast</a>|<a class="xref" href="MrKWatkins.Ast.html">MrKWatkins.Ast</a>|g' 
diff --git a/doc/docfx.json b/doc/docfx.json
@@ -23,8 +23,6 @@
  },
  {
  "files": [
- "articles/**.md",
- "articles/**/toc.yml",
  "toc.yml",
  "*.md"
  ]
@@ -33,7 +31,9 @@
  "resource": [
  {
  "files": [
- "images/**"
+ "images/**",
+ "index.html",
+ "favicon.ico"
  ]
  }
  ],
@@ -50,7 +50,7 @@
  "globalMetadata": {
  "_appTitle": "MrKWatkins.Ast",
  "_appName": "MrKWatkins.Ast",
- "_appFaviconPath": "images/favicon.ico",
+ "_appFaviconPath": "favicon.ico",
  "_appLogoPath": "images/logo.png",
  "_appFooter": "Created with <a href=\"https://dotnet.github.io/docfx\" target=\"_blank\">DocFX</a> and <a href=\"https://github.com/Singulink/SingulinkFX\" target=\"_blank\">SingulinkFX</a>",
  "_disableContribution": true

diff --git a/doc/images/favicon.ico → doc/favicon.ico b/doc/images/favicon.ico → doc/favicon.ico
diff --git a/doc/index.md → doc/home.md b/doc/index.md → doc/home.md
diff --git a/doc/index.html b/doc/index.html
@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta http-equiv="refresh" content="0; url=home.html" />
+</head>
+<body>
+</body>
+</html>
diff --git a/doc/toc.yml b/doc/toc.yml
@@ -1,5 +1,5 @@
-- name: Documentation
- href: index.md
+- name: Home
+ href: home.md
 
 - name: API
  href: api/