SpecDown

Chia sẻ & Chế độ xem

Chia sẻ bất kỳ tài liệu nào qua link — người đọc không cần tài khoản. Chế độ xem render Markdown của bạn đẹp mắt với hỗ trợ đầy đủ sơ đồ Mermaid.

Để chia sẻ tài liệu:

  1. Mở tài liệu trong editor.
  2. Nhấn nút Share trên toolbar phía trên.
  3. Chọn loại chia sẻ (xem bên dưới) và nhấn Create link.
  4. Sao chép link đã tạo và gửi cho người xem.

Link chia sẻ có dạng: https://specdown.app/share/abc123xyz

Các loại chia sẻ

Công khai

Bất kỳ ai có link đều có thể đọc tài liệu. Không cần xác thực. Mặc định cho mọi gói.

Bảo vệ bằng mật khẩu

Pro

Người xem phải nhập mật khẩu trước khi xem. Phù hợp cho bên ngoài hoặc bản nháp.

Link hết hạn

Pro

Link tự động vô hiệu sau ngày bạn chỉ định. Phù hợp cho đánh giá có thời hạn.

Giao diện chế độ xem

Chế độ chia sẻ hiển thị tài liệu của bạn với:

  • Markdown đã render với code block có tô sáng cú pháp
  • Sơ đồ Mermaid tương tác
  • Cây file thu gọn hiển thị cấu trúc dự án
  • Breadcrumb điều hướng giữa các tài liệu
  • Mục lục cho tài liệu dài
  • Chuyển đổi chế độ tối / sáng
  • Link nội bộ hoạt động: mọi link trong Markdown trỏ tới doc khác cùng project sẽ điều hướng ngay trong session share — click [Spec 001](/srs/SPEC-001) hoặc wiki link [[/srs/SPEC-001]] sẽ chuyển doc đang xem mà không reload share.

Share file HTML

Khi share một tài liệu .html riêng lẻ (hoặc file đính kèm .html cũ), URL share sẽ trả về chính HTML thô làm toàn bộ trang — không header SpecDown, không khung bao, không iframe. URL share hoạt động như thể bạn đang host HTML đó trực tiếp.

  • Share có mật khẩu thì hiện cổng nhập pass trước; sau khi pass đúng, URL phục vụ HTML thô y như vậy.
  • Script trong HTML chạy ở origin sandbox (qua HTTP header CSP) nên không đọc được cookie SpecDown hay gọi API bằng session người xem.
  • File HTML nằm trong share project / folder vẫn giữ chrome SpecDown bình thường để cây file dùng được; chỉ share single-target HTML mới trả HTML thô.
  • Khi xem một tài liệu HTML hoặc file đính kèm HTML cũ trong share project / folder, khung xem giờ chiếm trọn phần còn lại của màn hình ngay lần đầu, không còn mở ra ở một độ cao cố định ngắn nữa.

Bình luận trong chế độ xem

Tính năng bình luận luôn sẵn sàng trong chế độ xem — bạn không cần bật mode gì trước. Cứ bôi đen đoạn văn bất kỳ trong tài liệu, một huy hiệu Comment nổi sẽ hiện ngay cạnh vùng vừa chọn; bấm vào đó để mở luồng thảo luận gắn với đoạn văn ấy.

  • Icon chat trên header share giờ chỉ dùng để đóng/mở sidebar bình luận. Nó không còn bật / tắt tính năng bình luận nữa.
  • Sidebar mặc định đóng để bài viết được hiển thị với chiều rộng tối đa. Lựa chọn mở/đóng cuối cùng của người xem được nhớ trong trình duyệt.
  • Bấm huy hiệu Comment nổi khi sidebar đang đóng sẽ tự động mở sidebar và đưa con trỏ vào ô soạn.
  • Share public hoặc unlocked chấp nhận bình luận từ người xem ẩn danh; share private yêu cầu người xem phải đăng nhập.

Nút Chỉnh sửa

Chế độ chia sẻ hiển thị nút Edit ở góc trên bên phải. Hành vi phụ thuộc vào quan hệ của người xem với dự án:

Người xemHành vi nút Edit
Chưa đăng nhậpChuyển hướng đến /login
Đã đăng nhập, có vai trò Editor/Admin/OwnerMở tài liệu trong editor
Đã đăng nhập, không có quyền truy cập dự ánHiển thị hộp thoại fork/yêu cầu truy cập

Fork tài liệu

Nếu bạn không có quyền chỉnh sửa tài liệu được chia sẻ, bạn có thể Fork. Fork sao chép tài liệu vào dự án của bạn, nơi bạn có thể thoải mái chỉnh sửa.

Trường hợp sử dụng: Nhà cung cấp chia sẻ mẫu spec. Nhóm của bạn fork vào dự án riêng và tùy chỉnh mà không ảnh hưởng bản gốc.

Mở hộp thoại Share bất kỳ lúc nào để:

  • Xem tất cả link chia sẻ đang hoạt động cho tài liệu
  • Sao chép hoặc thu hồi từng link
  • Cập nhật mật khẩu hoặc ngày hết hạn cho link hiện có
Thu hồi link làm vô hiệu hóa ngay lập tức. Ai có URL cũ sẽ thấy trang "không tìm thấy".

Công cụ tìm kiếm & lập chỉ mục

Trang chia sẻ không được Google hay công cụ tìm kiếm khác lập chỉ mục. Mỗi link chia sẻ (công khai, có mật khẩu hoặc riêng tư) đều có thẻ noindex, nên URL chỉ tới được người bạn gửi link. Nếu muốn tài liệu xuất hiện trong tìm kiếm, hãy publish nó qua website hoặc blog công khai của bạn.

Sẵn sàng bắt đầu?

Viết spec như code. Đồng bộ với Git. Chia sẻ với team.