Markdown belgelerinde yalnızca izin verilen bağlantı ve görselleri bırakıp yönetmek
(github.com/lumirlumir)Merhaba, Markdown belgelerinde harici bağlantı veya görseller arasında yalnızca izin verilen URI’leri bırakıp geri kalanını otomatik olarak filtreleyen bir npm kütüphanesi olan textlint-rule-allowed-uris’i tanıtıyorum.
Bu eklenti şu özelliklere sahiptir.
- İzinli·engelli desenleri regex ile belirtme: links ve images için izin verilen (whitelist)·engellenen (blacklist) URI desenlerini özgürce ayarlayabilirsiniz.
- Sadece Markdown için:
.md,.mdxdosyalarında Markdown sözdizimi ve HTML etiketleriyle yazılmış tüm bağlantı ve görselleri denetler. - Yerel yol, hash, query string desteği: Yalnızca harici URL’ler değil, göreli/mutlak yollar, hash ve query string içeren yollar da denetim kapsamındadır.
- Esnek yapılandırma: Seçenek belirtilmezse hiçbir şeyi denetlemez; ihtiyaçlara göre izin/engelleme kurallarını ayrıntılı biçimde ayarlayabilirsiniz.
- Kullanılmayan tanım (Reference) denetim seçeneği: Gerekirse kullanılmayan tanımları da kontrol edebilirsiniz.
Kurulum ve kullanım aşağıdaki gibidir.
- Kurulum
npm install --save-dev textlint-rule-allowed-uris .textlintrc.jsiçinde desenleri belirtinmodule.exports = { rules: { "allowed-uris": { allowed: { links: [/mycompany\.com/], images: [/imgur\.com/], }, disallowed: { links: [/forbidden\.com/], }, checkUnusedDefinitions: true, } } }- Çalıştırma
npx textlint --rule allowed-uris -f pretty-error file.md
Belgelerdeki bağlantı ve görselleri politik olarak yönetmek isteyenlere tavsiye ederim!
Daha fazla bilgi ve örnek için GitHub’daki README.md dosyasına bakabilirsiniz.
Henüz yorum yok.