wmdfmt

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 4, 2024 License: MIT Imports: 8 Imported by: 0

README

🧹 wmdfmt

This is a simple markdown formatter that will format markdown files with lute.

📖 Table of Contents

🚚 Installation

go install github.com/wind-addons/wmdfmt@latest

💡 Usage

Help
NAME:
   wmdfmt - Format Markdown files

USAGE:
   wmdfmt [global options] command [command options]

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --in-place, -i   Format file(s) in-place (default: false)
   --recursive, -r  Recursively format files in subdirectories (default: false)
   --ignore value   Ignore files matching this pattern
   --help, -h       show help
Example
# Format a single file
wmdfmt README.md

# Format from pipe
echo "# Hello" | wmdfmt

# Format multiple files
wmdfmt README.md CHANGELOG.md

# Format all markdown files in a directory
wmdfmt .

# Format all markdown files in a directory and subdirectories
wmdfmt -r .

# Format all markdown files in a directory and subdirectories in-place
wmdfmt -r -i .

# Format all markdown files in a directory and subdirectories in-place and ignore CHANGELOG.md
wmdfmt -r -i --ignore CHANGELOG.md .

📜 License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL