init repo

This commit is contained in:
Sun-ZhenXing
2026-03-30 16:34:04 +08:00
commit d85ab53114
16 changed files with 2622 additions and 0 deletions
+14
View File
@@ -0,0 +1,14 @@
# Local
.DS_Store
*.local
*.log*
# Dist
node_modules
dist/
doc_build/
# IDE
.vscode/*
!.vscode/extensions.json
.idea
+29
View File
@@ -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
```
+17
View File
@@ -0,0 +1,17 @@
# CLI Commands
## build
Build the documentation site for production.
```bash
rspress build
```
## dev
Start the development server.
```bash
rspress dev
```
+3
View File
@@ -0,0 +1,3 @@
# API Reference
This is the API documentation.
+11
View File
@@ -0,0 +1,11 @@
# Getting Started
## Installation
```bash
npm install rspress
```
## Quick Start
Create your first documentation site.
+7
View File
@@ -0,0 +1,7 @@
# Introduction
Welcome to the documentation!
## Getting Started
This is a sample documentation page.
+3
View File
@@ -0,0 +1,3 @@
# Code Blocks
Using code blocks in your documentation.
+3
View File
@@ -0,0 +1,3 @@
# Code Block Meta
Meta information for code blocks.
+3
View File
@@ -0,0 +1,3 @@
# Code Block Title
Adding titles to code blocks.
+3
View File
@@ -0,0 +1,3 @@
# Using Components
You can use React components in MDX.
+3
View File
@@ -0,0 +1,3 @@
# Container
Syntax for creating containers.
+26
View File
@@ -0,0 +1,26 @@
---
pageType: home
hero:
name: My Site
text: A cool website!
tagline: This is the tagline
link: /
actions:
- theme: brand
text: Quick Start
link: /guide/start/introduction
- theme: alt
text: GitHub
link: https://github.com/web-infra-dev/rspress
image:
src: /rspress-icon.png
alt: Logo
features:
- title: Blazing fast build speed
details: Fast build speed with Rust-based toolchain.
icon: 🏃🏻‍♀️
- title: Support for MDX
details: Write content with MDX.
icon: 📦
---
+21
View File
@@ -0,0 +1,21 @@
{
"name": "rspress-bug-report",
"version": "1.0.0",
"private": true,
"type": "module",
"scripts": {
"build": "rspress build",
"dev": "rspress dev",
"preview": "rspress preview"
},
"dependencies": {
"@rspress/core": "^2.0.6"
},
"devDependencies": {
"@types/node": "^22.8.1",
"@types/react": "^19.2.14",
"@types/react-dom": "^19.2.3",
"react": "^19.2.4",
"react-dom": "^19.2.4"
}
}
+2430
View File
File diff suppressed because it is too large Load Diff
+21
View File
@@ -0,0 +1,21 @@
import * as path from 'node:path';
import { defineConfig } from '@rspress/core';
export default defineConfig({
root: path.join(__dirname, 'docs'),
title: 'My Site',
icon: '/rspress-icon.png',
logo: {
light: '/rspress-light-logo.png',
dark: '/rspress-dark-logo.png',
},
themeConfig: {
socialLinks: [
{
icon: 'github',
mode: 'link',
content: 'https://github.com/web-infra-dev/rspress',
},
],
},
});
+28
View File
@@ -0,0 +1,28 @@
{
"compilerOptions": {
"lib": ["DOM", "ES2020"],
"jsx": "react-jsx",
"target": "ES2020",
"noEmit": true,
"skipLibCheck": true,
"useDefineForClassFields": true,
/* modules */
"module": "ESNext",
"moduleDetection": "force",
"moduleResolution": "bundler",
"verbatimModuleSyntax": true,
"resolveJsonModule": true,
"allowImportingTsExtensions": true,
"isolatedModules": true,
/* type checking */
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true
},
"include": ["docs", "theme", "rspress.config.ts"],
"mdx": {
"checkMdx": true
}
}