mdi : Code in Markdown einbetten / Versionsnummer / Markdown ...
Vorwort
Es ist eine gängige Anforderung, Versionsnummern und Democode in readme.md
einzubetten.
Es gibt einige ähnliche Tools auf dem Markt, aber sie funktionieren nicht gut. Also habe ich selbst eines geschrieben (Größe der ausführbaren Datei 256 KB).
Die Funktionalität ist so, dass eine Anweisung wie > ./demo.js
in Markdown geschrieben wird, um den Code einzubetten, und der resultierende Inhalt wird in der Abbildung unten gezeigt:
Alternativ können Sie mit dem Markdown-Übersetzungstool, das ich auf der Grundlage von deepl geschrieben habe, automatisch vom Chinesischen ins Englische übersetzen und es in derselben readme.md
Datei präsentieren.
Die Benutzerfreundlichkeit wird durch einen In-Text-Ankerpunkt oben in der Github-Readme (siehe unten), der angeklickt werden kann, um zu den verschiedenen Sprachversionen der Anleitungen zu gelangen, sehr gut sein.
Einrichtung
Download von github oder cargo install mdi
Verwenden Sie
mdi [dir]
Er durchsucht das Verzeichnis xxx.mdi.md
und ersetzt > ./xxx.rs
durch den eingebetteten Codeinhalt und gibt ihn in xxx.md
aus.
Handelt es sich bei der Einbettung um eine Markdown-Datei, werden Verweise auf diese Datei rekursiv dargestellt.
Lesen Sie die Demodatei readme.mdi.md