chore: add doc example (#6)

* chore: add doc example

* chore: update lock

Author: nyqykk

pnpm-lock.yaml

@@ -0,0 +1,41 @@
+# Rslib project
+
+## Setup
+
+Install the dependencies:
+
+```bash
+pnpm install
+```
+
+## Get started
+
+Build the library:
+
+```bash
+pnpm build
+```
+
+Build the library in watch mode:
+
+```bash
+pnpm dev
+```
+
+Start the doc dev server:
+
+```bash
+pnpm doc
+```
+
+Build the doc for production:
+
+```bash
+pnpm doc:build
+```
+
+Preview the production build locally:
+
+```bash
+pnpm doc:preview
+```

test/doc/README.md

@@ -0,0 +1,30 @@
+# Button
+
+## Size
+
+Buttons can be small, medium and large in size.
+
+```jsx
+import React from 'react';
+import { Button } from 'rslib-module-doc';
+
+export default () => {
+  return <Button size="medium" label="Click me"></Button>;
+};
+```
+
+## Background color
+
+The background color of the button can be set by yourself.
+
+```jsx
+import React from 'react';
+import { Button } from 'rslib-module-doc';
+
+export default () => {
+  return <Button backgroundColor="red" label="红色"></Button>;
+};
+```
+
+## API
+<API moduleName="Button" en/>

test/doc/docs/en/Button.mdx

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

test/doc/docs/en/_meta.json

@@ -0,0 +1,4 @@
+---
+overview: true
+title: Overview
+---

test/doc/docs/en/index.mdx

@@ -0,0 +1,30 @@
+# Button
+
+## 尺寸
+
+按钮分为：小、中、大三种尺寸。
+
+```jsx
+import React from 'react';
+import { Button } from 'rslib-module-doc';
+
+export default () => {
+  return <Button size="medium" label="点我"></Button>;
+};
+```
+
+## 背景色
+
+按钮的背景色可以自行设置。
+
+```jsx
+import React from 'react';
+import { Button } from 'rslib-module-doc';
+
+export default () => {
+  return <Button backgroundColor="red" label="红色"></Button>;
+};
+```
+
+## API
+<API moduleName="Button"/>

test/doc/docs/zh/Button.mdx

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

test/doc/docs/zh/_meta.json

@@ -0,0 +1,4 @@
+---
+overview: true
+title: 总览
+---

test/doc/docs/zh/index.mdx

@@ -0,0 +1,39 @@
+{
+  "name": "rslib-module-doc",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "doc": "rspress dev",
+    "doc:build": "rspress build",
+    "doc:preview": "rspress preview"
+  },
+  "devDependencies": {
+    "rslib-module-doc": "workspace:*",
+    "@rsbuild/plugin-react": "^1.4.1",
+    "@rslib/core": "^0.14.0",
+    "@rspress/core": "^2.0.0-beta.33",
+    "@rspress/plugin-api-docgen": "^2.0.0-beta.33",
+    "@rspress/plugin-preview": "^2.0.0-beta.33",
+    "@types/node": "^24.5.2",
+    "@types/react": "^19.1.13",
+    "react": "^19.1.1",
+    "rsbuild-plugin-workspace-dev": "workspace:*",
+    "typescript": "^5.9.2"
+  },
+  "peerDependencies": {
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0"
+  }
+}

test/doc/package.json

@@ -0,0 +1,19 @@
+import { pluginReact } from '@rsbuild/plugin-react';
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    {
+      bundle: false,
+      dts: true,
+      format: 'esm',
+    },
+  ],
+  output: {
+    target: 'web',
+  },
+  source: {
+    tsconfigPath: 'tsconfig.build.json',
+  },
+  plugins: [pluginReact()],
+});