{"id":34997688,"url":"https://github.com/mewset/beautiful-md","last_synced_at":"2026-01-13T21:57:54.218Z","repository":{"id":329796155,"uuid":"1120690350","full_name":"mewset/beautiful-md","owner":"mewset","description":"A fast CLI tool and Rust library to format and beautify Markdown files with configurable style rules. Handles table alignment, heading spacing, list normalization, and code block formatting.","archived":false,"fork":false,"pushed_at":"2025-12-27T10:59:18.000Z","size":90,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-28T16:29:41.375Z","etag":null,"topics":["beautify","cli","code-formatter","command-line-tool","formatter","mardown","markdown-formatter","markdown-parser","markdown-processing","markdown-tool","rust","rust-cli","rust-library"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/beautiful-md","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mewset.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"ko_fi":"mewset"}},"created_at":"2025-12-21T18:37:06.000Z","updated_at":"2025-12-27T10:58:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/mewset/beautiful-md","commit_stats":null,"previous_names":["mewset/beautiful-md"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/mewset/beautiful-md","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mewset%2Fbeautiful-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mewset%2Fbeautiful-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mewset%2Fbeautiful-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mewset%2Fbeautiful-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mewset","download_url":"https://codeload.github.com/mewset/beautiful-md/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mewset%2Fbeautiful-md/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28400397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T14:36:09.778Z","status":"ssl_error","status_checked_at":"2026-01-13T14:35:19.697Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["beautify","cli","code-formatter","command-line-tool","formatter","mardown","markdown-formatter","markdown-parser","markdown-processing","markdown-tool","rust","rust-cli","rust-library"],"created_at":"2025-12-27T02:50:41.632Z","updated_at":"2026-01-13T21:57:54.213Z","avatar_url":"https://github.com/mewset.png","language":"Rust","funding_links":["https://ko-fi.com/mewset"],"categories":[],"sub_categories":[],"readme":"# beautiful-md\n\n[![CI](https://github.com/mewset/beautiful-md/workflows/CI/badge.svg)](https://github.com/mewset/beautiful-md/actions)\n[![Crates.io](https://img.shields.io/crates/v/beautiful-md.svg)](https://crates.io/crates/beautiful-md)\n[![Documentation](https://docs.rs/beautiful-md/badge.svg)](https://docs.rs/beautiful-md)\n[![License](https://img.shields.io/crates/l/beautiful-md.svg)](LICENSE-MIT)\n\nA CLI tool and Rust library to format and beautify Markdown files with configurable style rules.\n\n\n## Features\n\n- ✨ **Table Formatting**: Align columns, consistent padding, and clean appearance\n- 📝 **Heading Normalization**: Consistent spacing and hash mark formatting\n- 📋 **List Formatting**: Uniform indentation and bullet markers\n- 💻 **Code Block Styling**: Consistent fence styles and language tags\n- ⚙️ **Configurable**: Customize formatting rules via TOML configuration\n- 🚀 **Fast**: Written in Rust for optimal performance\n- 📦 **Multiple Modes**: In-place editing, stdout output, or file output\n\n\n## Installation\n\n\n### From crates.io\n\n```bash\ncargo install beautiful-md\n```\n\n\n### From source\n\n```bash\ngit clone https://github.com/mewset/beautiful-md.git\ncd beautiful-md\ncargo install --path .\n```\n\n\n## Usage\n\n\n### Command Line\n\n```bash\n# Format and output to stdout\nbeautiful-md README.md\n\n# Format file in-place\nbeautiful-md --in-place README.md\n\n# Format multiple files\nbeautiful-md --in-place *.md\n\n# Format with custom config\nbeautiful-md --config my-config.toml README.md\n\n# Check if files need formatting (useful for CI)\nbeautiful-md --check README.md\n\n# Generate default configuration file\nbeautiful-md config\n```\n\n\n### As a Library\n\n```rust\nuse beautiful_md::{Config, format_markdown};\n\nfn main() -\u003e Result\u003c(), Box\u003cdyn std::error::Error\u003e\u003e {\n    let markdown = \"# Heading\\n\\n|Name|Age|\\n|---|---|\\n|Alice|30|\";\n    let config = Config::default();\n    let formatted = format_markdown(markdown, \u0026config)?;\n    println!(\"{}\", formatted);\n    Ok(())\n}\n```\n\n\n## Configuration\n\nCreate a `.beautiful-md.toml` file in your project root or home directory:\n\n```toml\n[tables]\nalign = true\nmin_column_width = 3\npadding = 1\n\n[headings]\nblank_lines_before = 1\nblank_lines_after = 1\nspace_after_hash = true\n\n[lists]\nindent_size = 2\nmarker = \"-\"\nnormalize_numbers = true\n\n[code]\nensure_language_tag = false\nfence_style = \"```\"\n```\n\n\n### Configuration Options\n\n\n#### Tables\n\n- `align` (bool): Enable column alignment\n- `min_column_width` (usize): Minimum width for columns\n- `padding` (usize): Spaces around cell content\n\n\n#### Headings\n\n- `blank_lines_before` (usize): Empty lines before headings\n- `blank_lines_after` (usize): Empty lines after headings\n- `space_after_hash` (bool): Ensure space after `#` symbols\n\n\n#### Lists\n\n- `indent_size` (usize): Spaces per indentation level\n- `marker` (string): Bullet character (`-`, `*`, or `+`)\n- `normalize_numbers` (bool): Fix ordered list numbering\n\n\n#### Code\n\n- `ensure_language_tag` (bool): Require language tags\n- `fence_style` (string): Fence style (```` ``` ```` or `~~~`)\n\n\n## Examples\n\n\n### Before\n\n```markdown\n#Heading Without Space\n\n|Name|Age|City|\n|---|---|---|\n|Alice|30|Stockholm|\n|Bob|25|Göteborg|\n\n- Item 1\n* Item 2\n+ Item 3\n```\n\n\n### After\n\n```markdown\n# Heading With Space\n\n| Name  | Age | City      |\n| ----- | --- | --------- |\n| Alice | 30  | Stockholm |\n| Bob   | 25  | Göteborg  |\n\n- Item 1\n- Item 2\n- Item 3\n```\n\n\n## Development\n\n\n### Prerequisites\n\n- Rust 1.70 or later\n- Cargo\n\n\n### Building\n\n```bash\ncargo build --release\n```\n\n\n### Testing\n\n```bash\ncargo test\n```\n\n\n### Linting\n\n```bash\ncargo clippy -- -D warnings\ncargo fmt --check\n```\n\n\n## Contributing\n\nContributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.\n\n\n## License\n\nLicensed under either of:\n\n- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n\nat your option.\n\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall be\ndual licensed as above, without any additional terms or conditions.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmewset%2Fbeautiful-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmewset%2Fbeautiful-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmewset%2Fbeautiful-md/lists"}