Description

Wash in Markdown: Elevate Your Markdown, Effortlessly.

🧺 Tired of Messy Markdown? Get a Fresh Start!

Are your Markdown files a tangled mess of inconsistent headings, rogue spaces, poorly formatted lists, and code blocks gone wild? Do collaborating teams constantly fight over whitespace changes in pull requests?

It's time to bring order to your prose. Introducing Wash in Markdown – the ultimate tool for cleaning, formatting, and standardizing your Markdown documents, ensuring they're always crisp, consistent, and a pleasure to read. Think of it as the premium laundry service for your .md files.

✨ What is Wash in Markdown?

Wash in Markdown is a powerful, customizable command-line interface (CLI) tool designed to lint, format, and fix common issues in your Markdown documents. It automatically detects and corrects formatting inconsistencies, enforces style guides, and ensures your documentation, notes, and content are always pristine.

🌟 Key Features – Your Markdown, Professionally Pressed

• Whitespace Warrior:
  • Automatically trims leading/trailing whitespace on lines.
  • Collapses multiple consecutive spaces and empty lines where appropriate.
  • Ensures consistent spacing around elements like headings, lists, and code blocks.
• Heading Harmonizer:
  • Enforces consistent heading styles (e.g., ATX ## Heading or Setext Heading\n---).
  • Corrects heading levels and ensures a single space after #.
• List Lister:
  • Standardizes ordered and unordered list markers (e.g., always * or - for unordered, 1. for ordered).
  • Corrects list indentation.
  • Ensures proper spacing between list items and their content.
• Code Block Cleaner:
  • Standardizes fenced code block syntax (e.g., always ```language).
  • Ensures consistent empty lines before and after code blocks.
  • Optionally adds language identifiers to un-tagged blocks based on context (experimental).
• Emphasis Enforcer:
  • Standardizes bold (**text** vs. __text__) and italic (*text* vs. _text_) syntax.
• Table Tidy-Upper:
  • Automatically aligns table columns.
  • Ensures consistent padding for readable tables.
• Link & Image Validator:
  • Checks for broken internal links and images.
  • Optionally reports on dead external links (requires network access).
• Smart Line Wrapping:
  • Configurable line length limit with intelligent wrapping that avoids breaking words or code.
• Customizable Configuration:
  • Define your own style rules using a .washrc file (JSON or YAML).
  • Enable or disable specific cleaning modules.
  • Integrate with existing style guides.
• Dry Run Mode:
  • Preview changes before applying them, so you can see exactly what will be "washed."
• Git Pre-Commit Hook Integration:
  • Ensure every commit is sparkling clean by running wash-md automatically before committing.

🎯 Benefits – Why Your Workflow Needs a Wash

• Unrivaled Readability: Consistently formatted Markdown is easier on the eyes and reduces cognitive load.
• Boost Collaboration: Minimize merge conflicts caused by whitespace and formatting differences. Cleaner git diffs mean faster code reviews.
• Time-Saving Automation: Stop wasting precious minutes manually fixing formatting. Wash in Markdown does the tedious work for you.
• Professional Consistency: Ensure all your documentation, blog posts, and content adhere to a single, professional style guide.
• Reduced Errors: Catch broken links and ensure correct rendering across different Markdown parsers.
• Enhanced Maintainability: Clean, standardized documents are easier to maintain and update in the long run.
• Peace of Mind: Know that your Markdown files are always in top shape, ready for publishing or sharing.

👩‍💻 Who is Wash in Markdown For?

• Developers & Technical Writers: Maintain immaculate documentation, READMEs, and wikis.
• Content Creators & Bloggers: Ensure your articles and posts are polished and professional before publishing.
• Teams & Organizations: Enforce a unified style guide across all your Markdown-based content.
• Anyone who values clean, consistent Markdown!

🚀 How It Works (A Quick Spin)

1. Install Wash in Markdown:

npm install -g wash-in-markdown # or pip install wash-in-markdown # (if using Python version) # or cargo install wash-in-markdown # (if using Rust version)

2. Configure Your Wash Cycle (Optional washrc.json):

{  "headingStyle": "atx",  "listMarker": "*",  "indent": 2,  "lineLength": 80,  "trimTrailingWhitespace": true,  "enforceBlankLinesAroundCode": true,  "dryRun": false }

3. Wash Your Files:

# Wash a single file wash-md my-document.md # Wash all markdown files in a directory wash-md docs/**/*.md # Preview changes without applying them wash-md --dry-run my-document.md # Fix specific issues (e.g., only headings) wash-md --only-fix headings my-document.md

🔧 Technical Specifications

• Language: Available in multiple implementations for flexibility (Node.js, Python, Rust).
• Cross-Platform: Works on Windows, macOS, and Linux.
• Configuration: .washrc files (JSON/YAML) for granular control.
• Integrations: Easily integrates with CI/CD pipelines, pre-commit hooks (e.g., husky, pre-commit.com), and IDEs (via external tool configurations).

🛒 Ready for a Fresh Batch of Markdown?

Stop struggling with messy Markdown and let Wash in Markdown do the heavy lifting. Spend less time formatting and more time creating valuable content.

👉 Download Wash in Markdown Today! 📚 Read the Full Documentation 🌟 Star us on GitHub!

Wash in Markdown: For a world where every .md is perfectly laundered.