Hướng dẫn cài đặt

• Trên máy local chạy win
• dùng gói pnpm

Cài đặt trên Local

Tạo ra thư mục dự án (tùy theo bạn) sau đó truy cập vào thư mục

md docs
cd docs

Thêm gói vitepress

pnpm add -D vitepress

Khởi tạo vitepress

pnpm vitepress init

Bạn phải điền các thông số tương đối như sau:

• Nơi chứa dữ liệu, thường chọn là docs
• Tên trang web
• Mô tả trang Các phần còn lại bạn để mặc định

┌  Welcome to VitePress!
│
◇  Where should VitePress initialize the config?
│  ./docs
│
◇  Where should VitePress look for your markdown files?
│  ./docs
│
◇  Site title:
│  My Awesome Project
│
◇  Site description:
│  A VitePress Site
│
◇  Theme:
│  Default Theme
│
◇  Use TypeScript for config and theme files?
│  Yes
│
◇  Add VitePress npm scripts to package.json?
│  Yes
│
◇  Add a prefix for VitePress npm scripts?
│  Yes
│
◇  Prefix for VitePress npm scripts:
│  docs
│
└  Done! Now run pnpm run docs:dev and start writing.

Cấu trúc thư mục

Sau khi khởi tạo init, bạn sẽ được các thư mục sau

.
├─ docs
│  ├─ .vitepress
│  │  └─ config.mts
│  ├─ api-examples.md
│  ├─ markdown-examples.md
│  └─ index.md
└─ package.json

Trong đó:

• config.mts là file cấu hình quant trọng nhất, nơi bạn bổ sung toàn bộ các tính năng
• index.md là file hiển thị trang chủ của bạn.
• package.json mô tả các thư viện, gói cài đặt

Course / Guide / Blog

Đây là các dạng tài liệu bạn sử dụng Trong trong thư mục docs:

• Courses nếu tài liệu là các khóa học
• Guides nếu tài liệu là hướng dẫn
• Blog nếu tài liệu là các bài viết

Nếu có ít tài liệu, không cần tạo thư mục sub con. Trực tiếp tạo dưới docs là được.

Pages

Tương tự như trên, page là trang như:

• contact, about, team ..
• trang index luôn mặc định nằm ở docs.

Có thể tạo một thư mục pages gom các trang trên lại (trừ index) để đỡ rối. Nhưng nếu ít trang thì không cần thiết tạo thư mục pages