Gelatyx

Format codebase in documentation 🦤

Features

Format language code block inside documentation files
Check mode. Ask Gelatyx is the documentation has been formatted.
Glob support.
Supported languages
- Lua via StyLua

Usage

Usage Examples

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.

Command-line options

``` bash gelatyx [version] Gelatyx 🦤.

        Format codebease inside the docs

USAGE: gelatyx [OPTIONS] --file ...

ARGS: Language used in code block. [possible values: lua]

OPTIONS: -f, --file ... File(s) to format. --color When to use colors (auto, never, always). [default: auto] [possible values: auto, never, always] --check Check if the docs has been formatted. -h, --help Print help information -V, --version Print version information

Note: gelatyx -h prints a short and concise overview while gelatyx --help gives all details. ```

If you like gelatyx to support your favorite language, 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 Rust's package manager cargo:

bash $ cargo install gelatyx

Development

``` bash $ clone the repository

$ # Run unit tests and integration tests $ cargo test

$ # Install $ cargo install --path . ```

Origin of the name

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