Skip to content

Commit 87aad40

Browse files
committed
update README
1 parent 4d432dd commit 87aad40

File tree

3 files changed

+4406
-8124
lines changed

3 files changed

+4406
-8124
lines changed

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,31 @@
1-
# Rspress Website
1+
# GenUI Book
22

3-
## Setup
3+
**👷The document is under rapid construction... Expected to be completed on January 30, 2025**
44

5-
Install the dependencies:
5+
## Guide
66

7-
```bash
8-
npm install
9-
```
7+
- [x] overview
8+
- [x] introduction
9+
- [x] tools
10+
- [x] plugins
1011

11-
## Get Started
12+
## Tutorial
1213

13-
Start the dev server:
14+
- [x] overview
15+
- [x] quick-start
16+
- [x] ract
17+
- [x] project-structure
18+
- [ ] template
19+
- [ ] style
20+
- [ ] script
1421

15-
```bash
16-
npm run dev
17-
```
22+
## Config
1823

19-
Build the website for production:
2024

21-
```bash
22-
npm run build
23-
```
25+
## Components
2426

25-
Preview the production build locally:
27+
## Examples
2628

27-
```bash
28-
npm run preview
29-
```
29+
## Tools
30+
31+
## API

0 commit comments

Comments
 (0)