rumdl

Rumdl is a high-performance Markdown linter and formatter developed using Rust, designed to enhance consistency and enforce best practices within Markdown files. Built for speed, Rumdl significantly outperforms other linters, making it an efficient tool for developers and content creators alike.

Key Features

• ⚡️ Speed: Developed in Rust, Rumdl offers fast processing times compared to alternative Markdown linters.
• 🔍 54 Lint Rules: Identifies and resolves common Markdown issues.
• 🛠️ Automatic Formatting: The --fix option allows automatic correction of linting problems.
• 📦 Zero Dependencies: Rumdl is packaged as a single binary without any runtime dependencies.
• 🔧 Highly Configurable: Easily customizable configurations via TOML files.
• 🌐 Multiple Installation Options: Available for installation through Cargo, pip for Python users, or as standalone binaries.
• 🐍 Python Compatibility: Can be installed via pip, making it accessible for Python developers.
• 📏 Modern Command-Line Interface (CLI): Provides detailed error messages and feedback.
• 🔄 CI/CD Integration: Generates non-zero exit codes on errors, facilitating integration within continuous integration and deployment pipelines.

Quick Start

To evaluate Markdown files using Rumdl, use the following commands:

# Lint Markdown files in the current directory
rumdl check .

# Format files by automatically correcting issues
rumdl fmt .

# Create a default configuration file
rumdl init

Comprehensive Linting and Configuration

Rumdl supports a myriad of options for extensive control over linting and formatting, including:

• Customizing rules: Enable or disable specific lint rules based on project requirements.
• Profile-based formatting for individual file types.
• JSON output for integration with other tools.

For further details on the supported rules, configuration options, and usage, please refer to the documentation.

Conclusion

With its focus on performance and usability, Rumdl serves as an essential tool for anyone needing to ensure high-quality Markdown documentation. By automating linting and formatting tasks, it streamlines the development workflow, allowing teams to maintain a uniform codebase effortlessly.