Symbol-Transklusion
Schreiben Sie einen Wiki-Link zu einem Funktionsnamen, und der Funktionskörper wird an der Stelle mit Syntaxhervorhebung angezeigt, direkt aus Ihren Quelldateien gezogen. AST-gestützte Extraktion funktioniert für 40+ Sprachen: Python, Swift, JavaScript, TypeScript, Go, Rust, Java, C, C++, Ruby, Kotlin und mehr. Bearbeiten Sie die Quelle, das Dokument aktualisiert sich.
# Funktion nach Namen einbetten
![[auth.py#validate_token]]Ohai extrahiert die validate_token-Funktion aus auth.py und rendert sie inline mit Syntaxhervorhebung. Wenn sich die Funktion ändert, aktualisiert sich Ihre Dokumentation automatisch.
Warum es wichtig ist
Traditionelle Dokumentation veraltet. Sie kopieren Code in Markdown, der Code entwickelt sich weiter, und plötzlich lügt Ihre Dokumentation. Symbol-Transklusion behebt dies, indem sie Ihre Quelldateien als einzige Quelle der Wahrheit behandelt.
Im Gegensatz zu Zeilennummer-Referenzen, die bei jedem Refactoring kaputtgehen, verwendet Symbol-Transklusion AST-Parsing, um Code nach seinem tatsächlichen Namen zu finden – Funktionen, Klassen, Strukturen, Konstanten. Benennen Sie eine Datei um, organisieren Sie Ihren Code neu, fügen Sie neue Methoden hinzu – solange der Symbolname existiert, bleibt Ihre Dokumentation korrekt.
Anwendungsfälle
API-Dokumentation
Referenzieren Sie Ihre tatsächlichen Funktionssignaturen, nicht handgetippte Annäherungen, die aus dem Takt geraten.
Architecture Decision Records
Betten Sie den Code ein, den Sie in ADRs diskutieren. Die Beispiele bleiben aktuell, während sich die Codebasis entwickelt.
Onboarding-Leitfäden
Zeigen Sie neuen Entwicklern, wie Authentifizierung funktioniert, mit Live-Code, dem sie vertrauen können, dass er mit dem Repository übereinstimmt.
Code-Reviews
Ziehen Sie spezifische Funktionen in eine Markdown-Zusammenfassung für asynchrone Überprüfung und Diskussion.
Tutorials
Gehen Sie echte Implementierungen durch. Leser können darauf vertrauen, dass die Code-Beispiele immer aktuell sind.
Runbooks
Betten Sie die exakte Konfiguration oder das Skript ein, auf das Ops während Vorfällen verweisen muss.
Unterstützte Sprachen
Tree-sitter AST-Parsing für Python, Swift, JavaScript, TypeScript, Go, Rust, Java, C, C++, Ruby, Kotlin, PHP, Scala, Haskell, OCaml, Lua, Elixir, Bash und mehr — plus Datenpfad-Extraktoren für JSON-Schlüssel, YAML-Pfade, TOML-Tabellen, plist-Pfade, XML, CSS, SQL und Klartext. 40+ Formate insgesamt.
Bereit, Dokumentation auszuprobieren, die niemals veraltet?
Für Mac laden