mirror of
https://github.com/voson-wang/toon.git
synced 2026-01-29 15:24:10 +08:00
342327290d
* 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>
57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
# Tools & Playgrounds
|
|
|
|
Experiment with TOON format interactively using these community-built tools for token comparison, format conversion, and validation.
|
|
|
|
## Playgrounds
|
|
|
|
Experiment with TOON format interactively using these community-built tools for token comparison, format conversion, and validation:
|
|
|
|
- [Format Tokenization Playground](https://www.curiouslychase.com/playground/format-tokenization-exploration)
|
|
- [TOON Tools](https://toontools.vercel.app/)
|
|
|
|
## CLI Tool
|
|
|
|
The official TOON CLI provides command-line conversion, token statistics, and all encoding/decoding features. See the [CLI reference](/cli/) for full documentation.
|
|
|
|
```bash
|
|
npx @toon-format/cli input.json --stats -o output.toon
|
|
```
|
|
|
|
## Editor Support
|
|
|
|
### VS Code
|
|
|
|
[TOON Language Support](https://marketplace.visualstudio.com/items?itemName=vishalraut.vscode-toon) - Syntax highlighting, validation, conversion, and token analysis.
|
|
|
|
Install from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=vishalraut.vscode-toon) or via command line:
|
|
|
|
```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
|
|
|
|
If you're building web applications that work with TOON, you can use the TypeScript library in the browser:
|
|
|
|
```ts
|
|
import { decode, encode } from '@toon-format/toon'
|
|
|
|
// Works in browsers, Node.js, Deno, and Bun
|
|
const toon = encode(data)
|
|
const data = decode(toon)
|
|
```
|
|
|
|
See the [API reference](/reference/api) for details.
|