feat: integrate rspress (#39)

Author: sanyuan0704

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "all"
+}

cli/create-documate/index.js

@@ -4,12 +4,7 @@ const fs = require('fs-extra')
 const path = require('path')
 const prompts = require('prompts')
 
-const {
-  green,
-  lightBlue,
-  red,
-  reset,
-} = require('kolorist')
+const { green, lightBlue, red, reset } = require('kolorist')
 
 function pkgFromUserAgent(userAgent) {
   if (!userAgent) return undefined
@@ -42,6 +37,11 @@ const TEMPLATES = [
     display: 'Docusaurus',
     devCommand: '__PACKAGE_MANAGER__ start',
   },
+  {
+    name: 'rspress',
+    display: 'Rspress',
+    devCommand: '__PACKAGE_MANAGER__ dev',
+  },
 ]
 
 const DEFAULT_PROJECT_NAME = 'my-documate-project'
@@ -78,19 +78,15 @@ async function create(name, options) {
 
   if (questions.length > 0) {
     try {
-      result = await prompts(
-        questions,
-        {
-          onCancel: () => {
-            throw new Error(red('✖') + ' Operation cancelled')
-          },
+      result = await prompts(questions, {
+        onCancel: () => {
+          throw new Error(red('✖') + ' Operation cancelled')
         },
-      )
+      })
 
       // user choice associated with prompts
       template = template || result.template.name
       projectName = projectName || result.projectName
-
     } catch (cancelled) {
       console.log(cancelled.message)
       return
@@ -110,20 +106,22 @@ async function create(name, options) {
       console.log(`\nDone.\n`)
 
       console.log('  cd', projectName)
-      console.log(`  ${pkgManager === 'yarn' ? 'yarn' : `${pkgManager} install`}`)
+      console.log(
+        `  ${pkgManager === 'yarn' ? 'yarn' : `${pkgManager} install`}`,
+      )
 
-      const selected = TEMPLATES.find(t => t.name === template)
+      const selected = TEMPLATES.find((t) => t.name === template)
       const devCommand = selected
         ? selected.devCommand.replace('__PACKAGE_MANAGER__', pkgManager)
         : `${pkgManager} run dev`
       console.log(`  ${devCommand}`)
 
       console.log('\nVisit https://documate.site for more information.')
     })
-    .catch(err => console.error('err: '+ err))
+    .catch((err) => console.error('err: ' + err))
 }
 
-async function main () {
+async function main() {
   program
     .name('create-documate')
     .argument('[project-name]')
@@ -133,6 +131,6 @@ async function main () {
   await program.parseAsync(process.argv)
 }
 
-main().catch(err => {
+main().catch((err) => {
   console.error(err)
 })

docs/.vitepress/config.ts

@@ -5,13 +5,21 @@ import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   title: 'Documate',
-  description: 'Seamlessly embed AI chat into your doc site. Documate is fully open-source, controllable, and customizable.',
+  description:
+    'Seamlessly embed AI chat into your doc site. Documate is fully open-source, controllable, and customizable.',
   head: [
-    [ 'link', { rel: 'icon', href: '/favicon.ico' } ],
-    [ 'meta', { name: 'robots', content: 'index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1' } ],
-    [ 'meta', { name: 'twitter:card', content: 'summary_large_image' } ],
-    [ 'meta', { name: 'og:image', content: '/og-image-0916.png' } ],
-    [ 'meta', { name: 'twitter:image', content: '/og-image-0916.png' } ],
+    ['link', { rel: 'icon', href: '/favicon.ico' }],
+    [
+      'meta',
+      {
+        name: 'robots',
+        content:
+          'index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1',
+      },
+    ],
+    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
+    ['meta', { name: 'og:image', content: '/og-image-0916.png' }],
+    ['meta', { name: 'twitter:image', content: '/og-image-0916.png' }],
   ],
   cleanUrls: true,
   vite: {
@@ -20,8 +28,8 @@ export default defineConfig({
         {
           find: /^.*\/VPFeature\.vue$/,
           replacement: fileURLToPath(
-            new URL('./theme/components/DocuFeature.vue', import.meta.url)
-          )
+            new URL('./theme/components/DocuFeature.vue', import.meta.url),
+          ),
         },
       ],
     },
@@ -33,7 +41,7 @@ export default defineConfig({
   },
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
-    logo: { 
+    logo: {
       light: '/site-logo-light.svg',
       dark: '/site-logo-dark.svg',
       height: 24,
@@ -42,12 +50,12 @@ export default defineConfig({
     siteTitle: false,
 
     outline: {
-      level: [ 2, 3 ],
+      level: [2, 3],
     },
 
     nav: [
       { text: 'Quickstart', link: '/getting-started/' },
-      { text: 'Reference', link: '/reference/documate-config' }
+      { text: 'Reference', link: '/reference/documate-config' },
     ],
 
     sidebar: [
@@ -59,6 +67,7 @@ export default defineConfig({
           { text: 'Start with VitePress', link: '/integration/vitepress' },
           { text: 'Start with Docusaurus', link: '/integration/docusaurus' },
           { text: 'Start with Docsify', link: '/integration/docsify' },
+          { text: 'Start with Rspress', link: '/integration/rspress' },
           { text: 'General Vue Project', link: '/getting-started/general-vue' },
         ],
       },
@@ -69,18 +78,19 @@ export default defineConfig({
           { text: 'CLI', link: '/reference/cli' },
           { text: '@documate/vue', link: '/reference/documate-vue' },
           // { text: 'Backend APIs', link: '/reference/backend-apis' },
-        ]
+        ],
       },
     ],
 
     socialLinks: [
       { icon: 'github', link: 'https://github.com/aircodelabs/documate' },
-      { icon: 'discord', link: 'https://discord.gg/YhypQrZBu5' }
+      { icon: 'discord', link: 'https://discord.gg/YhypQrZBu5' },
     ],
 
     footer: {
-      message: 'Made with ❤️ by <a href="https://aircode.io" target="_blank">AirCode</a>',
+      message:
+        'Made with ❤️ by <a href="https://aircode.io" target="_blank">AirCode</a>',
       copyright: '© 2023 AirCode, Inc. All rights reserved.',
-    }
+    },
   },
 })

docs/getting-started/index.md

@@ -1,6 +1,6 @@
 # Documate Quickstart
 
-Documate is an open-source tool designed to seamlessly __integrate an AI chat dialog into your documentation site__.
+Documate is an open-source tool designed to seamlessly **integrate an AI chat dialog into your documentation site**.
 
 It uses your content to generate real-time answers to user questions, effectively acting as a "ChatGPT" for your platform.
 
@@ -13,6 +13,7 @@ Please choose a framework below to get started:
 - [VitePress](/integration/vitepress)
 - [Docusaurus](/integration/docusaurus)
 - [Docsify](/integration/docsify)
+- [Rspress](/integration/rspress)
 - [General Vue Project](/getting-started/general-vue)
 
 The following frameworks are coming soon:
@@ -30,7 +31,7 @@ Documate can integrate with popular frameworks you're already familiar with, suc
 
 ### Easy to Use
 
-No  AI or vector search knowledge required. Simply follow a few steps, and you can integrate Documate into your site in minutes.
+No AI or vector search knowledge required. Simply follow a few steps, and you can integrate Documate into your site in minutes.
 
 ### Fully Controllable
 
@@ -52,49 +53,90 @@ These examples can serve as headless templates to kickstart a new documentation
 
 ::: tabs key:pm
 == npm
+
 ```bash
 npm create documate@latest --template vitepress
 ```
+
 == yarn
+
 ```bash
 yarn create documate --template vitepress
 ```
+
 == pnpm
+
 ```bash
 pnpm create documate --template vitepress
 ```
+
 :::
 
 - Docusaurus ([examples/docusaurus](https://github.com/AirCodeLabs/documate/tree/main/examples/docusaurus))
 
 ::: tabs key:pm
 == npm
+
 ```bash
 npm create documate@latest --template docusaurus
 ```
+
 == yarn
+
 ```bash
 yarn create documate --template docusaurus
 ```
+
 == pnpm
+
 ```bash
 pnpm create documate --template docusaurus
 ```
+
 :::
 
 - Docsify ([examples/docsify](https://github.com/AirCodeLabs/documate/tree/main/examples/docsify))
 
 ::: tabs key:pm
 == npm
+
 ```bash
 npm create documate@latest --template docsify
 ```
+
 == yarn
+
 ```bash
 yarn create documate --template docsify
 ```
+
 == pnpm
+
 ```bash
 pnpm create documate --template docsify
 ```
+
+:::
+
+- Rspress ([examples/rspress](https://github.com/AirCodeLabs/documate/tree/main/examples/rspress))
+
+::: tabs key:pm
+== npm
+
+```bash
+npm create documate@latest --template rspress
+```
+
+== yarn
+
+```bash
+yarn create documate --template rspress
+```
+
+== pnpm
+
+```bash
+pnpm create documate --template rspress
+```
+
 :::