traxys/tree-sitter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: various fixes

Browse source 
Closes https://github.com/tree-sitter/tree-sitter/issues/1317.
Closes https://github.com/tree-sitter/tree-sitter/issues/1752.
Closes https://github.com/tree-sitter/tree-sitter/issues/2439.

Co-authored-by: Simon Hengel <sol@typeful.net>
Co-authored-by: Akash Yadav <itsaky01@gmail.com>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
Co-authored-by: Laytan Laats <laytanlaats@hotmail.com>
This commit is contained in:
dundargoc 2024-02-07 21:26:21 +01:00 • committed by dundargoc
parent ea7f6e1fa3
commit df1fe842eb
15 changed files with 21 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/index.md
View file

@ -20,14 +20,16 @@ There are currently bindings that allow Tree-sitter to be used from the followin
* [Guile](https://github.com/Z572/guile-ts)
* [Haskell](https://github.com/tree-sitter/haskell-tree-sitter)
* [Java](https://github.com/serenadeai/java-tree-sitter)
* [Java (Android)](https://github.com/AndroidIDEOfficial/android-tree-sitter)
* [JavaScript (Node.js)](https://github.com/tree-sitter/node-tree-sitter)
* [JavaScript (Wasm)](https://github.com/tree-sitter/tree-sitter/tree/master/lib/binding_web)
* [Kotlin](https://github.com/oxisto/kotlintree)
* [Lua](https://github.com/euclidianAce/ltreesitter)
* [OCaml](https://github.com/returntocorp/ocaml-tree-sitter-core)
* [Odin](https://github.com/laytan/odin-tree-sitter)
* [Perl](https://metacpan.org/pod/Text::Treesitter)
* [Python](https://github.com/tree-sitter/py-tree-sitter)
* [Ruby](https://github.com/tree-sitter/ruby-tree-sitter)
* [Ruby](https://github.com/Faveod/ruby-tree-sitter)
* [Ruby](https://github.com/calicoday/ruby-tree-sitter-ffi)
* [Rust](https://github.com/tree-sitter/tree-sitter/tree/master/lib/binding_rust)
* [Swift](https://github.com/ChimeHQ/SwiftTreeSitter)
@ -94,7 +96,8 @@ There are currently bindings that allow Tree-sitter to be used from the followin
* [LLVM MachineIR](https://github.com/Flakebi/tree-sitter-llvm-mir)
* [LLVM MLIR](https://github.com/artagnon/tree-sitter-mlir)
* [LLVM TableGen](https://github.com/Flakebi/tree-sitter-tablegen)
* [Lua](https://github.com/Azganoth/tree-sitter-lua)
* [Lua](https://github.com/MunifTanjim/tree-sitter-lua)
* [Magik](https://github.com/krn-robin/tree-sitter-magik)
* [Make](https://github.com/alemuller/tree-sitter-make)
* [Markdown](https://github.com/ikatyang/tree-sitter-markdown)
* [Markdown](https://github.com/MDeiml/tree-sitter-markdown)
@ -106,6 +109,7 @@ There are currently bindings that allow Tree-sitter to be used from the followin
* [Noir](https://github.com/hhamud/tree-sitter-noir)
* [Objective-C](https://github.com/jiyee/tree-sitter-objc)
* [OCaml](https://github.com/tree-sitter/tree-sitter-ocaml)
* [Odin](https://github.com/amaanq/tree-sitter-odin)
* [Org](https://github.com/milisims/tree-sitter-org)
* [P4](https://github.com/ace-design/tree-sitter-p4)
* [Pascal](https://github.com/Isopod/tree-sitter-pascal)
@ -142,6 +146,7 @@ There are currently bindings that allow Tree-sitter to be used from the followin
* [SQL - PostgreSQL](https://github.com/m-novikov/tree-sitter-sql)
* [SQL - SQLite](https://github.com/dhcmrlchtdj/tree-sitter-sqlite)
* [SSH](https://github.com/metio/tree-sitter-ssh-client-config)
* [Supercollider](https://github.com/madskjeldgaard/tree-sitter-supercollider)
* [Svelte](https://github.com/Himujjal/tree-sitter-svelte)
* [Swift](https://github.com/alex-pinkus/tree-sitter-swift)
* [SystemRDL](https://github.com/SystemRDL/tree-sitter-systemrdl)

2
docs/section-2-using-parsers.md
View file

@ -137,7 +137,7 @@ TSTree *ts_parser_parse(
);
```
The `TSInput` structure lets you to provide your own function for reading a chunk of text at a given byte offset and row/column position. The function can return text encoded in either UTF8 or UTF16. This interface allows you to efficiently parse text that is stored in your own data structure.
The `TSInput` structure lets you provide your own function for reading a chunk of text at a given byte offset and row/column position. The function can return text encoded in either UTF8 or UTF16. This interface allows you to efficiently parse text that is stored in your own data structure.
```c
typedef struct {

2
docs/section-3-creating-parsers.md
View file

@ -5,7 +5,7 @@ permalink: creating-parsers
# Creating parsers
Developing Tree-sitter grammars can have a difficult learning curve, but once you get the hang of it, it can be fun and even zen-like. This document will help get you to get started and to develop a useful mental model.
Developing Tree-sitter grammars can have a difficult learning curve, but once you get the hang of it, it can be fun and even zen-like. This document will help you to get started and to develop a useful mental model.
## Getting Started