add a docsify start template

aircodelabs · Sep 20, 2023 · e34711f · e34711f
1 parent a646057
commit e34711f
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 3 deletions.
diff --git a/docs/integration/docsify.md b/docs/integration/docsify.md
@@ -73,7 +73,7 @@ pnpm install @documate/vanilla
 
 :::
 
-Them import it in your `index.js` file:
+Then import it in your `index.js` file:
 
 ```js
 import '@documate/vanilla'
@@ -95,7 +95,7 @@ Modify the Documate UI you added before to pass the endpoint to the `data-endpoi
 
 ```html
 <!-- Replace the URL with your own one -->
-<button id="ask-ai" data-endpoint="https://test123.us.aircode.run/ask"></button>
+<button id="ask-ai" data-endpoint="https://test123.us.aircode.run/ask">Ask AI</button>
 ```
 
 ## Run the Project

diff --git a/examples/docsify/.gitignore b/examples/docsify/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/examples/docsify/.nojekyll b/examples/docsify/.nojekyll
diff --git a/examples/docsify/README.md b/examples/docsify/README.md
@@ -0,0 +1,3 @@
+# Documate Docsify Starter
+
+This is a template for creating a new Docsify site with Documate. Read [the guide](https://documate.site/integration/docsify) for more information.
diff --git a/examples/docsify/_navbar.md b/examples/docsify/_navbar.md
@@ -0,0 +1,5 @@
+<body>
+  <!-- Replace the data-endpoint value with your own URL -->
+  <!-- @see: https://documate.site/integration/docsify#connect-to-backend -->
+  <a id="ask-ai" data-endpoint="https://test123.us.aircode.run/ask" href="###">Ask AI</a>
+</body>
diff --git a/examples/docsify/documate.json b/examples/docsify/documate.json
@@ -0,0 +1,5 @@
+{
+  "root": ".",
+  "include": [ "**/*.md" ],
+  "backend": ""
+}
diff --git a/examples/docsify/index.html b/examples/docsify/index.html
@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Documate Docsify Starter</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'Documate Docsify Starter',
+      repo: 'aircodelabs/documate',
+      loadNavbar: true,
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  <!-- Documate -->
+  <script src="https://unpkg.com/@documate/vanilla"></script>
+</body>
+</html>
diff --git a/examples/docsify/package.json b/examples/docsify/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "documate-docsify-starter",
+  "version": "1.0.0",
+  "description": "A template for creating a new Docsify site with Documate",
+  "private": true,
+  "scripts": {
+    "documate:upload": "documate upload"
+  },
+  "devDependencies": {
+    "@documate/documate": "^0.1.0"
+  }
+}
diff --git a/examples/vitepress/package.json b/examples/vitepress/package.json
@@ -1,6 +1,6 @@
 {
   "name": "documate-vitepress-starter",
-  "description": "A demo of how to integrate Documate into Vitepress site. You can also use this as a template to start a new project.",
+  "description": "A template for creating a new VitePress site with Documate",
   "version": "0.0.0",
   "private": true,
   "type": "module",