mdi : bädda in kod i markdown / versionsnummer / markdown ...

Förord

Att bädda in versionsnummer och demokod i readme.md är ett mycket vanligt krav.

Det finns några liknande verktyg på marknaden, men de fungerar inte bra. Så jag skrev ett själv (storlek på 256 KB).

Funktionaliteten är sådan att om du skriver ett uttalande som > ./demo.js i markdown kommer koden att bäddas in, och det resulterande innehållet visas i skärmdumpen nedan :

Med det deepl-baserade markdown-översättningsverktyg som jag har skrivit är det dessutom möjligt att automatiskt översätta och återge kinesiska och engelska i samma readme.md -fil.

Användarupplevelsen kommer att bli mycket bra med en ankarpunkt i texten högst upp i Githubs Readme (nedan), som man kan klicka på för att komma till de olika språkversionerna av instruktionerna.

Installation

Ladda ner från github eller cargo install mdi

Adress till kodbasen

Använd

mdi [dir]

Den söker i katalogen xxx.mdi.md och ersätter > ./xxx.rs med det inbäddade kodinnehållet och skickar det till xxx.md.

Om inbäddningen är en markdown-fil kommer referenser till den att återges rekursivt.

Visa demofilen readme.mdi.md