Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azzamsa/gelatyx
Format code blocks inside documentation ðĶĪ
https://github.com/azzamsa/gelatyx
Last synced: 24 days ago
JSON representation
Format code blocks inside documentation ðĶĪ
- Host: GitHub
- URL: https://github.com/azzamsa/gelatyx
- Owner: azzamsa
- License: mit
- Created: 2022-07-13T14:32:40.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-01T08:00:55.000Z (10 months ago)
- Last Synced: 2024-12-01T01:50:49.722Z (about 1 month ago)
- Language: Rust
- Homepage:
- Size: 129 KB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Gelatyx
Format code blocks inside documentation files.
---
## 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)