Cau hinh duong dan tai lieu

Duong dan tai lieu (Documentation Path) xac dinh vi tri cua tai lieu trong repository GitHub cua ban.

Tu dong phat hien

Khi ban import repository, he thong se tu dong tim kiem file book.json va goi y duong dan tai lieu.

Cach thuc hoat dong

Tim kiem file book.json trong repository
Neu tim thay, su dung thu muc chua file do lam duong dan mac dinh
Neu nhieu file book.json ton tai, uu tien file gan thu muc goc nhat

Vi du

Vi tri book.json	Duong dan phat hien
`book.json`	`/` (thu muc goc)
`docs/book.json`	`docs/`
`packages/docs/book.json`	`packages/docs/`

Duong dan co ban

Duong dan	Mo ta
`/`	Tai lieu nam o thu muc goc cua repository
`docs/`	Tai lieu nam trong thu muc `docs`
`documentation/`	Tai lieu nam trong thu muc `documentation`

Cau hinh trong monorepo

Neu ban su dung monorepo voi nhieu package, ban co the chi dinh duong dan cu the:

packages/docs/           # Tai lieu nam trong package docs
apps/documentation/      # Tai lieu nam trong app documentation
services/api/docs/       # Tai lieu cho mot service cu the

Vi du monorepo

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

Thay doi duong dan

Vao Settings cua repository
Trong phan GitHub Connection, cap nhat truong Documentation Path
Nhan Save Settings
Build lai de ap dung thay doi

Luu y

Duong dan phai chua file SUMMARY.md
Duong dan phai ket thuc bang dau / hoac de trong cho thu muc goc
Neu duong dan khong ton tai, build se that bai

Cau truc yeu cau

Tai vi tri duong dan, ban can co it nhat:

SUMMARY.md      # Bat buoc - Muc luc cua tai lieu
README.md       # Khuyen nghi - Trang chinh

Vi du SUMMARY.md

# Muc luc

* [Gioi thieu](README.md)
* [Cai dat](installation.md)
* [Huong dan su dung](usage/README.md)
  * [Tinh nang 1](usage/feature1.md)
  * [Tinh nang 2](usage/feature2.md)
* [API Reference](api/README.md)