Symboltransklusion
Indlejr levende kode i din dokumentation ved navn, ikke linjenummer. Rediger kilden, din dokumentation opdateres automatisk.
# Indlejr en funktion ved navn
![[auth.py#validate_token]]Ohai udtrækker validate_token funktionen fra auth.py og renderer den inline med syntaksfremhævning. Når funktionen ændres, opdateres din dokumentation automatisk.
Hvorfor det betyder noget
Traditionel dokumentation rådner. Du kopierer kode ind i markdown, koden udvikler sig, og pludselig lyver din dokumentation for dig. Symboltransklusion løser dette ved at behandle dine kildefiler som den eneste kilde til sandhed.
I modsætning til linjenummer-referencer der går i stykker ved hver refaktorering, bruger symboltransklusion AST-parsing til at finde kode ved dens faktiske navn—funktioner, klasser, structs, konstanter. Omdøb en fil, reorganiser din kode, tilføj nye metoder—så længe symbolnavnet eksisterer, forbliver din dokumentation præcis.
Anvendelsesområder
API-dokumentation
Referer til dine faktiske funktionssignaturer, ikke håndskrevne tilnærmelser der driver ud af synk.
Architecture Decision Records
Indlejr den kode du diskuterer i ADR'er. Eksemplerne forbliver aktuelle efterhånden som kodebasen udvikler sig.
Onboarding-guider
Vis nye udviklere hvordan authentication fungerer med levende kode de kan stole på matcher repo'et.
Kodegennemgange
Træk specifikke funktioner ind i et markdown-resumé til asynkron gennemgang og diskussion.
Vejledninger
Gennemgå rigtige implementeringer. Læsere kan stole på at kodeeksemplerne altid er opdaterede.
Runbooks
Indlejr den præcise konfiguration eller script som ops skal referere til under incidents.
Understøttede sprog
30+ sprog via Tree-sitter AST-parsing. Selv JSON-nøgler, YAML-stier og TOML-tabeller.
Klar til at prøve dokumentation der aldrig bliver forældet?
Download til Mac