markdown-cleaner-cli

🧼 Markdown Cleaner CLI

npm version npm downloads GitHub Workflow Status License: MIT Prettier Test: Jest Code of Conduct Contributing Tests

A fast, zero-config CLI tool to clean and format Markdown files.


Table of Contents

…

πŸš€ Features


πŸ“¦ 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:


βš™οΈ Global Options


🌳 Project Structure

.
β”œβ”€β”€ .vscode
β”‚   └── launch.json
β”œβ”€β”€ scripts
β”‚   β”œβ”€β”€ docblock-checker.js
β”‚   β”œβ”€β”€ generate-tree.js
β”‚   β”œβ”€β”€ update-badges.js
β”‚   └── update-readme.js
β”œβ”€β”€ src
β”‚   β”œβ”€β”€ commands
β”‚   β”‚   └── clean.js
β”‚   β”œβ”€β”€ utils
β”‚   β”‚   └── commandLoader.js
β”‚   β”œβ”€β”€ index.js
β”‚   └── program.js
β”œβ”€β”€ tests
β”‚   └── cli.test.js
β”œβ”€β”€ .gitignore
β”œβ”€β”€ CODE_OF_CONDUCT.md
β”œβ”€β”€ CONTRIBUTING.md
β”œβ”€β”€ LICENSE
β”œβ”€β”€ package-lock.json
β”œβ”€β”€ package.json
└── README.md

🀝 Contributing

We welcome contributions of all kinds! Whether you’re reporting bugs, requesting features, improving documentation, or submitting pull requests, please first read our CONTRIBUTING.md for guidelines.

You’ll find tips on opening issues, coding standards, running tests, making documentation changes, and more.


πŸ“„ 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: