Quản lý tài liệu Markdown bằng cách chỉ giữ lại các liên kết hoặc hình ảnh được cho phép
(github.com/lumirlumir)Xin chào, tôi xin giới thiệu textlint-rule-allowed-uris, một thư viện npm tự động lọc bỏ mọi liên kết hoặc hình ảnh bên ngoài trong tài liệu Markdown, chỉ giữ lại các URI được cho phép.
Plugin này có các đặc điểm sau.
- Chỉ định mẫu cho phép/chặn bằng regex: có thể tự do thiết lập các mẫu URI cho phép (whitelist) và chặn (blacklist) riêng cho
linksvàimages. - Dành riêng cho Markdown: kiểm tra toàn bộ liên kết và hình ảnh được viết bằng cú pháp Markdown hoặc thẻ HTML trong các tệp
.md,.mdx. - Hỗ trợ đường dẫn cục bộ, hash, query string: không chỉ URL bên ngoài mà cả đường dẫn tương đối/tuyệt đối, đường dẫn có chứa hash hoặc query string cũng đều được kiểm tra.
- Cấu hình linh hoạt: nếu không chỉ định tùy chọn thì sẽ không kiểm tra gì cả, và bạn có thể tinh chỉnh chi tiết các quy tắc cho phép/chặn theo nhu cầu.
- Tùy chọn kiểm tra định nghĩa không sử dụng (Reference): khi cần, cũng có thể kiểm tra các định nghĩa chưa được dùng.
Cách cài đặt và sử dụng như sau.
- Cài đặt
npm install --save-dev textlint-rule-allowed-uris - Chỉ định mẫu trong
.textlintrc.jsmodule.exports = { rules: { "allowed-uris": { allowed: { links: [/mycompany\.com/], images: [/imgur\.com/], }, disallowed: { links: [/forbidden\.com/], }, checkUnusedDefinitions: true, } } } - Chạy
npx textlint --rule allowed-uris -f pretty-error file.md
Tôi khuyên dùng thư viện này cho những ai muốn quản lý liên kết và hình ảnh trong tài liệu theo chính sách.
Để biết thêm thông tin chi tiết và ví dụ, vui lòng tham khảo README.md trên GitHub.
Chưa có bình luận nào.