Gelatyx

Format code blocks inside documentation files. Build status Sponsor me

![demo](https://user-images.githubusercontent.com/17734314/212822384-9223ece5-6e66-4811-8aa0-dbca4e7d3907.gif)

--- ## Features - Format language code blocks inside documentation files. - Check mode. Ask Gelatyx if the documentation has been formatted. - Glob support. - Configure the formatter via a configuration file. - Fancy error message and colorful output. - Cross-platform and single binary. - Supported languages - Lua via [StyLua](https://github.com/JohnnyMorganz/StyLua) ## Usage ```bash $ gelatyx --language lua input.md Format a file with lua formatter $ gelatyx --language lua *.md Format multiple files ... $ gelatyx --language lua input.md --check Check if the docs has been formatted. $ gelatyx --language lua input.md --language-config config.toml Configure the formatter. ``` ## Integration with other formatter If you like `gelatyx` to support your favorite formatter, feel free to open [new issue](https://github.com/azzamsa/gelatyx/issues/new). ## Installation ### From binaries The [release page](https://github.com/azzamsa/gelatyx/releases) includes pre-compiled binaries for GNU/Linux, macOS, and Windows. ### From source Using [cargo-binstall](https://github.com/cargo-bins/cargo-binstall) ```bash $ cargo binstall gelatyx ``` Using Rust's package manager [cargo](https://github.com/rust-lang/cargo): ```bash $ cargo install gelatyx ``` ## Development ```bash git clone https://github.com/azzamsa/gelatyx # Build cd gelatyx cargo build # Run unit tests and integration tests cargo test # Install cargo install --path . ``` ## Contributing To learn more read [the development guide](docs/dev/README.md) ## Origin of the name The name Gelatyx is a played version of [Gelatik](https://id.wikipedia.org/wiki/Gelatik). A beautiful bird from Indonesia. ## Credits - [Anthony Sottile's blacken-docs](https://github.com/asottile/blacken-docs) - [Noto Emoji](https://github.com/googlefonts/noto-emoji)