mdi : incorporation de code dans markdown / numéro de version / markdown ...
Préface
Il est courant d'intégrer des numéros de version et un code de démonstration dans readme.md
.
Il existe des outils similaires sur le marché, mais ils ne fonctionnent pas bien. J'en ai donc écrit un moi-même (taille du fichier exécutable 256 KB).
La fonctionnalité est telle que l'écriture d'une déclaration comme > ./demo.js
en markdown intégrera le code, et le contenu résultant est montré dans la capture d'écran ci-dessous :
Sinon, avec l'outil de traduction markdown que j'ai écrit sur la base de deepl, vous pouvez traduire automatiquement du chinois à l'anglais et le présenter dans le même fichier readme.md
.
L'expérience utilisateur sera très bonne grâce à un point d'ancrage en haut du readme de github (ci-dessous), sur lequel il est possible de cliquer pour accéder aux différentes versions linguistiques des instructions.
Installation
Télécharger depuis github ou cargo install mdi
Utilisez
mdi [dir]
Il cherchera dans le répertoire xxx.mdi.md
et remplacera > ./xxx.rs
par le contenu du code incorporé et l'enverra à xxx.md
.
Si l'intégration est un fichier markdown, les références à ce fichier seront rendues de manière récursive.
Voir le fichier de démonstration readme.mdi.md