mirror of
https://github.com/QwenLM/qwen-code.git
synced 2025-12-19 09:33:53 +00:00
55 lines
1.0 KiB
Markdown
55 lines
1.0 KiB
Markdown
# Qwen Code Docs Site
|
|
|
|
A documentation website for Qwen Code built with [Next.js](https://nextjs.org/) and [Nextra](https://nextra.site/).
|
|
|
|
## Getting Started
|
|
|
|
### Prerequisites
|
|
|
|
- Node.js 18+
|
|
- npm or yarn
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
### Setup Content
|
|
|
|
Link the documentation content from the parent `docs` directory:
|
|
|
|
```bash
|
|
npm run link
|
|
```
|
|
|
|
This creates a symbolic link from `../docs` to `content` in the project.
|
|
|
|
### Development
|
|
|
|
Start the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Open [http://localhost:3000](http://localhost:3000) in your browser to see the documentation site.
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
docs-site/
|
|
├── src/
|
|
│ └── app/
|
|
│ ├── [[...mdxPath]]/ # Dynamic routing for MDX pages
|
|
│ │ └── page.jsx
|
|
│ └── layout.jsx # Root layout with navbar and footer
|
|
├── mdx-components.js # MDX component configuration
|
|
├── next.config.mjs # Next.js configuration
|
|
└── package.json
|
|
```
|
|
|
|
## License
|
|
|
|
MIT © Qwen Team
|