https://github.com/wind-addons/wmdfmt
🧹 Simple markdown formatter based on lute.
https://github.com/wind-addons/wmdfmt
formatter go markdown
Last synced: 5 months ago
JSON representation
🧹 Simple markdown formatter based on lute.
- Host: GitHub
- URL: https://github.com/wind-addons/wmdfmt
- Owner: wind-addons
- License: mit
- Created: 2024-08-03T06:18:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-04T21:03:27.000Z (almost 2 years ago)
- Last Synced: 2024-08-04T22:39:15.550Z (almost 2 years ago)
- Topics: formatter, go, markdown
- Language: Go
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🧹 wmdfmt
This is a simple markdown formatter that will format markdown files with [lute](https://github.com/88250/lute).
📖 Table of Contents
- [🚚 Installation](#-installation)
- [💡 Usage](#-usage)
- [Help](#help)
- [Example](#example)
- [📜 License](#-license)
## 🚚 Installation
```bash
go install github.com/wind-addons/wmdfmt@latest
```
## 💡 Usage
### Help
```text
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
```bash
# 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