Lint Markdown
Controllate Markdown per individuare problemi di stile e sintassi con markdownlint, il linter usato da molti editor e pipeline CI. Incollate un documento per visualizzare ogni segnalazione con la riga, una regola come MD001 e la relativa spiegazione. Facoltativamente, potete ottenere una versione corretta in cui markdownlint risolve ciò che può, ad esempio righe vuote, marcatori di elenco e spaziatura.
Domande frequenti
Quali regole vengono controllate?
Tutte le regole attivate per impostazione predefinita da markdownlint, da MD001 (i livelli delle intestazioni aumentano di uno) alle regole per elenchi, righe vuote, blocchi di codice, link ed enfasi. La regola sulla lunghezza delle righe MD013 è disattivata, a meno che non impostiate una lunghezza massima.
Come posso disattivare le regole?
Elencatele nel campo delle regole da disattivare, separate da virgole o spazi, usando numeri come MD033 o nomi come no-inline-html. Funzionano anche i commenti in linea nel documento, come <!-- markdownlint-disable MD033 -->.
A cosa serve l'opzione di correzione?
Applica le correzioni automatiche offerte da markdownlint, ad esempio aggiunge righe vuote intorno alle intestazioni e agli elenchi, rende coerenti i marcatori di elenco o rimuove gli spazi finali, quindi mostra il documento corretto. Le segnalazioni senza correzione automatica restano da sistemare manualmente.
Quale versione di markdownlint viene usata?
markdownlint 0.42.0, la libreria su cui si basano l'estensione markdownlint per Visual Studio Code e markdownlint-cli2. Con la stessa versione e la configurazione predefinita, segnalano gli stessi problemi.
Perché segnala la mia prima intestazione?
La regola MD041 richiede che un documento inizi con un'intestazione di primo livello, mentre MD025 ne consente una sola. Se la vostra piattaforma aggiunge già il titolo, disattivate queste regole per il documento.
Quante segnalazioni vengono mostrate?
Viene sempre riportato il totale e le prime 500 segnalazioni sono elencate nella tabella. Correggete le prime e ripetete il controllo per visualizzare le altre.