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