markdown-cleaner-cli

🧼 Markdown Cleaner CLI

A fast, zero-config CLI tool to clean and format Markdown files—remove trailing spaces, normalize headings, and tidy up your docs.

🚀 Features

• 🧹 Cleans up messy Markdown formatting
• 🔄 Normalizes heading levels and spacing
• 🧼 Removes trailing whitespace and empty lines
• ⚡ Fast and zero-config
• 🛠️ Works with .md files in any project

📦 Installation

npm install -g markdown-cleaner-cli

This command installs the CLI tool globally, making the mdclean command available in your terminal from any directory.

To verify mdclean is available:

mdclean -V

🧪 Usage

To verify mdclean is available, use:

mdclean -V

To clean a Markdown file:

mdclean clean path/to/file.md

🛠️ Commands

clean <file>

Clean the Markdown file by removing unnecessary elements.

Options:

• -f, --force: overwrite output file if it exists
• -q, --quiet: suppress all output except errors

⚙️ Global Options

• -v, --verbose: enable verbose output
• --debug: enable debug output
• --silent: suppress all output

💬 Community & Support

If you have questions, ideas, or need help, please join our Discussions page.

For bug reports and feature requests, please open an issue.

🤝 Contributing

Contributions are welcome! Please see our CONTRIBUTING.md for details.

📄 License

This project is licensed under the MIT License.

🙏 Acknowledgments

We would like to thank the creators and maintainers of the following libraries and tools, which were instrumental in the development of this CLI and the management of its repository:

• Commander.js: For building robust and user-friendly command-line interfaces.
• Jest: For providing a delightful JavaScript testing framework.
• Glob: For flexible file system pattern matching.
• Git: For version control and collaborative development.