https://github.com/markjaquith/markdown-format
https://github.com/markjaquith/markdown-format
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/markjaquith/markdown-format
- Owner: markjaquith
- Created: 2025-08-18T02:57:41.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-18T05:15:18.000Z (10 months ago)
- Last Synced: 2025-08-18T07:12:24.151Z (10 months ago)
- Language: TypeScript
- Size: 15.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# markdown-format
A fast and efficient Markdown formatter built with Bun.
## Quick Start
You can run this tool directly without installation using `bunx` and pipe your Markdown content to it:
```bash
cat your-file.md | bunx github:markjaquith/markdown-format
```
## Installation
To install dependencies locally:
```bash
bun install
```
## Usage
This tool can read Markdown from a file or stdin and outputs formatted Markdown to stdout.
### Run locally
```bash
# Read from a file
bun run index.ts your-file.md
# Read from stdin
cat your-file.md | bun run index.ts
```
### Run with bunx (no installation required)
```bash
# Read from a file
bunx github:markjaquith/markdown-format your-file.md
# Pipe from stdin
cat your-file.md | bunx github:markjaquith/markdown-format
# Pipe from another command
echo "# Hello World" | bunx github:markjaquith/markdown-format
# Format and save to a new file
bunx github:markjaquith/markdown-format input.md > output.md
# Or using stdin
cat input.md | bunx github:markjaquith/markdown-format > output.md
```
## About
This project provides a streamlined way to format and standardize Markdown files. Built with [Bun](https://bun.com) for maximum performance and ease of use.
Created with `bun init` in bun v1.2.20.