mdi : code insluiten in markdown / versienummer / markdown ...
Voorwoord
Het is een gebruikelijke vereiste om versienummers en democode in readme.md
in te sluiten.
Er zijn soortgelijke hulpmiddelen op de markt, maar die werken niet goed. Dus heb ik er zelf een geschreven (grootte uitvoerbaar bestand 256 KB).
De functionaliteit is zodanig dat het schrijven van een verklaring als > ./demo.js
in markdown de code zal insluiten, en de resulterende inhoud wordt getoond in de schermafbeelding hieronder :
Als alternatief, met de markdown vertaaltool die ik schreef op basis van deepl, kun je automatisch vertalen van Chinees naar Engels en het presenteren in hetzelfde readme.md
bestand.
De gebruikerservaring zal zeer goed zijn met een in-tekst ankerpunt bovenaan de github readme (hieronder), waarop geklikt kan worden om naar de verschillende taalversies van de instructies te springen.
Installatie
Downloaden van github of cargo install mdi
Gebruik
mdi [dir]
Het zal de directory xxx.mdi.md
doorzoeken en > ./xxx.rs
vervangen door de inhoud van de ingesloten code en deze uitvoeren naar xxx.md
.
Als het insluiten een markdown bestand is, zullen verwijzingen ernaar recursief worden weergegeven.
Bekijk het demo bestand readme.mdi.md