Skip to content

Latest commit

 

History

History
104 lines (69 loc) · 2.64 KB

README.md

File metadata and controls

104 lines (69 loc) · 2.64 KB
Raw

Gelatyx

Format code blocks inside documentation files.

Build status Sponsor me

demo

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

Usage

$ 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.

Installation

From binaries

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

From source

Using cargo-binstall

$ cargo binstall gelatyx

Using Rust's package manager cargo:

$ cargo install gelatyx

Development

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.

Credits