mdi : koodin upottaminen markdowniin / versionumero / markdown ...

Esipuhe

On yleinen vaatimus upottaa versionumerot ja demokoodi osoitteeseen readme.md.

Markkinoilla on joitakin vastaavia työkaluja, mutta ne eivät toimi hyvin. Niinpä kirjoitin sellaisen itse (suoritettavan tiedoston koko 256 KB).

Toiminnallisuus on sellainen, että jos kirjoitat markdown-koodiin lausekkeen kuten > ./demo.js, koodi upotetaan, ja tuloksena oleva sisältö näkyy alla olevassa kuvakaappauksessa:

Vaihtoehtoisesti voit kääntää automaattisesti kiinasta englanniksi ja esittää sen samassa readme.md -tiedostossa, kun käytät markdown-käännöstyökalua, jonka kirjoitin deepl:n pohjalta.

Käyttäjäkokemuksesta tulee erittäin hyvä, kun github readme -julkaisun yläosassa (alla) on tekstin sisäinen ankkuripiste, jota napsauttamalla voi siirtyä ohjeiden eri kieliversioihin.

Asennus

Lataa githubista tai cargo install mdi

Koodikannan osoite

Käytä

mdi [dir]

Se etsii hakemistosta xxx.mdi.md ja korvaa > ./xxx.rs upotetulla koodisisällöllä ja antaa sen osoitteeseen xxx.md.

Jos upotus on markdown-tiedosto, se renderöi viittaukset siihen rekursiivisesti.

Tutustu demotiedostoon readme.mdi.md