Crate beautiful_md 

beautiful-md: A CLI tool and library to format and beautify Markdown files.

This crate provides functionality to parse, format, and beautify Markdown files according to configurable style rules. It can be used as a library or as a command-line tool.

Examples

use beautiful_md::{Config, format_markdown};

let markdown = "# Heading\n\n|Name|Age|\n|---|---|\n|Alice|30|";
let config = Config::default();
let (formatted, _diagnostics) = format_markdown(markdown, &config).unwrap();
println!("{}", formatted);

Features

• Table alignment and padding
• Heading spacing normalization
• List indentation consistency
• Code block formatting
• Configurable via TOML files

Configuration

Create a .beautiful-md.toml file in your project root or home directory:

[tables]
align = true
min_column_width = 3
padding = 1

[headings]
blank_lines_before = 1
blank_lines_after = 1
space_after_hash = true

[lists]
indent_size = 2
marker = "-"
normalize_numbers = true

[code]
ensure_language_tag = false
fence_style = "```"

Re-exports

pub use config::Config;

pub use diagnostics::Diagnostics;

pub use error::Error;

pub use error::Result;

Modules

config

Configuration management for beautiful-md.

diagnostics

Diagnostic and warning system for markdown formatting issues.

error

Error types for beautiful-md.

Functions

format_file

Format a markdown file in-place.

format_markdown

Format markdown content according to the provided configuration.