[feat] use vitepress to host docs

ast-grep · Sep 13, 2022 · ad09d42 · ad09d42
1 parent 28b32c9
commit ad09d42
Show file tree

Hide file tree

Showing 15 changed files with 390 additions and 45 deletions.
diff --git a/website/.vitepress/config.ts b/website/.vitepress/config.ts
@@ -0,0 +1,29 @@
+import { defineConfig } from 'vitepress'
+
+const gaScript = `
+window.dataLayer = window.dataLayer || [];
+function gtag(){dataLayer.push(arguments);}
+gtag('js', new Date());
+
+gtag('config', 'G-EZSJ3YF2RG');
+`
+
+export default defineConfig({
+  lang: 'en-US',
+  title: 'ast-grep',
+  titleTemplate: 'ligthning fast code tool',
+  base: '/ast-grep/',
+  description: 'ast-grep(sg) is a ligthning fast and user friendly tool for code searching, linting, rewriting at large scale.',
+  // head: [
+  //   ['script', {async: '', src: 'https://www.googletagmanager.com/gtag/js?id=G-EZSJ3YF2RG'}],
+  //   ['script', {}, gaScript],
+  // ],
+  outDir: './dist',
+  themeConfig: {
+    logo: 'logo.svg',
+    nav: [
+      { text: 'Guide', link: '/guide' },
+      { text: 'Playground', link: '/playground' },
+    ],
+  },
+})
diff --git a/website/docs/TODO.md → website/guide/TODO.md b/website/docs/TODO.md → website/guide/TODO.md
diff --git a/website/docs/command_line_usage.md → website/guide/api-usage.md b/website/docs/command_line_usage.md → website/guide/api-usage.md
diff --git a/website/docs/editor_integration.md → website/guide/command-line.md b/website/docs/editor_integration.md → website/guide/command-line.md
diff --git a/website/docs/installation.md → website/guide/editor-integration.md b/website/docs/installation.md → website/guide/editor-integration.md
diff --git a/website/docs/rule_configuration.md → website/guide/installation.md b/website/docs/rule_configuration.md → website/guide/installation.md
diff --git a/website/guide/introduction.md b/website/guide/introduction.md
diff --git a/website/guide/rule-config.md b/website/guide/rule-config.md
diff --git a/website/index.html b/website/index.html
diff --git a/website/index.md b/website/index.md
@@ -0,0 +1,30 @@
+---
+layout: home
+
+hero:
+  name: ast-grep
+  text: Write Code to Match Code
+  tagline: ast-grep(sg) is a ligthning fast and user friendly tool for code searching, linting, rewriting at large scale.
+  image:
+    src: ../logo.svg
+    alt: VitePress
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /guide/introduction
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/HerringtonDarkholme/ast-grep
+
+features:
+  - icon: ⚡️
+    title: Performant
+    details: Lorem ipsum...
+  - icon: ⚡️
+    title: Progressive
+    details: Lorem ipsum...
+  - icon: 🛠️
+    title: Pragmatic
+    details: Lorem ipsum...
+
+---
diff --git a/website/package.json b/website/package.json
@@ -4,9 +4,9 @@
   "version": "0.0.0",
   "type": "module",
   "scripts": {
-    "dev": "vite",
-    "build": "vue-tsc --noEmit && vite build",
-    "preview": "vite preview"
+    "dev": "vitepress dev",
+    "build": "vue-tsc --noEmit && vitepress build",
+    "serve": "vitepress serve"
   },
   "dependencies": {
     "@types/js-yaml": "^4.0.5",
@@ -20,7 +20,8 @@
     "ast-grep-wasm": "file:../crates/wasm/pkg/"
   },
   "devDependencies": {
-    "@vitejs/plugin-vue": "3.1.0",
+    "@algolia/client-search": "4.9.1",
+    "vitepress": "^1.0.0-alpha.13",
     "typescript": "4.8.3",
     "vite": "3.1.0",
     "vue-tsc": "0.40.13"

diff --git a/website/playground.md b/website/playground.md
@@ -0,0 +1,9 @@
+---
+layout: page
+---
+
+<script setup>
+import App from './src/App.vue'
+</script>
+
+<App/>