From 87c4df3ff3d9bbe5c5079d594e7a799c420e656b Mon Sep 17 00:00:00 2001 From: Amaan Qureshi Date: Wed, 25 Dec 2024 15:28:32 -0500 Subject: [PATCH] docs: add favicon and logo --- docs/src/SUMMARY.md | 8 -------- docs/src/index.md | 21 +++++++++++++-------- docs/theme/favicon.png | Bin 0 -> 2364 bytes 3 files changed, 13 insertions(+), 16 deletions(-) create mode 100644 docs/theme/favicon.png diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index f7d6331b..772eccec 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,13 +1,5 @@ # Summary -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: - -General enough to parse any programming language -Fast enough to parse on every keystroke in a text editor -Robust enough to provide useful results even in the presence of syntax errors -Dependency-free so that the runtime library (which is written in pure C) can be embedded in any application - [Introduction](./index.md) # User Guide diff --git a/docs/src/index.md b/docs/src/index.md index 9689d1df..5d5cb0ea 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,17 +1,22 @@ +
+ Tree-sitter logo +
+ # Introduction -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: +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: - **General** enough to parse any programming language - **Fast** enough to parse on every keystroke in a text editor - **Robust** enough to provide useful results even in the presence of syntax errors - **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 -### Language Bindings +## Language Bindings -There are currently bindings that allow Tree-sitter to be used from the following languages: +There are bindings that allow Tree-sitter to be used from the following languages: -#### Official +### Official - [C#](https://github.com/tree-sitter/csharp-tree-sitter) - [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 - [Rust](https://github.com/tree-sitter/tree-sitter/tree/master/lib/binding_rust) - [Zig](https://github.com/tree-sitter/zig-tree-sitter) -#### Third-party +### Third-party - [Delphi](https://github.com/modersohn/delphi-tree-sitter) - [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 - [Ruby](https://github.com/calicoday/ruby-tree-sitter-ffi) - [Swift](https://github.com/ChimeHQ/SwiftTreeSitter) -### Parsers +## Parsers The following parsers can be found in the upstream organization: @@ -73,13 +78,13 @@ The following parsers can be found in the upstream organization: A list of known parsers can be found in the [wiki](https://github.com/tree-sitter/tree-sitter/wiki/List-of-parsers). -### Talks on Tree-sitter +## Talks on Tree-sitter - [Strange Loop 2018](https://www.thestrangeloop.com/2018/tree-sitter---a-new-parsing-system-for-programming-tools.html) - [FOSDEM 2018](https://www.youtube.com/watch?v=0CGzC_iss-8) - [GitHub Universe 2017](https://www.youtube.com/watch?v=a1rC79DHpmY) -### Underlying Research +## Underlying Research The design of Tree-sitter was greatly influenced by the following research papers: diff --git a/docs/theme/favicon.png b/docs/theme/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..945fa841d081ece224a37d1be8777030102e5de0 GIT binary patch literal 2364 zcmeAS@N?(olHy`uVBq!ia0y~yU{C;I4mJh`hT^KKFANL}oCO|{#S9F5M?jcysy3fA z0|Uo9PZ!6Kh}NakGJEERN*=F&zUTJd@3rr(iqn@~p6S<~x5eiq!`6h;VJx0nZ4DiP z%>q-8W;pSz2y8yhzDV#-l8Bwdg^U0tE+(!H2}a*Yt}Ro_GEVzg&z*VhOzg9F@2mb8 z+*P}<<-p`UmM14a|8xHToag`NeZKxf;Nnd0*(cYS7F>><{_oQ&{T`b;TUBmPfA6Jf zyWyLtx9Hcz4Sj7EcMp{+@BKSHw)~v;>9EqT7Bg9#IHm+$c{bao;(YOao%7e`&6=z6 z+Udn)j)@;^=WjkI|H6Jpb(dF7x3|#(m-+ z-km%2`nCD`n47Ci7r#rLdoFqZzw5P59rgM3|K?r{Go7*TEF8Yh9j$ZHB#szcE)h^*(O5Apt7W3oWtF(o z&%cV7{eKZ|U-72h-SEp~T{+i@d;YCHtpAp;yd<{x@-Dah_%oTI-VvPbX-iuKCSCY` zVXcG{N6(JEKN9*ilxCLprK%rKt9X3W_OZ^oKM!6+&w91%&#kBZYvb;3cFa(lr6;b| z!9Q=<(}J?>#@*qWM z=kxisDcT>VyRsC$Y^i*Cb*}%H^(XRAY>CudD&my2LgPrb>58f86KDCY+ADq6fU{}B z&68S6T9=JYTvjcfUA(=7S-?b^p`ww$VXBX8BG2At*|$Gqg`@j~E--}YyuNrn&&S?; z)6VaccC3v)-XEpd;^5Kg@L;E4-rANfr;^K0?pgnDTsCvf?gY~`o5D?bLRIgY5|*a? z|Mu4A$K>VvgJynDWB4+W+v>cuo&E3GOPy~%oV;cF$BRn;Ym#I-A8n40x{Tav8`V|xkR;Q;I zhh1E)zAgK6@u$F)=n_ zX>oBliyywyd5B}>%lE=BH;T0|YH@Ma^dBfbx$Wk(+g$d6tE=j-Yl-In`>^mVbb!P$?xa|>zsGQ0wpf33Ks}!3gQ+IHR?^Z{=!qDHc7Lvaov-Wx#uDfV?L``|l)Jl(6TaG<9yp?OzyjQ~g-y{v5%xT>_daZ&V zf1YRd>s{j`Xa0XltJhu3ow1-VX5lWuqKrG~Is4CZpZ~E$dQ#k3HQ_4;CL1O%IG(tS zb9Hs+b-ospGZXgAQ_NgykS?FFOra z2{s>p5qICqD>4{P?zmX@&Ev;i<6l!Rd})on#dpL|A|^}VytzQA=h_J6yEprmWzLx8 zZMO2^X&po1qL&QXm))cHHHUxiU!271b$Pep8jCQcQlIEN?S$joKDy7ZO8H-Ey!q-T z7LCx^#gl`79q!d?VRX58Xh!U#$uBY&Ev-G(sV1B{W0r-F$o3hgzbal#Wx0Ih!yFyq zt1O)AtwCM;?Y_$O|6eB~$~AM*=YM)u|NVaajg|FzMM-s1eKu}R9V_;p z-J_iMa@VrUi4scBE48|go?vBs8YH+ki07JV&64P;KOXAj=4Ni|DG{uco7k~A<)y&P zoW7euthe*t`Kr9#yK~!5?QgmDvr6h%e}DT?pJTe}>Ge3hn);+YMOp48U#Ar>ozk>b zdfk(Szu!+jT4X%+Ke}$B>Gr#Yi$twe8-tH7Q+(aHPQ-kD#O7%^)$^tZGbh|W*KEK4 z|M~TGze@_Atn{|CShniZ$p|Gs9kF;8;Wn9H1{TX*4{UsVX+lxp+PMZwhc7r93*0J9 zRy8dwO8yYY=`iK>8`C^{!^vBpMy`{d5Rh6TD0iCOamO;<$8)Z{sZ(Lvy36|ck`CUv znY`LdpWOO)B{hBC!#@=%kJVNg_2BilvM=X*YA$wVX}iwzYU#5(yNb>AcP@I}^CWG3T}JXU-{LnRZ3bTqlRekW z>V22>qpkm%u=`K8I$w8llax(v2Ja`$>j-|EAvh)W%r=%qxf^9>@y>tQd^Pv+`)U6_ z9Gd*QUY}vxy$!#XJEw20-MjeuNy)Zj$2mhe1S0=Vc@^aK@!h$bu~H7{;d^AtlLB{M zFbT?B?QU-O>1%_>iOFVRvWC*`yl>7d{I&T%`{Z?x9Dd9&v}RynVDNPHb6Mw<&;$Tn C`k)B_ literal 0 HcmV?d00001