mdi : kód beágyazása markdownba / verziószám / markdown ...

Előszó

Gyakori követelmény a verziószámok és a demókód beágyazása a readme.md oldalon.

Vannak hasonló eszközök a piacon, de ezek nem működnek jól. Ezért írtam egyet magamnak (a futtatható fájl mérete 256 KB).

A funkcionalitás olyan, hogy egy olyan utasítás írása, mint a > ./demo.js a markdownban beágyazza a kódot, és a kapott tartalom az alábbi képernyőképen látható:

Alternatív megoldásként a deepl alapján írt markdown fordítóeszközzel automatikusan lefordíthat kínairól angolra, és ugyanabban a readme.md fájlban mutathatja be.

A felhasználói élmény nagyon jó lesz a github readme tetején található szöveges horgonyponttal (alul), amelyre kattintva az utasítások különböző nyelvi változataihoz lehet ugrani.

Telepítés

Letöltés a githubról vagy cargo install mdi

Kódbázis címe

Használja a címet.

mdi [dir]

A program megkeresi a xxx.mdi.md könyvtárat, és a > ./xxx.rs könyvtárat a beágyazott kód tartalmával helyettesíti, majd azt a xxx.md könyvtárba írja ki.

Ha a beágyazás egy markdown fájl, akkor rekurzívan rendereli az arra való hivatkozásokat.

A readme.mdi.md demó fájl megtekintése