Updated docs & pages

KaruroChori · Dec 23, 2024 · 00759a5 · 00759a5
1 parent 2089d98
commit 00759a5
Show file tree

Hide file tree

Showing 7 changed files with 108 additions and 4 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/deploy-docs.yaml → .github/workflows/docs.yml b/.github/workflows/deploy-docs.yaml → .github/workflows/docs.yml
@@ -20,11 +20,19 @@ jobs:
           bun-version: latest
       - name: Build
         run: |
+          sudo apt install -y \
+            doxygen \
+            graphviz \
+            python3-pip \
+            python3-setuptools
+          python3 -m pip install mkdocs mkdocs-github-admonitions-plugin mkdocs-get-deps pymdown-extensions mdx_truly_sane_lists
+          bun install -g gh-pages
           bun install
           bun run api-docs
+          mkdocs build
       - name: Deploy
         run: |
           git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
-          bun run deploy-api-docs
+          gh-pages -d dist/website -e . -u "github-actions-bot <[email protected]>"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -118,7 +118,6 @@ out
 # Nuxt.js build / generate output
 
 .nuxt
-dist
 
 # Gatsby files
 
@@ -178,4 +177,7 @@ dist
 /examples/tmp
 
 # Documentation
-/docs/api
+/dist/*
+!/dist/website/
+/dist/website/api/*
+/dist/website/docs/*
diff --git a/dist/website/index.html b/dist/website/index.html
@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="color-scheme" content="light dark">
+    <meta name="description" content="Documentation for vs.fltk, the lightweight UI builder and runtime based on fltk">
+    <meta name="keywords" content="fltk, UI, builder, xml, SFC">
+    <meta name="author" content="karurochari">
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@picocss/pico@2/css/pico.min.css">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.7.2/css/all.min.css"
+        integrity="sha512-Evv84Mr4kqVGRNSgIGL/F/aIDqQb7xQ2vcrdIwxfjThSH8CSR7PBEakCr51Ck+w+/U6swU2Im1vVX0SVk9ABhg=="
+        crossorigin="anonymous" referrerpolicy="no-referrer" />
+    <title>Documentation of vs.fltk</title>
+    <style>
+        figure {
+            text-align: center;
+            max-width: 600px;
+
+        }
+
+        nav {
+            gap: 1.0em;
+            flex-direction: column;
+            max-width: 600px;
+        }
+
+        nav button {
+            width: 100%;
+        }
+
+        main {
+            justify-content: center;
+            display: grid;
+        }
+    </style>
+</head>
+
+<body class="container">
+
+    <header>
+
+    </header>
+    <main>
+        <!--<figure>
+            <img src="./public/vs.light.svg" />
+        </figure>-->
+        <h1>Comfy Bun</h1>
+        <hr />
+        <nav>
+            <a href="https://github.com/KaruroChori/comfy-bun-client/releases"><button><i
+                        class="fa-solid fa-download"></i>
+                    Releases</button></a>
+            <a href="https://github.com/KaruroChori/comfy-bun-client"><button><i class="fa-brands fa-github"></i>
+                    Source</button></a>
+            <a href="./docs"><button><i class="fa-solid fa-book"></i> Main documentation</button></a>
+            <a href="./api"><button><i class="fa-solid fa-book"></i> API reference</button></a>
+            <button disabled>Online demo</button>
+            <button disabled><i class="fa-solid fa-comment"></i> Help</button>
+        </nav>
+    </main>
+    <footer>
+
+    </footer>
+
+</body>
+
+</html>
diff --git a/docs/index.md b/docs/index.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,19 @@
+site_name: comfy-bun
+repo_url: https://github.com/karurochori/comfy-bun-client
+site_dir: dist/website/docs
+docs_dir: docs
+
+theme:
+  name: readthedocs
+markdown_extensions:
+  - admonition
+  - pymdownx.tilde
+  - pymdownx.tasklist
+  - mdx_truly_sane_lists
+  - sane_lists
+  - smarty
+  - toc:
+      permalink: "#"
+plugins:
+  - search
+  - gh-admonitions
diff --git a/tsconfig.doc.json b/tsconfig.doc.json
@@ -32,7 +32,7 @@
   "include": ["./src/*", "./index.ts"],
   "typedocOptions": {
     "entryPoints": ["./index.ts"],
-    "out": "docs/api",
+    "out": "dist/website/api",
     "readme": "none"
   }
 }