Gelatyx

Format codebase in documentation.

Features

Format language code block 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

Usage

bash $ gelatyx lua --file input.md Format a file with lua formatter $ gelatyx lua --file *.md Format multiple files ... $ gelatyx lua --file input.md --check Check if the docs has been formatted. $ gelatyx lua --file 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.

Installation

From binaries

The release page includes pre-compiled binaries for GNU/Linux, macOS, and Windows.

From source

Using cargo-binstall

bash $ cargo binstall gelatyx

Using Rust's package manager 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

Origin of the name

The name Gelatyx is a played version of Gelatik. A beautiful bird from Indonesia.