Add docs (#332)

Author: w1am

.github/workflows/build-docs.yml

@@ -0,0 +1,14 @@
+name: Build Production Site
+
+on:
+  push:
+    branches: [release/**/**]
+    paths:
+      - '**.md'
+
+jobs:
+  dispatch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger build
+        run: curl -X POST -d {} "${{ secrets.CLOUDFLARE_BUILD_HOOK }}"

.github/workflows/tests.yml

@@ -1,6 +1,12 @@
 name: tests workflow
 
 on:
+  pull_request:
+    paths-ignore:
+      - "docs/**"
+      - "samples/**"
+      - "**.md"
+
   workflow_call:
     inputs:
       image:

.gitignore

@@ -173,3 +173,7 @@ fabric.properties
 
 # Generated certificates
 certs/
+
+.temp
+.cache
+node_modules

docs/.eslintignore

@@ -0,0 +1,6 @@
+!.vuepress/
+!.*.js
+.cache/
+.temp/
+node_modules/
+dist/

docs/.eslintrc.cjs

@@ -0,0 +1,13 @@
+module.exports = {
+    root: true,
+    extends: 'vuepress',
+    overrides: [
+        {
+            files: ['*.ts', '*.vue'],
+            extends: 'vuepress-typescript',
+            parserOptions: {
+                project: ['tsconfig.json'],
+            },
+        },
+    ],
+}

docs/.node-version

@@ -0,0 +1 @@
+20

docs/.vuepress/client.ts

@@ -0,0 +1,10 @@
+import type {Router} from "vue-router";
+
+interface ClientConfig {
+    enhance?: (context: {
+        app: any;
+        router: Router;
+        siteData: any;
+    }) => void | Promise<void>;
+    setup?: () => void;
+}

docs/.vuepress/config.ts

@@ -0,0 +1,28 @@
+import { dl } from "@mdit/plugin-dl";
+import viteBundler from "@vuepress/bundler-vite";
+import vueDevTools from 'vite-plugin-vue-devtools'
+import { defineUserConfig } from "vuepress";
+import { hopeTheme } from "vuepress-theme-hope";
+import { themeOptions } from "./configs/theme";
+import { linkCheckPlugin } from "./markdown/linkCheck";
+import { replaceLinkPlugin } from "./markdown/replaceLink";
+
+
+export default defineUserConfig({
+  base: "/",
+  dest: "public",
+  title: "Docs",
+  description: "Event-native database",
+  bundler: viteBundler({ viteOptions: { plugins: [vueDevTools(),], } }),
+  markdown: { importCode: false },
+  extendsMarkdown: md => {
+    md.use(linkCheckPlugin);
+    md.use(replaceLinkPlugin, {
+      replaceLink: (link: string, _) => link
+        .replace("@api", "/api")
+        .replace("@server/", "/server/{version}/")
+    });
+    md.use(dl);
+  },
+  theme: hopeTheme(themeOptions, { custom: true }),
+});

docs/.vuepress/configs/theme.ts

@@ -0,0 +1,36 @@
+import type {ThemeOptions} from "vuepress-theme-hope";
+
+export const themeOptions: ThemeOptions = {
+    logo: "/Kurrent Logo - Plum.svg",
+    logoDark: "/Kurrent Logo - White.svg",
+    docsDir: 'docs',
+    editLink: false,
+    lastUpdated: true,
+    toc: true,
+    repo: "https://github.com/kurrent-io",
+    repoLabel: "GitHub",
+    repoDisplay: true,
+    contributors: false,
+    pure: false,
+    darkmode:"toggle",
+    headerDepth: 3,
+    pageInfo: false,
+    markdown: {
+        figure: true,
+        imgLazyload: true,
+        imgMark: true,
+        imgSize: true,
+        tabs: true,
+        codeTabs: true,
+        component: true,
+        mermaid: true,
+        highlighter: {
+            type: "shiki",
+            themes: {
+                light: "one-light",
+                dark: "one-dark-pro",
+            }
+        }
+    }
+}
+

docs/.vuepress/lib/externalPlaceholders.ts

@@ -0,0 +1,6 @@
+const externalPlaceholders = ["@samples", "@clients"];
+
+export function isKnownPlaceholder(placeholder: string): boolean {
+    const known = externalPlaceholders.find(x => x == placeholder);
+    return known !== undefined;
+}