A fast, zero-config CLI tool to clean and format Markdown files.
β¦
.md
files in any projectnpm 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
To verify mdclean is available, use:
mdclean -V
To clean a Markdown file:
mdclean clean path/to/file.md
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-v, --verbose
: enable verbose output--debug
: enable debug output--silent
: suppress all output.
βββ .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
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.
npm run format
to ensure consistent code and documentation formatting.npm run docs:tree
to update the Project Structure tree in the README.npm run docs:toc
to update the Table of Contents in the README.npm run ready
to execute all three steps in sequence (updating the project tree, updating the table of contents, and formatting) before submitting your changes.This project is licensed under the MIT License.
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: