Tài liệu & Thư mục

Sắp xếp đặc tả của bạn thành cấu trúc phân cấp logic bằng tài liệu và thư mục.

Tạo tài liệu

Để tạo tài liệu mới:

1. Trong cây file, nhấn nút New Document (+ icon) hoặc chuột phải vào thư mục.
2. Nhập tiêu đề. SpecDown tự động tạo slug từ tiêu đề.
3. Nhấn Create. Tài liệu mở ngay trong editor.

Qua CLI:

specdown new "Authentication Guide"
# Trong thư mục:
specdown new "OAuth Flow" --parent guides

Tạo thư mục

Thư mục là container — chứa tài liệu và thư mục khác nhưng không có nội dung Markdown riêng.

Để tạo thư mục, nhấn icon thư mục+ trong header cây file, hoặc dùng CLI:

specdown new "API Reference" --folder

📁 guides/
  📁 api/
    📄 authentication
    📄 endpoints
  📁 tutorials/
    📄 getting-started
📄 changelog

Sắp xếp thứ tự

Kéo-thả tài liệu và thư mục trong cây file để sắp xếp lại. Thứ tự được lưu trong trường sort_order và phản ánh trong share view.

Trong một thư mục, thứ tự sắp xếp: thư mục trước, rồi theo sort_order, rồi theo bảng chữ cái.

Đổi tên

Double-click tên tài liệu hoặc thư mục trong cây file để đổi tên inline. Đổi tên hoạt động cho mọi loại — tài liệu Markdown, tài liệu HTML và thư mục.

Phần mở rộng được giữ lại tự động. Đổi tên my-page.html thành landing sẽ ra landing.html — bạn không cần gõ lại .html. Để chuyển kiểu file (hiếm), hãy gõ phần mở rộng mới trong tên mới, ví dụ landing.md.

Đổi tên thư mục sẽ cập nhật path prefix của toàn bộ descendant trong cùng một thao tác, các liên kết bên trong dự án vẫn hoạt động mà không cần sửa thêm.

Xóa tài liệu

SpecDown dùng soft delete — xóa tài liệu chỉ đặt timestamp deleted_atchứ không xóa vĩnh viễn. Giúp tránh mất dữ liệu do sơ ý.

Để xóa:

• Chuột phải tài liệu trong cây file → Delete
• Qua CLI: specdown rm guides/api/authentication

File đính kèm của dự án

Ngoài tài liệu và thư mục, cây file còn có thể chứa file đính kèm của dự án. Đây là các file không phải tài liệu, có path riêng trong project và mở ở chế độ preview.

• Dùng nút upload trong header cây file để nhập file hoặc cả thư mục
• File .md, .html, và .htm sẽ thành tài liệu có thể chỉnh sửa
• PDF, ảnh, video, CSV, và file code/text khác sẽ thành attachment
• Attachment xuất hiện ngay trong cùng cây file và có thể được nhúng trong Markdown bằng [@/path/to/file]

Giới hạn tài liệu