mdi : inserir código em markdown / número de versão / markdown ...

Prefácio

Incorporar números de versão e código de demonstração em readme.md é um requisito muito comum.

Existem algumas ferramentas semelhantes no mercado, mas não funcionam bem. Assim, eu próprio escrevi um (ficheiro executável tamanho 256 KB).

A funcionalidade é tal que escrever uma declaração como > ./demo.js em markdown incorporará o código, e o conteúdo resultante é mostrado na imagem de ecrã abaixo :

Em alternativa, com a ferramenta de tradução de markdown que escrevi com base em deepl, pode traduzir automaticamente do chinês para o inglês e apresentá-lo no mesmo ficheiro readme.md.

A experiência do utilizador será muito boa com um ponto de âncora em texto no topo da leitura do github (em baixo), que pode ser clicado para saltar para as várias versões linguísticas das instruções.

Instalação

Descarregar do github ou cargo install mdi

Endereço da base de código

Utilização

mdi [dir]

Pesquisará o directório xxx.mdi.md e substituirá > ./xxx.rs pelo conteúdo do código incorporado e enviá-lo-á para xxx.md.

Se a cravação for um ficheiro de remarcação para baixo, fará referências recorrentes ao mesmo.

Ver o ficheiro de demonstração readme.mdi.md