Transclusion Ký hiệu
Nhúng mã trực tiếp vào tài liệu theo tên, không phải số dòng. Chỉnh sửa nguồn, tài liệu tự động cập nhật.
# Nhúng hàm theo tên
![[auth.py#validate_token]]Ohai trích xuất hàm validate_token từ auth.py và render inline với tô sáng cú pháp. Khi hàm thay đổi, tài liệu tự động cập nhật.
Tại sao quan trọng
Tài liệu truyền thống bị lỗi thời. Bạn copy-paste mã vào markdown, mã phát triển, và đột nhiên tài liệu của bạn đang nói dối. Transclusion ký hiệu khắc phục điều này bằng cách coi các tệp nguồn là nguồn sự thật duy nhất.
Không giống như tham chiếu số dòng bị hỏng mỗi khi refactor, transclusion ký hiệu sử dụng phân tích AST để tìm mã theo tên thực—hàm, class, struct, hằng số. Đổi tên tệp, tổ chức lại mã, thêm method mới—miễn là tên ký hiệu tồn tại, tài liệu luôn chính xác.
Trường hợp Sử dụng
Tài liệu API
Tham chiếu chữ ký hàm thực tế, không phải bản gõ tay dần lệch khỏi đồng bộ.
Hồ sơ Quyết định Kiến trúc
Nhúng mã bạn đang thảo luận trong ADR. Các ví dụ luôn cập nhật khi codebase phát triển.
Hướng dẫn Onboarding
Chỉ cho developer mới cách xác thực hoạt động với mã trực tiếp họ tin tưởng khớp với repo.
Review Mã
Lấy các hàm cụ thể vào tóm tắt markdown để review và thảo luận bất đồng bộ.
Hướng dẫn
Hướng dẫn các triển khai thực tế. Người đọc tin tưởng các ví dụ mã luôn cập nhật.
Runbook
Nhúng config hoặc script chính xác mà ops cần tham khảo trong sự cố.
Ngôn ngữ Được hỗ trợ
30+ ngôn ngữ qua phân tích AST Tree-sitter. Ngay cả khóa JSON, đường dẫn YAML và bảng TOML.
Sẵn sàng thử tài liệu không bao giờ lỗi thời?
Tải về cho Mac