mdi : вграждане на код в markdown / номер на версията / markdown ...
Предговор
Често срещано изискване е да се вграждат номера на версии и демо код в readme.md.
На пазара има някои подобни инструменти, но те не работят добре. Затова сам написах такъв (размер на изпълнимия файл 256 KB).
Функционалността е такава, че записването на изявление като > ./demo.js в markdown ще вгради кода, а полученото съдържание е показано на скрийншота по-долу :
Алтернативно, с инструмента за превод на markdown, който написах на базата на deepl, китайският и английският език могат да бъдат автоматично преведени и визуализирани в един и същ файл readme.md.
Потребителското изживяване ще бъде много добро, като в горната част на резюмето на github (по-долу) ще има точка за закрепване в текста, върху която може да се кликне, за да се премине към различните езикови версии на инструкциите.
Инсталация
Изтегляне от github или cargo install mdi
Използвайте
mdi [dir]
Той ще претърси директорията xxx.mdi.md и ще замени > ./xxx.rs със съдържанието на вградения код и ще го изведе на xxx.md.
Ако вграденото съдържание е файл markdown, то ще визуализира рекурсивно препратки към него.
Вижте демо файла readme.mdi.md