Transklusi Simbol
Tulis wiki-link ke nama fungsi dan badan fungsi dirender di tempat, dengan syntax highlighting, ditarik langsung dari file sumber Anda. Ekstraksi berbasis AST bekerja di 40+ bahasa: Python, Swift, JavaScript, TypeScript, Go, Rust, Java, C, C++, Ruby, Kotlin, dan lainnya. Edit sumber, dokumen diperbarui.
# Embed fungsi berdasarkan nama
![[auth.py#validate_token]]Ohai mengekstrak fungsi validate_token dari auth.py dan merendernya secara inline dengan syntax highlighting. Ketika fungsi berubah, dokumentasi Anda diperbarui secara otomatis.
Mengapa penting
Dokumentasi tradisional mudah usang. Anda copy-paste kode ke dalam markdown, kode berkembang, dan tiba-tiba dokumentasi Anda menjadi tidak akurat. Transklusi simbol memperbaiki ini dengan memperlakukan file sumber Anda sebagai satu-satunya sumber kebenaran.
Tidak seperti referensi nomor baris yang rusak setiap kali refactor, transklusi simbol menggunakan parsing AST untuk menemukan kode berdasarkan nama sebenarnya—fungsi, class, struct, konstanta. Ubah nama file, reorganisasi kode Anda, tambahkan method baru—selama nama simbol masih ada, dokumentasi Anda tetap akurat.
Kasus Penggunaan
Dokumentasi API
Referensikan signature fungsi yang sebenarnya, bukan pendekatan yang diketik manual dan tidak sinkron.
Architecture Decision Records
Embed kode yang Anda diskusikan dalam ADR. Contohnya tetap up-to-date seiring kodebase berkembang.
Panduan Onboarding
Tunjukkan kepada developer baru bagaimana autentikasi bekerja dengan kode langsung yang bisa mereka percaya sesuai dengan repo.
Code Review
Tarik fungsi spesifik ke dalam ringkasan markdown untuk review dan diskusi asinkron.
Tutorial
Jelaskan implementasi nyata. Pembaca dapat mempercayai bahwa contoh kode selalu up-to-date.
Runbook
Embed config atau skrip yang persis seperti yang perlu direferensikan ops saat insiden.
Bahasa yang Didukung
Parsing AST Tree-sitter untuk Python, Swift, JavaScript, TypeScript, Go, Rust, Java, C, C++, Ruby, Kotlin, PHP, Scala, Haskell, OCaml, Lua, Elixir, Bash, dan lainnya — ditambah ekstraktor jalur format data untuk kunci JSON, jalur YAML, tabel TOML, jalur plist, XML, CSS, SQL, dan teks biasa. Total 40+ format.
Siap mencoba dokumentasi yang tidak pernah usang?
Unduh untuk Mac