docs: add documentation example (#4)

Author: chenjiahan

examples/documentation/README.md

@@ -0,0 +1,29 @@
+# Rspress website
+
+## Setup
+
+Install the dependencies:
+
+```bash
+npm install
+```
+
+## Get started
+
+Start the dev server:
+
+```bash
+npm run dev
+```
+
+Build the website for production:
+
+```bash
+npm run build
+```
+
+Preview the production build locally:
+
+```bash
+npm run preview
+```

examples/documentation/docs/_nav.json

@@ -0,0 +1,11 @@
+[
+  {
+    "text": "API",
+    "link": "/api/",
+    "activeMatch": "/api/"
+  },
+  {
+    "text": "Document",
+    "link": "https://rspress.rs/"
+  }
+]

examples/documentation/docs/api/_meta.json

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

examples/documentation/docs/api/commands.mdx

@@ -0,0 +1,7 @@
+# Commands
+
+## dev
+
+## build
+
+## preview

examples/documentation/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.

examples/documentation/docs/index.md

@@ -0,0 +1,18 @@
+---
+pageType: home
+
+hero:
+  name: My Site
+  text: A cool website!
+  tagline: This is the tagline
+  actions:
+    - theme: brand
+      text: Quick Start
+      link: /api/
+    - theme: alt
+      text: GitHub
+      link: https://github.com/web-infra-dev/rspress
+  image:
+    src: https://assets.rspack.rs/rspress/rspress-logo.svg
+    alt: Logo
+---

examples/documentation/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@examples/documentation",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "rs doc build",
+    "dev": "rs doc",
+    "lint": "rs lint",
+    "preview": "rs doc preview"
+  },
+  "dependencies": {
+    "rstack": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/node": "catalog:",
+    "@types/react": "catalog:",
+    "@types/react-dom": "catalog:",
+    "react": "catalog:",
+    "react-dom": "catalog:"
+  }
+}

examples/documentation/rstack.config.ts

@@ -0,0 +1,17 @@
+import { define } from 'rstack';
+import path from 'node:path';
+
+define.doc({
+  root: path.join(import.meta.dirname, 'docs'),
+  title: 'My Site',
+});
+
+define.lint(async () => {
+  const { js, ts, reactPlugin, reactHooksPlugin } = await import('rstack/lint');
+  return [
+    js.configs.recommended,
+    ts.configs.recommended,
+    reactPlugin.configs.recommended,
+    reactHooksPlugin.configs.recommended,
+  ];
+});

examples/documentation/tsconfig.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "lib": ["DOM", "ES2020"],
+    "jsx": "react-jsx",
+    "target": "ES2020",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "types": ["rstack/types", "node"],
+    "useDefineForClassFields": true,
+
+    /* modules */
+    "moduleDetection": "force",
+    "moduleResolution": "bundler",
+    "verbatimModuleSyntax": true,
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": true,
+
+    /* type checking */
+    "noUnusedLocals": true,
+    "noUnusedParameters": true
+  },
+  "include": ["docs", "rstack.config.ts"],
+  "mdx": {
+    "checkMdx": true
+  }
+}