Skip to content

Commit 87c4df3

Browse files
committed
docs: add favicon and logo
1 parent dda45cf commit 87c4df3

File tree

3 files changed

+13
-16
lines changed

3 files changed

+13
-16
lines changed

docs/src/SUMMARY.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
# Summary
22

3-
Tree-sitter is a parser generator tool and an incremental parsing library. It can build a concrete syntax tree for a source
4-
file and efficiently update the syntax tree as the source file is edited. Tree-sitter aims to be:
5-
6-
General enough to parse any programming language
7-
Fast enough to parse on every keystroke in a text editor
8-
Robust enough to provide useful results even in the presence of syntax errors
9-
Dependency-free so that the runtime library (which is written in pure C) can be embedded in any application
10-
113
[Introduction](./index.md)
124

135
# User Guide

docs/src/index.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1+
<div style="display: flex; justify-content: center; margin-left: 32px;">
2+
<a href="./"><img src="assets/images/tree-sitter-small.png" width="200" height="200" alt="Tree-sitter logo" /></a>
3+
</div>
4+
15
# Introduction
26

3-
Tree-sitter is a parser generator tool and an incremental parsing library. It can build a concrete syntax tree for a source file and efficiently update the syntax tree as the source file is edited. Tree-sitter aims to be:
7+
Tree-sitter is a parser generator tool and an incremental parsing library. It can build a concrete syntax tree for a source
8+
file and efficiently update the syntax tree as the source file is edited. Tree-sitter aims to be:
49

510
- **General** enough to parse any programming language
611
- **Fast** enough to parse on every keystroke in a text editor
712
- **Robust** enough to provide useful results even in the presence of syntax errors
813
- **Dependency-free** so that the runtime library (which is written in pure [C11](https://github.com/tree-sitter/tree-sitter/tree/master/lib)) can be embedded in any application
914

10-
### Language Bindings
15+
## Language Bindings
1116

12-
There are currently bindings that allow Tree-sitter to be used from the following languages:
17+
There are bindings that allow Tree-sitter to be used from the following languages:
1318

14-
#### Official
19+
### Official
1520

1621
- [C#](https://github.com/tree-sitter/csharp-tree-sitter)
1722
- [Go](https://github.com/tree-sitter/go-tree-sitter)
@@ -24,7 +29,7 @@ There are currently bindings that allow Tree-sitter to be used from the followin
2429
- [Rust](https://github.com/tree-sitter/tree-sitter/tree/master/lib/binding_rust)
2530
- [Zig](https://github.com/tree-sitter/zig-tree-sitter)
2631

27-
#### Third-party
32+
### Third-party
2833

2934
- [Delphi](https://github.com/modersohn/delphi-tree-sitter)
3035
- [ELisp](https://www.gnu.org/software/emacs/manual/html_node/elisp/Parsing-Program-Source.html)
@@ -42,7 +47,7 @@ There are currently bindings that allow Tree-sitter to be used from the followin
4247
- [Ruby](https://github.com/calicoday/ruby-tree-sitter-ffi)
4348
- [Swift](https://github.com/ChimeHQ/SwiftTreeSitter)
4449

45-
### Parsers
50+
## Parsers
4651

4752
The following parsers can be found in the upstream organization:
4853

@@ -73,13 +78,13 @@ The following parsers can be found in the upstream organization:
7378

7479
A list of known parsers can be found in the [wiki](https://github.com/tree-sitter/tree-sitter/wiki/List-of-parsers).
7580

76-
### Talks on Tree-sitter
81+
## Talks on Tree-sitter
7782

7883
- [Strange Loop 2018](https://www.thestrangeloop.com/2018/tree-sitter---a-new-parsing-system-for-programming-tools.html)
7984
- [FOSDEM 2018](https://www.youtube.com/watch?v=0CGzC_iss-8)
8085
- [GitHub Universe 2017](https://www.youtube.com/watch?v=a1rC79DHpmY)
8186

82-
### Underlying Research
87+
## Underlying Research
8388

8489
The design of Tree-sitter was greatly influenced by the following research papers:
8590

docs/theme/favicon.png

2.31 KB
Loading

0 commit comments

Comments
 (0)