https://github.com/kyoripowered/pygments-minimessage
A Pygments lexer for the MiniMessage format.
https://github.com/kyoripowered/pygments-minimessage
Last synced: 8 months ago
JSON representation
A Pygments lexer for the MiniMessage format.
- Host: GitHub
- URL: https://github.com/kyoripowered/pygments-minimessage
- Owner: KyoriPowered
- License: mit
- Created: 2024-01-27T19:29:01.000Z (almost 2 years ago)
- Default Branch: trunk
- Last Pushed: 2025-02-13T08:06:48.000Z (11 months ago)
- Last Synced: 2025-04-15T17:16:09.450Z (9 months ago)
- Language: Python
- Homepage: https://pygments-minimessage.kyori.net/
- Size: 56.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: license.txt
Awesome Lists containing this project
README
# pygments-minimessage
A [pygments](https://pygments.org/) language highlighter for the MiniMessage language.
This implementation is fairly basic at the moment, it is what has been used for [adventure's own docs](https://docs.advntr.dev/), and captures most of the language's syntax. There will be some differences in behaviour, since the actual MM parser has a fixed list of known tags - this highlighter treats anything that looks like a tag as a tag.
## Usage
`pygments-minimessage` is available on PyPI. The lexer is exposed with a plugin entrypoint, so it will automatically be picked up by pygments.
To install, use pip or your tool of choice:
```sh
$ pip install pygments-minimessage
```
See [examples](examples) for some usage scenarios.
```mm
Hello MiniMessage! Enjoy your stay!
```
For any other questions, we're happy to help out in the [Kyori discord](https://discord.gg/MMfhJ8F)
## Contributing
We welcome contributions that help move this lexer closer to parity with the full MiniMessage parser.
## License
`pygments-minimessage` is released under the terms of the MIT license.