Έλεγχος Markdown
Ελέγξτε το Markdown για προβλήματα στυλ και σύνταξης με το markdownlint, το εργαλείο ελέγχου που χρησιμοποιούν πολλοί επεξεργαστές και διοχετεύσεις CI. Επικολλήστε ένα έγγραφο και λάβετε κάθε εύρημα μαζί με τη γραμμή του, τον κανόνα, όπως το MD001, και την εξήγησή του. Προαιρετικά, λάβετε μια διορθωμένη έκδοση, στην οποία το markdownlint διορθώνει ό,τι μπορεί, όπως κενές γραμμές, δείκτες λίστας και διαστήματα.
Συχνές ερωτήσεις
Ποιοι κανόνες ελέγχονται;
Όλοι οι κανόνες που ενεργοποιεί από προεπιλογή το markdownlint, από τον MD001 (τα επίπεδα επικεφαλίδων αυξάνονται κατά ένα) έως κανόνες για λίστες, κενές γραμμές, μπλοκ κώδικα, συνδέσμους και έμφαση. Ο κανόνας μήκους γραμμής MD013 είναι απενεργοποιημένος, εκτός αν ορίσετε μέγιστο μήκος γραμμής.
Πώς απενεργοποιώ κανόνες;
Καταχωρίστε τους στο πεδίο κανόνων προς απενεργοποίηση, χωρισμένους με κόμματα ή κενά, χρησιμοποιώντας αριθμούς όπως το MD033 ή ονόματα όπως το no-inline-html. Λειτουργούν επίσης ενσωματωμένα σχόλια στο έγγραφο, όπως το <!-- markdownlint-disable MD033 -->.
Τι κάνει η επιλογή διόρθωσης;
Εφαρμόζει τις αυτόματες διορθώσεις που προσφέρει το markdownlint, όπως την προσθήκη κενών γραμμών γύρω από επικεφαλίδες και λίστες, την ομοιομορφία των δεικτών λίστας ή την αφαίρεση κενών στο τέλος γραμμών, και εμφανίζει το διορθωμένο έγγραφο. Τα ευρήματα χωρίς αυτόματη διόρθωση παραμένουν για να τα διορθώσετε με το χέρι.
Ποια έκδοση του markdownlint χρησιμοποιείται;
Το markdownlint 0.42.0, η βιβλιοθήκη πάνω στην οποία βασίζονται η επέκταση markdownlint για το Visual Studio Code και το markdownlint-cli2. Με την ίδια έκδοση και την προεπιλεγμένη διαμόρφωση, αναφέρουν τα ίδια ευρήματα.
Γιατί εμφανίζεται προειδοποίηση για την πρώτη μου επικεφαλίδα;
Ο κανόνας MD041 απαιτεί το έγγραφο να αρχίζει με επικεφαλίδα ανώτατου επιπέδου, ενώ ο MD025 επιτρέπει μόνο μία. Αν η πλατφόρμα σας προσθέτει αυτόματα τον τίτλο, απενεργοποιήστε αυτούς τους κανόνες για το έγγραφό σας.
Πόσα ευρήματα εμφανίζονται;
Αναφέρεται πάντα ο συνολικός αριθμός, ενώ τα πρώτα 500 ευρήματα εμφανίζονται στον πίνακα. Διορθώστε τα πρώτα και εκτελέστε ξανά τον έλεγχο για να δείτε τα υπόλοιπα.