# prettier-markdown
A fast command-line formatter for Markdown files, designed as a replacement for Prettier in Python projects where speed is crucial.
## Installation
```bash
pip install prettier-markdown
```
## Usage
### Command Line
```bash
# Format a single file
prettier-markdown file.md
# Format multiple files
prettier-markdown file1.md file2.md
# Format all markdown files in a directory
prettier-markdown docs/
# Check if files are formatted (exit code 1 if not)
prettier-markdown --check file.md
```
### Pre-commit Hook
Add to your `.pre-commit-config.yaml`:
```yaml
repos:
- repo: https://github.com/jsh9/prettier-markdown
rev: 0.1.0
hooks:
- id: prettier-markdown
```
(Replace "0.1.0" with the most recent version.)
## Features
- Fast markdown formatting
- Pre-commit hook integration
- Configurable formatting rules
- Support for multiple markdown files
## Development
```bash
# Install development dependencies
pip install -e ".[dev]"
# Run tests
pytest
# Run pre-commit hooks
pre-commit run --all-files
```
## License
MIT License
Raw data
{
"_id": null,
"home_page": null,
"name": "prettier-markdown",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Your Name <your.email@example.com>",
"keywords": "formatter, code-style, markdown, python",
"author": null,
"author_email": "Your Name <your.email@example.com>",
"download_url": "https://files.pythonhosted.org/packages/af/37/b6e51d10f9c1cd35b027de3c7591263c4bebf40398820ce53324772f40f5/prettier_markdown-0.1.0.tar.gz",
"platform": null,
"description": "# prettier-markdown\n\nA fast command-line formatter for Markdown files, designed as a replacement for Prettier in Python projects where speed is crucial.\n\n## Installation\n\n```bash\npip install prettier-markdown\n```\n\n## Usage\n\n### Command Line\n\n```bash\n# Format a single file\nprettier-markdown file.md\n\n# Format multiple files\nprettier-markdown file1.md file2.md\n\n# Format all markdown files in a directory\nprettier-markdown docs/\n\n# Check if files are formatted (exit code 1 if not)\nprettier-markdown --check file.md\n```\n\n### Pre-commit Hook\n\nAdd to your `.pre-commit-config.yaml`:\n\n```yaml\nrepos:\n - repo: https://github.com/jsh9/prettier-markdown\n rev: 0.1.0\n hooks:\n - id: prettier-markdown\n```\n(Replace \"0.1.0\" with the most recent version.)\n\n## Features\n\n- Fast markdown formatting\n- Pre-commit hook integration\n- Configurable formatting rules\n- Support for multiple markdown files\n\n## Development\n\n```bash\n# Install development dependencies\npip install -e \".[dev]\"\n\n# Run tests\npytest\n\n# Run pre-commit hooks\npre-commit run --all-files\n```\n\n## License\n\nMIT License\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A fast command-line formatter for Markdown files",
"version": "0.1.0",
"project_urls": {
"Changelog": "https://github.com/jsh9/prettier-markdown/blob/main/CHANGELOG.md",
"Homepage": "https://github.com/jsh9/prettier-markdown",
"Issues": "https://github.com/jsh9/prettier-markdown/issues",
"Repository": "https://github.com/jsh9/prettier-markdown.git"
},
"split_keywords": [
"formatter",
" code-style",
" markdown",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "edb05d2a1ae4c150c88701145ee2174983cd00a74a45a4ac2699c464810f3877",
"md5": "37733655bb7383681c83443b5f1632fa",
"sha256": "f2263881e0e37023b644ddc800e2bd9db641b645220ec5f07ef8a926a552262b"
},
"downloads": -1,
"filename": "prettier_markdown-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37733655bb7383681c83443b5f1632fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 7929,
"upload_time": "2025-08-28T05:27:37",
"upload_time_iso_8601": "2025-08-28T05:27:37.432727Z",
"url": "https://files.pythonhosted.org/packages/ed/b0/5d2a1ae4c150c88701145ee2174983cd00a74a45a4ac2699c464810f3877/prettier_markdown-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "af37b6e51d10f9c1cd35b027de3c7591263c4bebf40398820ce53324772f40f5",
"md5": "936127b4de61ffdb47ced5aacd2627f4",
"sha256": "8e380997c89d1fb09dc8aa8e66530629c131cdf781ee05f9e193b88b67cc776b"
},
"downloads": -1,
"filename": "prettier_markdown-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "936127b4de61ffdb47ced5aacd2627f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 16456,
"upload_time": "2025-08-28T05:27:38",
"upload_time_iso_8601": "2025-08-28T05:27:38.336259Z",
"url": "https://files.pythonhosted.org/packages/af/37/b6e51d10f9c1cd35b027de3c7591263c4bebf40398820ce53324772f40f5/prettier_markdown-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-28 05:27:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jsh9",
"github_project": "prettier-markdown",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "prettier-markdown"
}
JSON
