mdi : încorporarea codului în markdown / număr de versiune / markdown ...
Prefață
Includerea numerelor de versiune și a codului demo în readme.md este o cerință foarte frecventă.
Există unele instrumente similare pe piață, dar acestea nu funcționează bine. Așa că am scris unul eu însumi (dimensiunea fișierului executabil 256 KB).
Funcționalitatea este de așa natură încât scrierea unei declarații precum > ./demo.js în markdown va încorpora codul, iar conținutul rezultat este prezentat în captura de ecran de mai jos :
În plus, cu ajutorul instrumentului de traducere markdown bazat pe deepl pe care l-am scris, este posibilă traducerea și redarea automată a limbilor chineză și engleză în același fișier readme.md.
Experiența utilizatorului va fi foarte bună, cu un punct de ancorare în text în partea de sus a textului din github readme (mai jos), pe care se poate face clic pentru a trece la diferitele versiuni lingvistice ale instrucțiunilor.
Instalare
Descărcați de pe github sau cargo install mdi
Utilizați
mdi [dir]
Acesta va căuta în directorul xxx.mdi.md și va înlocui > ./xxx.rs cu conținutul codului încorporat și îl va trimite la xxx.md.
În cazul în care fișierul încorporat este un fișier markdown, se vor face referințe la acesta în mod recursiv.
Vizualizați fișierul demo readme.mdi.md