setup simple doc template with vuepress

calblueprint · May 16, 2024 · 9b6ad88 · 9b6ad88
1 parent cc19672
commit 9b6ad88
Show file tree

Hide file tree

Showing 12 changed files with 3,564 additions and 600 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,6 @@
+# VuePress default temp directory
+.vuepress/.temp
+# VuePress default cache directory
+.vuepress/.cache
+# VuePress default build output directory
+.vuepress/dist
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -0,0 +1,25 @@
+import { viteBundler } from '@vuepress/bundler-vite';
+import { defaultTheme } from '@vuepress/theme-default';
+import { defineUserConfig } from 'vuepress';
+
+const globalNavbar = [
+  { text: 'Home', link: '/' },
+  { text: 'Admin Guide', link: '/admin/' },
+  { text: 'Developer Docs', link: '/dev/' },
+  { text: 'Design Prototypes', link: '/design/' },
+];
+
+export default defineUserConfig({
+  title: 'Immigration Justice Project',
+  description:
+    'Documentation for the user portal developed by Cal Blueprint for the Immigration Justice Project.',
+  bundler: viteBundler(),
+  theme: defaultTheme({
+    repo: 'calblueprint/immigration-justice-project',
+    docsDir: 'docs',
+    docsBranch: 'docs',
+    editLinkText: 'Edit this page on GitHub',
+    editLink: true,
+    navbar: globalNavbar,
+  }),
+});
diff --git a/docs/.vuepress/public/favicon.ico b/docs/.vuepress/public/favicon.ico
diff --git a/docs/.vuepress/public/ijp_logo_white.png b/docs/.vuepress/public/ijp_logo_white.png
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,3 @@
+---
+home: true
+---
diff --git a/docs/admin/README.md b/docs/admin/README.md
@@ -0,0 +1 @@
+# Admins
diff --git a/docs/backend/README.md b/docs/backend/README.md
@@ -0,0 +1 @@
+# Supabase Backend
diff --git a/docs/design/README.md b/docs/design/README.md
@@ -0,0 +1 @@
+# Design
diff --git a/docs/dev/README.md b/docs/dev/README.md
@@ -0,0 +1 @@
+# Developer Docs
diff --git a/docs/user-portal/README.md b/docs/user-portal/README.md
@@ -0,0 +1,2 @@
+# User Portal
+