mdi : indlejring af kode i markdown / versionsnummer / markdown ...

Forord

Det er et almindeligt krav at indlejre versionsnumre og demokode i readme.md.

Der findes nogle lignende værktøjer på markedet, men de fungerer ikke godt. Så jeg skrev selv en (eksekverbar filstørrelse 256 KB).

Funktionaliteten er sådan, at hvis du skriver en erklæring som > ./demo.js i markdown, vil koden blive indlejret, og det resulterende indhold vises i skærmbilledet nedenfor :

Alternativt kan man med det markdown-oversættelsesværktøj, som jeg har skrevet baseret på deepl, automatisk oversætte og gengive kinesisk og engelsk i den samme readme.md -fil.

Brugeroplevelsen vil være meget god med et ankerpunkt i teksten øverst i github-læsemidlet (nedenfor), som man kan klikke på for at springe til de forskellige sprogversioner af vejledningen.

Installation

Download fra github eller cargo install mdi

Kodebase-adresse

Brug

mdi [dir]

Den vil søge i mappen xxx.mdi.md og erstatte > ./xxx.rs med den indlejrede kode og sende den til xxx.md.

Hvis indlejringen er en markdown-fil, vil den rekursivt gengive henvisninger til den.

Se demofilen readme.mdi.md