Cấu hình đường dẫn tài liệu

Đường dẫn tài liệu (Documentation Path) xác định vị trí của tài liệu trong repository GitHub của bạn.

Tự động phát hiện

Khi bạn import repository, hệ thống sẽ tự động tìm kiếm file book.json và gợi ý đường dẫn tài liệu.

Cách thức hoạt động

Tìm kiếm file book.json trong repository
Nếu tìm thấy, sử dụng thư mục chứa file đó làm đường dẫn mặc định
Nếu nhiều file book.json tồn tại, ưu tiên file gần thư mục gốc nhất

Ví dụ

Vị trí book.json	Đường dẫn phát hiện
`book.json`	`/` (thư mục gốc)
`docs/book.json`	`docs/`
`packages/docs/book.json`	`packages/docs/`

Đường dẫn cơ bản

Đường dẫn	Mô tả
`/`	Tài liệu nằm ở thư mục gốc của repository
`docs/`	Tài liệu nằm trong thư mục `docs`
`documentation/`	Tài liệu nằm trong thư mục `documentation`

Cấu hình trong monorepo

Nếu bạn sử dụng monorepo với nhiều package, bạn có thể chỉ định đường dẫn cụ thể:

packages/docs/           # Tài liệu nằm trong package docs
apps/documentation/      # Tài liệu nằm trong app documentation
services/api/docs/       # Tài liệu cho một service cụ thể

Ví dụ monorepo

my-monorepo/
├── packages/
│   ├── frontend/
│   ├── backend/
│   └── docs/           # <- Đặt Documentation Path: packages/docs/
│       ├── SUMMARY.md
│       ├── README.md
│       └── guides/
├── apps/
└── package.json

Thay đổi đường dẫn

Vào Settings của repository
Trong phần GitHub Connection, cập nhật trường Documentation Path
Nhấn Save Settings
Build lại để áp dụng thay đổi

Lưu ý

Đường dẫn phải chứa file SUMMARY.md
Đường dẫn phải kết thúc bằng dấu / hoặc để trống cho thư mục gốc
Nếu đường dẫn không tồn tại, build sẽ thất bại

Cấu trúc yêu cầu

Tại vị trí đường dẫn, bạn cần có ít nhất:

SUMMARY.md      # Bắt buộc - Mục lục của tài liệu
README.md       # Khuyến nghị - Trang chính

Ví dụ SUMMARY.md

# Mục lục

* [Giới thiệu](README.md)
* [Cài đặt](installation.md)
* [Hướng dẫn sử dụng](usage/README.md)
  * [Tính năng 1](usage/feature1.md)
  * [Tính năng 2](usage/feature2.md)
* [API Reference](api/README.md)