mdi : koodi sisseehitamine markdowni / versiooni number / markdown ...
Eessõna
See on tavaline nõue, et readme.md
peab sisaldama versiooni numbreid ja demokoodi.
Turul on mõned sarnased vahendid, kuid need ei tööta hästi. Nii et ma kirjutasin ise ühe (käivitatava faili suurus 256 KB).
Funktsionaalsus on selline, et kirjutades markdownis avalduse nagu > ./demo.js
, põimib see koodi ja saadud sisu on näidatud alloleval ekraanipildil :
Alternatiivina saab hiina ja inglise keele automaatselt tõlkida ja esitada samas readme.md
failis, kasutades selleks minu poolt deepl põhjal kirjutatud markdown-tõlkevahendit.
Kasutajakogemus on väga hea, sest githubi readme'i ülaosas on tekstisisene ankurduspunkt (allpool), millele klõpsates saab hüpata juhiste eri keeleversioonidesse.
Paigaldamine
Lae alla githubist või cargo install mdi
Kasutage
mdi [dir]
See otsib kataloogi xxx.mdi.md
ja asendab > ./xxx.rs
sisseehitatud koodi sisuga ning väljastab selle aadressile xxx.md
.
Kui embed on markdown-fail, siis teeb see rekursiivselt viited sellele failile.
Vaata demofaili readme.mdi.md