mdi : incorporare il codice in markdown / numero di versione / markdown ...

Prefazione

È un requisito comune incorporare i numeri di versione e il codice demo in readme.md.

Esistono strumenti simili sul mercato, ma non funzionano bene. Così ne ho scritto uno io stesso (dimensione del file eseguibile 256 KB).

La funzionalità è tale che la scrittura di un'istruzione come > ./demo.js in markdown incorporerà il codice e il contenuto risultante è mostrato nella schermata sottostante:

In alternativa, con lo strumento di traduzione markdown che ho scritto sulla base di deepl, è possibile tradurre automaticamente dal cinese all'inglese e presentarlo nello stesso file readme.md.

L'esperienza dell'utente sarà molto buona grazie a un punto di ancoraggio nel testo all'inizio del readme di github (sotto), su cui si può cliccare per passare alle varie versioni linguistiche delle istruzioni.

Installazione

Scaricare da github o cargo install mdi

Indirizzo della base di codice

Utilizzo

mdi [dir]

Cercherà nella directory xxx.mdi.md e sostituirà > ./xxx.rs con il contenuto del codice incorporato e lo invierà a xxx.md.

Se l'embed è un file markdown, renderà ricorsivamente i riferimenti ad esso.

Visualizza il file dimostrativo readme.mdi.md