mdi : incrustación de código en markdown / número de versión / markdown ...

Prefacio

Es un requisito común incrustar los números de versión y el código de demostración en readme.md.

Hay algunas herramientas similares en el mercado, pero no funcionan bien. Así que escribí uno yo mismo (archivo ejecutable de 256 KB).

La funcionalidad es tal que escribir una declaración como > ./demo.js en markdown incrustará el código, y el contenido resultante se muestra en la captura de pantalla de abajo :

Alternativamente, con la herramienta de traducción markdown que escribí basada en deepl, el chino y el inglés pueden ser traducidos y renderizados automáticamente en el mismo archivo readme.md.

La experiencia del usuario será muy buena con un punto de anclaje en el texto en la parte superior del readme de github (abajo), en el que se puede hacer clic para saltar a las distintas versiones lingüísticas de las instrucciones.

Instalación

Descargar desde github o cargo install mdi

Dirección del código base

Utilice

mdi [dir]

Buscará en el directorio xxx.mdi.md y reemplazará > ./xxx.rs con el contenido del código incrustado y lo enviará a xxx.md.

Si el archivo incrustado es un archivo markdown, se renderizarán recursivamente las referencias al mismo.

Ver el archivo de demostración readme.mdi.md