Add static docs site (w/VuePress)

friendsofgo · Nov 24, 2023 · 473123f · 473123f
1 parent 8ff948c
commit 473123f
Show file tree

Hide file tree

Showing 69 changed files with 6,214 additions and 0 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,30 @@
+name: Docs
+
+on:
+  push:
+    paths: [ docs/** ]
+    branches: [ docs ]
+    # branches: [main]
+
+defaults:
+  run:
+    working-directory: ./docs
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+      - name: Build docs site
+        run: |
+          npm install
+          npm run build
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: docs/.vuepress/dist
diff --git a/.github/workflows/main.yaml → .github/workflows/main.yml b/.github/workflows/main.yaml → .github/workflows/main.yml
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+.temp
+.cache
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -0,0 +1,67 @@
+import {defaultTheme} from '@vuepress/theme-default'
+import {searchPlugin} from '@vuepress/plugin-search'
+
+export default {
+	base: '/killgrave/',
+	title: 'Killgrave',
+	description: 'The simplest way to generate your mock servers',
+	head: [['link', {rel: 'icon', href: 'img/killgrave.png'}]],
+	plugins: [
+		searchPlugin({}),
+	],
+	theme: defaultTheme({
+		logo: 'img/killgrave.png',
+		repo: 'friendsofgo/killgrave',
+		docsBranch: 'main',
+		docsDir: 'docs',
+		editLinkPattern: ':repo/edit/:branch/:path',
+		themePlugins: {
+			backToTop: true,
+		},
+		navbar: [
+			{
+				text: 'Get started',
+				link: '/guide/',
+			},
+			{
+				text: 'CLI',
+				link: '/cli/',
+			},
+			{
+				text: 'Config Reference',
+				link: '/config/'
+			},
+		],
+		sidebar: {
+			'/guide/': [
+				{
+					text: 'Introduction',
+					link: '/guide/',
+					children: [
+						'/guide/concepts.md',
+						'/guide/installation.md',
+					]
+				},
+				{
+					text: 'Using Killgrave',
+					link: '/guide/getting-started.md',
+					children: [
+						'/guide/getting-started.md',
+						'/guide/your-first-imposter.md',
+						'/guide/advanced.md',
+					]
+				},
+				{
+					text: 'How to...?',
+					link: '/guide/ht-regex.md',
+					children: [
+						'/guide/ht-regex.md',
+						'/guide/ht-json.md',
+						'/guide/ht-delays.md',
+						'/guide/ht-dynamic.md',
+					]
+				}
+			],
+		},
+	}),
+}
diff --git a/docs/.vuepress/dist/404.html b/docs/.vuepress/dist/404.html
@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <meta name="generator" content="VuePress 2.0.0-rc.0">
+    <style>
+      :root {
+        --c-bg: #fff;
+      }
+      html.dark {
+        --c-bg: #22272e;
+      }
+      html, body {
+        background-color: var(--c-bg);
+      }
+    </style>
+    <script>
+      const userMode = localStorage.getItem('vuepress-color-scheme');
+			const systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;
+			if (userMode === 'dark' || (userMode !== 'light' && systemDarkMode)) {
+				document.documentElement.classList.toggle('dark', true);
+			}
+    </script>
+    <link rel="icon" href="img/killgrave.png"><title>Killgrave</title><meta name="description" content="The simplest way to generate your mock servers">
+    <link rel="preload" href="/assets/style-pBmjJHNx.css" as="style"><link rel="stylesheet" href="/assets/style-pBmjJHNx.css">
+    <link rel="modulepreload" href="/assets/app-NlqJkyee.js"><link rel="modulepreload" href="/assets/404.html-6Yl8cQE3.js"><link rel="modulepreload" href="/assets/404.html-zaUbpv1Y.js">
+    <link rel="prefetch" href="/assets/index.html-PxiUBHrl.js" as="script"><link rel="prefetch" href="/assets/index.html-Tfj27SXM.js" as="script"><link rel="prefetch" href="/assets/index.html-6R8AqEKK.js" as="script"><link rel="prefetch" href="/assets/index.html-L9vla8oO.js" as="script"><link rel="prefetch" href="/assets/advanced.html-iNDAHVNe.js" as="script"><link rel="prefetch" href="/assets/concepts.html-vdpKy3hB.js" as="script"><link rel="prefetch" href="/assets/debug-intro.html-lxVKYex8.js" as="script"><link rel="prefetch" href="/assets/getting-started.html-3M2fRUSo.js" as="script"><link rel="prefetch" href="/assets/ht-delays.html-2YYyur9Z.js" as="script"><link rel="prefetch" href="/assets/ht-dynamic.html-mnrmM-0f.js" as="script"><link rel="prefetch" href="/assets/ht-json.html-svcQO3oy.js" as="script"><link rel="prefetch" href="/assets/ht-regex.html-0dwHWvia.js" as="script"><link rel="prefetch" href="/assets/installation.html-AlltRn9-.js" as="script"><link rel="prefetch" href="/assets/your-first-imposter.html-N1HwMT6q.js" as="script"><link rel="prefetch" href="/assets/index.html-sDp3Q7ai.js" as="script"><link rel="prefetch" href="/assets/index.html-6PwpWEb8.js" as="script"><link rel="prefetch" href="/assets/index.html-lMMJzd58.js" as="script"><link rel="prefetch" href="/assets/index.html-3SXYrp6X.js" as="script"><link rel="prefetch" href="/assets/advanced.html-EHvSOtPk.js" as="script"><link rel="prefetch" href="/assets/concepts.html-fgMceQEY.js" as="script"><link rel="prefetch" href="/assets/debug-intro.html-6UlBdtIY.js" as="script"><link rel="prefetch" href="/assets/getting-started.html-AFZ7P57y.js" as="script"><link rel="prefetch" href="/assets/ht-delays.html-xj5gk8an.js" as="script"><link rel="prefetch" href="/assets/ht-dynamic.html-e-u1t7Th.js" as="script"><link rel="prefetch" href="/assets/ht-json.html-Uc6IKtmc.js" as="script"><link rel="prefetch" href="/assets/ht-regex.html-6a_4A5St.js" as="script"><link rel="prefetch" href="/assets/installation.html-MJFRIgKS.js" as="script"><link rel="prefetch" href="/assets/your-first-imposter.html-7_f6__tF.js" as="script">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme-container"><main class="page"><div class="theme-default-content"><h1>404</h1><blockquote>Looks like we&#39;ve got some broken links.</blockquote><a href="/" class="">Take me home</a></div></main></div><!----><!--]--></div>
+    <script type="module" src="/assets/app-NlqJkyee.js" defer></script>
+  </body>
+</html>
diff --git a/docs/.vuepress/dist/assets/404.html-6Yl8cQE3.js b/docs/.vuepress/dist/assets/404.html-6Yl8cQE3.js
@@ -0,0 +1 @@
+const t=JSON.parse('{"key":"v-3706649a","path":"/404.html","title":"","lang":"en-US","frontmatter":{"layout":"NotFound"},"headers":[],"git":{},"filePathRelative":null}');export{t as data};
diff --git a/docs/.vuepress/dist/assets/404.html-zaUbpv1Y.js b/docs/.vuepress/dist/assets/404.html-zaUbpv1Y.js
@@ -0,0 +1 @@
+import{_ as e,o as c,c as t}from"./app-NlqJkyee.js";const _={};function o(r,n){return c(),t("div")}const a=e(_,[["render",o],["__file","404.html.vue"]]);export{a as default};
diff --git a/docs/.vuepress/dist/assets/advanced.html-EHvSOtPk.js b/docs/.vuepress/dist/assets/advanced.html-EHvSOtPk.js
diff --git a/docs/.vuepress/dist/assets/advanced.html-iNDAHVNe.js b/docs/.vuepress/dist/assets/advanced.html-iNDAHVNe.js
diff --git a/docs/.vuepress/dist/assets/app-NlqJkyee.js b/docs/.vuepress/dist/assets/app-NlqJkyee.js
diff --git a/docs/.vuepress/dist/assets/concepts.html-fgMceQEY.js b/docs/.vuepress/dist/assets/concepts.html-fgMceQEY.js
diff --git a/docs/.vuepress/dist/assets/concepts.html-vdpKy3hB.js b/docs/.vuepress/dist/assets/concepts.html-vdpKy3hB.js
diff --git a/docs/.vuepress/dist/assets/debug-intro.html-6UlBdtIY.js b/docs/.vuepress/dist/assets/debug-intro.html-6UlBdtIY.js
diff --git a/docs/.vuepress/dist/assets/debug-intro.html-lxVKYex8.js b/docs/.vuepress/dist/assets/debug-intro.html-lxVKYex8.js
diff --git a/docs/.vuepress/dist/assets/getting-started.html-3M2fRUSo.js b/docs/.vuepress/dist/assets/getting-started.html-3M2fRUSo.js
diff --git a/docs/.vuepress/dist/assets/getting-started.html-AFZ7P57y.js b/docs/.vuepress/dist/assets/getting-started.html-AFZ7P57y.js
diff --git a/docs/.vuepress/dist/assets/ht-delays.html-2YYyur9Z.js b/docs/.vuepress/dist/assets/ht-delays.html-2YYyur9Z.js
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		const t=JSON.parse('{"key":"v-3706649a","path":"/404.html","title":"","lang":"en-US","frontmatter":{"layout":"NotFound"},"headers":[],"git":{},"filePathRelative":null}');export{t as data};
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		import{_ as e,o as c,c as t}from"./app-NlqJkyee.js";const _={};function o(r,n){return c(),t("div")}const a=e(_,[["render",o],["__file","404.html.vue"]]);export{a as default};