feat(create-rstack): add basic documentation template (#253)

Author: chenjiahan

packages/create-rstack/README.md

@@ -37,6 +37,7 @@ npx create-rstack -d my-project -t app-vanilla-ts
 - `lib-vue-ts` - TypeScript Vue library
 - `lib-solid-js` - JavaScript Solid library
 - `lib-solid-ts` - TypeScript Solid library
+- `doc-basic` - Basic documentation site
 
 ## Documentation
 

packages/create-rstack/src/index.ts

@@ -23,6 +23,11 @@ const getTemplateName = async ({ template }: Argv): Promise<string> => {
       return `lib-${libraryType}-${language}`;
     }
 
+    if (template === 'doc' || template.startsWith('doc-')) {
+      const [, documentationType = 'basic'] = template.split('-');
+      return `doc-${documentationType}`;
+    }
+
     const [type, language = 'js'] = template.split('-');
     return `${type}-${language}`;
   }
@@ -33,10 +38,15 @@ const getTemplateName = async ({ template }: Argv): Promise<string> => {
       options: [
         { value: 'app', label: 'Web Application' },
         { value: 'lib', label: 'Library' },
+        { value: 'doc', label: 'Documentation' },
       ],
     }),
   );
 
+  if (projectType === 'doc') {
+    return 'doc-basic';
+  }
+
   const templateType = checkCancel<string>(
     await select({
       message: projectType === 'app' ? 'Select framework' : 'Select library type',
@@ -90,6 +100,7 @@ await create({
     'lib-vue-ts',
     'lib-solid-js',
     'lib-solid-ts',
+    'doc-basic',
   ],
   builtinTools: [],
   getTemplateName,

packages/create-rstack/template-doc-basic/AGENTS.md

@@ -0,0 +1,13 @@
+# AGENTS.md
+
+## Commands
+
+- `{{ packageManager }} run dev` - Start the documentation development server
+- `{{ packageManager }} run build` - Build the documentation site for production
+- `{{ packageManager }} run preview` - Preview the production build locally
+
+## Docs
+
+- Rstack: https://rstack.rs/llms.txt
+- Rspress: https://rspress.rs/llms.txt
+- Rsbuild: https://rsbuild.rs/llms.txt

packages/create-rstack/template-doc-basic/README.md

@@ -0,0 +1,34 @@
+# Rstack documentation site
+
+## Setup
+
+Install the dependencies:
+
+```bash
+{{ packageManager }} install
+```
+
+## Get started
+
+Start the development server:
+
+```bash
+{{ packageManager }} run dev
+```
+
+Build the website for production:
+
+```bash
+{{ packageManager }} run build
+```
+
+Preview the production build locally:
+
+```bash
+{{ packageManager }} run preview
+```
+
+## Learn more
+
+- [Rstack documentation](https://rstack.rs)
+- [Rspress documentation](https://rspress.rs)

packages/create-rstack/template-doc-basic/docs/_nav.json

@@ -0,0 +1,16 @@
+[
+  {
+    "text": "Guide",
+    "link": "/guide/start/introduction",
+    "activeMatch": "/guide/"
+  },
+  {
+    "text": "API",
+    "link": "/api/",
+    "activeMatch": "/api/"
+  },
+  {
+    "text": "Rspress",
+    "link": "https://rspress.rs/"
+  }
+]

packages/create-rstack/template-doc-basic/docs/api/_meta.json

@@ -0,0 +1 @@
+["index", "commands"]

packages/create-rstack/template-doc-basic/docs/api/commands.mdx

@@ -0,0 +1,25 @@
+# Commands
+
+## dev
+
+Start the local development server:
+
+```bash
+rs doc
+```
+
+## build
+
+Build the documentation site for production:
+
+```bash
+rs doc build
+```
+
+## preview
+
+Preview the production build locally:
+
+```bash
+rs doc preview
+```

packages/create-rstack/template-doc-basic/docs/api/index.mdx

@@ -0,0 +1,6 @@
+---
+title: API Overview
+overview: true
+---
+
+This is an API Overview page which outlines all the available APIs.

packages/create-rstack/template-doc-basic/docs/guide/_meta.json

@@ -0,0 +1,7 @@
+[
+  {
+    "type": "dir-section-header",
+    "name": "start",
+    "label": "Getting Started"
+  }
+]

packages/create-rstack/template-doc-basic/docs/guide/start/_meta.json

@@ -0,0 +1 @@
+["introduction"]