docs: add tree-sitter grammar and comprehensive editor support (#200)

* docs: add tree-sitter grammar and editor support documentation

- Add comprehensive Editor Support section to README.md
- Document tree-sitter-toon grammar with usage examples
- Include VS Code extension information
- Add Neovim configuration example for tree-sitter
- Update tools-and-playgrounds.md with detailed editor support
- Add Editor Support to table of contents

Resolves #143
Resolves #99

* docs: simplify

---------

Co-authored-by: Johann Schopplich <mail@johannschopplich.com>
This commit is contained in:
Omzee
2025-11-21 13:52:11 +05:30
committed by GitHub
parent cf87cfafff
commit 342327290d
2 changed files with 42 additions and 5 deletions

View File

@@ -27,6 +27,7 @@ Think of it as a translation layer: use JSON programmatically, and encode it as
- [Benchmarks](#benchmarks) - [Benchmarks](#benchmarks)
- [Installation & Quick Start](#installation--quick-start) - [Installation & Quick Start](#installation--quick-start)
- [Playgrounds](#playgrounds) - [Playgrounds](#playgrounds)
- [Editor Support](#editor-support)
- [CLI](#cli) - [CLI](#cli)
- [Format Overview](#format-overview) - [Format Overview](#format-overview)
- [Using TOON with LLMs](#using-toon-with-llms) - [Using TOON with LLMs](#using-toon-with-llms)
@@ -770,6 +771,28 @@ Experiment with TOON format interactively using these community-built tools for
- [Format Tokenization Playground](https://www.curiouslychase.com/playground/format-tokenization-exploration) - [Format Tokenization Playground](https://www.curiouslychase.com/playground/format-tokenization-exploration)
- [TOON Tools](https://toontools.vercel.app/) - [TOON Tools](https://toontools.vercel.app/)
## Editor Support
### VS Code
[TOON Language Support](https://marketplace.visualstudio.com/items?itemName=vishalraut.vscode-toon) - Syntax highlighting, validation, conversion, and token analysis.
```bash
code --install-extension vishalraut.vscode-toon
```
### Tree-sitter Grammar
[tree-sitter-toon](https://github.com/3swordman/tree-sitter-toon) - Grammar for Tree-sitter-compatible editors (Neovim, Helix, Emacs, Zed).
### Neovim
[toon.nvim](https://github.com/thalesgelinger/toon.nvim) - Lua-based plugin.
### Other Editors
Use YAML syntax highlighting as a close approximation.
## CLI ## CLI
Command-line tool for quick JSON↔TOON conversions, token analysis, and pipeline integration. Auto-detects format from file extension, supports stdin/stdout workflows, and offers delimiter options for maximum efficiency. Command-line tool for quick JSON↔TOON conversions, token analysis, and pipeline integration. Auto-detects format from file extension, supports stdin/stdout workflows, and offers delimiter options for maximum efficiency.

View File

@@ -19,13 +19,27 @@ npx @toon-format/cli input.json --stats -o output.toon
## Editor Support ## Editor Support
TOON syntax highlighting is available for popular editors: ### VS Code
- **VS Code**: Use YAML syntax highlighting as a close approximation (`.toon` files can be associated with YAML language mode). [TOON Language Support](https://marketplace.visualstudio.com/items?itemName=vishalraut.vscode-toon) - Syntax highlighting, validation, conversion, and token analysis.
- **Vim/Neovim**: [toon.nvim](https://github.com/thalesgelinger/toon.nvim)
> [!NOTE] Install from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=vishalraut.vscode-toon) or via command line:
> Native TOON syntax highlighting extensions are in development. Contributions welcome!
```bash
code --install-extension vishalraut.vscode-toon
```
### Tree-sitter Grammar
[tree-sitter-toon](https://github.com/3swordman/tree-sitter-toon) - Grammar for Tree-sitter-compatible editors (Neovim, Helix, Emacs, Zed).
### Neovim
[toon.nvim](https://github.com/thalesgelinger/toon.nvim) - Lua-based plugin for Neovim.
### Other Editors
Use YAML syntax highlighting as a close approximation. Most editors allow associating `.toon` files with YAML language mode.
## Web APIs ## Web APIs