Commit graph

381 commits

Author SHA1 Message Date
Max Brunsfeld f38f5d1d22 Tweak readmes 2020-05-12 16:16:48 -07:00
Max Brunsfeld f6f96f3503 Document the new query syntax 2020-05-11 14:24:00 -07:00
Max Brunsfeld a04d688d38
docs: Add a link to tree-sitter-wasm
Closes #605
2020-05-06 09:34:23 -07:00
Danny Mösch 4c0fa297d8
Fix typos in docu section about highlighting (#591) 2020-04-07 13:27:30 -07:00
Ronan Cherrueau ⚓ b65582797a
Fix the Getting Started example in docs (#588)
Running the first example of the Getting Started failed with:

  main: Assertion `strcmp(ts_node_type(root_node), "value") == 0' failed.

The cause is the json parser that renamed the entry rule from `value` to
`document` in commit tree-sitter/tree-sitter-json@1e4abcc. This commit
update the example in docs to fix the assert.
2020-04-03 11:35:31 -07:00
Alexander Eyers-Taylor 5670dd6705
Add QL to the playground (#558) 2020-03-03 13:46:20 -08:00
Max Brunsfeld f2e9e3b3f2 docs: Link to semantic dir instead of codegen PR 2020-03-02 09:38:25 -08:00
dependabot[bot] 8c95c7648b
build(deps): bump nokogiri from 1.8.2 to 1.10.8 in /docs
Bumps [nokogiri](https://github.com/sparklemotion/nokogiri) from 1.8.2 to 1.10.8.
- [Release notes](https://github.com/sparklemotion/nokogiri/releases)
- [Changelog](https://github.com/sparklemotion/nokogiri/blob/master/CHANGELOG.md)
- [Commits](https://github.com/sparklemotion/nokogiri/compare/v1.8.2...v1.10.8)

Signed-off-by: dependabot[bot] <support@github.com>
2020-02-25 09:57:14 +00:00
Max Brunsfeld 3cd05a3d0c Link to Semantic in node-types docs 2020-02-24 11:21:05 -08:00
Max Brunsfeld f1e4104d47 Document supertypes and the node-types file
References #542
References #524
Closes #393
2020-02-24 11:12:42 -08:00
Max Brunsfeld 8d26da7b03 Add highlight subcommand to docs section w/ all subcommands 2020-02-21 13:11:40 -08:00
Max Brunsfeld a76a232485 Add unit testing docs 2020-02-21 12:58:41 -08:00
Max Brunsfeld 709ddfebe9 docs: Add explanation of syntax highlighting configuration for CLI 2020-02-21 11:39:27 -08:00
Max Brunsfeld 1ce42a04a7 Add docs about injection query properties 2020-02-20 15:34:35 -08:00
Max Brunsfeld 17071267e3 docs: Start work on docs for injection queries 2020-02-20 14:38:37 -08:00
Max Brunsfeld cf80f094ac docs: Expand local variable highlighting section 2020-02-20 09:35:46 -08:00
Max Brunsfeld 92f060303c docs: First draft of highlight query section, start local var section 2020-02-20 09:35:46 -08:00
Max Brunsfeld 2a8860542c Add intro to syntax highlighting docs 2020-02-20 09:35:46 -08:00
Max Brunsfeld 579b8e8d28 Rename files to make room for syntax highlighting section 2020-02-20 09:35:46 -08:00
Max Brunsfeld ca73cba5f0 Make underline-on-hover work for spans within links
Refs #535
2020-02-12 16:06:50 -08:00
Max Brunsfeld 1f53b7aba8
Merge pull request #536 from kramred/docs/external_link_icon_CC0
Modify styles to show icon for external links
2020-02-12 11:59:29 -08:00
Mark Schmitz 23b88b6ac4 Modify styles to show icon for external links
Icon is CC0, copyright by https://github.com/kramred
2020-02-12 19:40:43 +00:00
Mark Schmitz 3dafb373a8 Add hyperlink to github repo below img of tree
in sidebar, as suggested in https://github.com/tree-sitter/tree-sitter/issues/508
2020-02-12 16:20:03 +00:00
Max Brunsfeld 70e2a2c025 Add PHP parser to web playground 2020-01-17 13:30:02 -08:00
Max Brunsfeld 82a8b15714 docs: Add C# parser to the playground 2019-12-02 14:00:26 -08:00
Max Brunsfeld 7ee65222d3 docs: Consider C# to be fairly complete 2019-12-02 13:54:24 -08:00
Mark Schmitz 3fbe0be6e2
Fix small typo in docs 2019-12-02 13:05:41 +00:00
akiyosi 1742f32fcc Fix link to contributing docs 2019-11-28 22:07:32 +09:00
Max Brunsfeld 079aa26a99 Link to docs.rs from docs site 2019-11-08 14:31:24 -08:00
Max Brunsfeld a506ceec3f Link to contributing docs from installation section of docs
Refs #478
2019-11-04 12:50:43 -08:00
Max Brunsfeld 5a3a672e30 Expand on query docs 2019-10-30 10:26:10 -07:00
Max Brunsfeld d5dc4bbcaa Fix some errors in new query docs 2019-10-28 17:32:10 -07:00
Max Brunsfeld 6146c39b0a Add information about queries on the docs site 2019-10-28 17:19:57 -07:00
Matthew Krupcale 5ae89f5133 docs: fix lookahead type (#462)
The `TSLexer` struct uses signed integer `int32_t` for the `lookahead` Unicode code point.

 * docs/section-3-creating-parsers.md: fix `lookahead` type
2019-10-14 12:08:24 -07:00
Matthew Krupcale ee9a3c0ebb lib: remove utf8proc dependency (#436)
* Remove dependency on utf8proc

This removes the only external dependency on utf8proc for UTF-8 decoding. It does so by implementing its own UTF-8 decoder. This decoder is both faster and has a simpler API.

 * .gitmodules: remove utf8proc submodule
 * docs/section-2-using-parsers.md: remove requirement for utf8proc submodule
 * docs/section-6-contributing.md: likewise
 * lib/Cargo.toml: remove utf8proc subdirectory package include
 * lib/README.md: remove utf8proc subdirectory description
 * lib/binding_rust/build.rs: remove utf8proc compiler include directory
 * lib/src/lexer.c: remove utf8proc dependencies and types
 * lib/src/lib.c: remove utf8proc dependency
 * lib/src/unicode.h: define types for Unicode decoders
 * lib/src/utf16.{c,h}: implement more readable UTF-16 decoder
 * lib/src/utf8.{c,h}: implement fast UTF-8 decoder
 * lib/utf8proc: remove utf8proc submodule directory
 * script/build-lib: remove utf8proc compiler include directory
 * script/build-wasm: likewise

* Optimize ts_lexer__get_lookahead.

Try to favor non-failure code path and assign lookahead values directly to lexer

 * lib/src/lexer.c: optimize for non-failure code path

* Fix some compiler errors

 * lib/src/lexer.c: cast from signed to unsigned for decode_next result
 * lib/src/utf16.c: fix non-constant initializers for older compilers

* Remove some missed remnants of utf8proc

 * docs/section-2-using-parsers.md: only two include paths necessary now
 * lib/src/lib.c: no need to define UTF8PROC_STATIC

* Use ICU's utf8 and utf16 decoding routines

* Remove unnecessary casts when calling icu macros

* Check buffer length before attempting to decode a unicode character

* Use new unicode function when parsing Queries

Co-Authored-By: Matthew Krupcale <mkrupcale@matthewkrupcale.com>

* Mark libicu files as vendored for GitHub's stats
2019-10-14 11:18:39 -07:00
Rob Rix 20bb99249b Fix a typo in the docs. (#457) 2019-10-04 14:49:19 -07:00
dependabot[bot] 10c6144e83 Bump rubyzip from 1.2.1 to 2.0.0 in /docs (#459)
Bumps [rubyzip](https://github.com/rubyzip/rubyzip) from 1.2.1 to 2.0.0.
- [Release notes](https://github.com/rubyzip/rubyzip/releases)
- [Changelog](https://github.com/rubyzip/rubyzip/blob/master/Changelog.md)
- [Commits](https://github.com/rubyzip/rubyzip/compare/v1.2.1...v2.0.0)

Signed-off-by: dependabot[bot] <support@github.com>
2019-10-04 14:48:53 -07:00
Ika 825a816ee7 docs: add Vue parser 2019-10-04 20:38:01 +08:00
Ika d54fe98334 docs: add Markdown parser 2019-09-30 20:10:37 +08:00
Max Brunsfeld 9ce3a53427 Precompute tree edits in playground script 2019-09-23 17:01:35 -07:00
Max Brunsfeld 10fb9b0e20 Fix playground HTML, tweak playground colors 2019-09-18 18:03:15 -07:00
Max Brunsfeld a1fec71b19 Tweak QueryCursor to allow iterating either matches or captures
For syntax highlighting, we want to iterate over all of the captures in 
order, and don't care about grouping the captures by pattern.
2019-09-13 15:19:04 -07:00
Max Brunsfeld f08767c482 Add tree query editor to web UI and playground 2019-09-12 14:07:17 -07:00
Max Brunsfeld 0528ad5f58 playground: Persist state across reloads 2019-09-12 08:49:19 -07:00
Max Brunsfeld 4151a428ec docs: Add link to WIP swift grammar 2019-09-06 09:18:30 -07:00
Max Brunsfeld f9a3998029 docs: Start adding info about field names 2019-09-05 15:43:10 -07:00
Max Brunsfeld 3b10999808 Add TOML and YAML to the web playground 2019-08-31 12:29:52 -07:00
Ika 2cf2293b1f
docs: add YAML/TOML parser 2019-09-01 02:30:11 +08:00
Max Brunsfeld 5882bcf531 Add TypeScript parser to the playground 2019-08-30 22:20:53 -07:00
Max Brunsfeld fd80d60ae8 web playground: don't include editor.getValue() call in parse time 2019-08-30 21:06:57 -07:00
Simon Repp 8657054e4b Add tree-sitter-eno to available completed parsers (#413) 2019-08-05 14:19:29 -07:00
zimbatm 15629f1231 index.md: add the tree-sitter-nix parser (#403) 2019-08-01 15:34:05 -07:00
Simon Repp ee253e340b Mention differing alias behavior based on argument types in the docs (#405)
* Fix broken link to named-vs-anonymous section in unit tests section

* Mention differing alias behavior based on argument types in the docs
2019-08-01 15:30:50 -07:00
Max Brunsfeld 71275b34f0 Show field names in wasm playground 2019-07-10 14:43:05 -05:00
Max Brunsfeld eb0d9af577 docs: Declare Java parser to be fairly complete 2019-07-09 16:50:18 -05:00
Max Brunsfeld fcd8913233 Add link to the Contributor Covenant 2019-06-20 15:27:56 -07:00
Max Brunsfeld aec2ca2da7 Make the playground the last page on the docs site 2019-06-20 15:27:35 -07:00
Max Brunsfeld b2e3105acb Add verilog and systemrdl grammars to the docs 2019-06-13 11:51:53 -07:00
francisfuzz ec7def2e62
s/Ucsing/Using 2019-05-31 13:06:39 -07:00
Max Brunsfeld 7530b0f77a Add link to lua parser in the docs 2019-05-31 09:20:49 -07:00
Max Brunsfeld 85fa31d972 Mention wasm tests in contributing doc 2019-05-31 09:18:34 -07:00
Razzeee 53b30af003
Add elm tree sitter 2019-05-31 13:25:14 +02:00
Max Brunsfeld 2f06abf984 Start work on contributing guide 2019-05-30 17:53:20 -07:00
Chris Charles 9ce9a53298 Reorder objects in documentation for consistency
The documentation lists four types of objects, the C names for them,
and a summary for each. These are now shown in the same order.
2019-05-21 07:52:23 -04:00
Max Brunsfeld a1ed12f4f4 Start work on web UI command 2019-05-13 21:51:17 -07:00
Andrew Craig bcc823984e Update doc example program file locations
Update doc example program compilation instructions to be consistent
with directory structure.
2019-05-08 21:03:16 +09:00
Max Brunsfeld 3fc459a84b Reorganize language bindings
* Move rust binding: lib/binding -> lib/binding_rust
* Move wasm bindinig: lib/web -> lib/binding_web
* Add wasm readme
2019-05-07 10:41:49 -07:00
Max Brunsfeld a3ceb8f3a5
Add link to Strange Loop talk in main docs page 2019-05-07 09:23:52 -07:00
Max Brunsfeld a0390218a8 Give playground page a more specific title 2019-05-01 14:11:58 -07:00
Max Brunsfeld 73e4db41b0 Render syntax tree efficiently in docs playground 2019-04-30 11:55:30 -07:00
Max Brunsfeld 73e1512555 Fix playground script URL in docs site 2019-04-27 17:54:14 -07:00
Max Brunsfeld 4febbc43f6 In docs playground, scroll tree whenever cursor moves 2019-04-27 17:32:07 -07:00
Max Brunsfeld e39d69dfa7 Add a playground to the docs site 2019-04-26 13:36:28 -07:00
Max Brunsfeld 5035e194ff Merge branch 'master' into node-fields 2019-03-26 11:58:21 -07:00
Justin Woo 6f804fd2e2 fix example snippet in creating parsers docs 2019-03-24 14:37:43 +02:00
Max Brunsfeld d51cd86a3a Update available bindings section of docs 2019-03-22 14:20:35 -07:00
Jacob Mitchell c8d040ca26 Use 1-indexed rows in CLI and log output (resolves #287) 2019-03-14 22:21:19 -07:00
Max Brunsfeld f52271352b Merge branch 'master' into node-fields 2019-03-05 08:08:05 -08:00
Max Brunsfeld 92e9f984ed Fix small docs errors 2019-02-22 09:44:25 -08:00
Max Brunsfeld 190b219be5 Document external scanners
Fixes #281
2019-02-22 09:35:29 -08:00
Max Brunsfeld 2249ddb687 docs: Adjust intro, remove mentions of node-gyp, npm install 2019-02-21 16:41:52 -08:00
Max Brunsfeld af44147157 docs: Fix references to runtime.h, libruntime.a 2019-02-21 16:41:22 -08:00
Max Brunsfeld 8edb6927d0 Update docs after Rust conversion 2019-02-05 11:34:01 -08:00
Max Brunsfeld 23837adac1 Fix editing documentation, add note about ts_node_edit
Fixes #242
2018-11-27 11:31:22 -08:00
Max Brunsfeld 47918070f6 Add a single-source file way of building the runtime library 2018-11-13 15:36:21 -08:00
Tobias Bieniek 1602e9f06a
docs: Add missing ) to test code 2018-11-02 14:33:12 +01:00
Max Brunsfeld dc6d659fcf
Add CSS parser to the list in the docs 2018-10-30 09:36:45 -07:00
vzvu3k6k 87448aa534 Fix assetion of an example program
test-json-parser fails:
    test-json-parser.c:42: int main():
    Assertion `ts_node_child_count(array_node) == 4' failed.

`array_node` has five nodes: ([), (number), (,), (null), (]).
2018-10-25 02:20:10 +09:00
Max Brunsfeld 25797cad5f Add favicon to docs site 2018-09-12 20:29:24 -07:00
Max Brunsfeld 9e13912db3 Tweak docs for multi-language documents 2018-09-12 20:11:35 -07:00
Max Brunsfeld 1878b425de Add documentation about included ranges 2018-09-12 17:54:52 -07:00
Max Brunsfeld 7661d08127 Flesh out keyword extraction discussion 2018-09-09 18:47:31 -07:00
Max Brunsfeld 07065e3580 Mention lexical conflict resolution w/ strings vs regexes 2018-09-09 18:47:31 -07:00
Max Brunsfeld a4383d17d1 Reference named/anonymous node section when explaining test s-exps 2018-09-09 18:47:31 -07:00
Max Brunsfeld d6cc98c644 Remove leading $ from shell code blocks 2018-09-09 18:47:31 -07:00
Max Brunsfeld b0fb31dc5f Recommend using npm init/npm install to generate the package.json 2018-09-09 18:47:30 -07:00
Max Brunsfeld de0e8a39a2 Expand using parsers section of the docs 2018-08-14 12:13:10 -07:00
Max Brunsfeld 87ad0fb9c2 Expand using parsers document 2018-08-13 18:04:10 -07:00
Orhan Toy 9795aa16c4 [ci skip] Fix typo (#189) 2018-07-28 16:14:59 -07:00
Jamie 2384234aea
Fix rules docs 2018-07-20 16:58:50 -07:00
Max Brunsfeld 308016b776 Clarify runtime vs parser generator in README
Fixes #182
2018-07-10 14:09:22 -07:00
Max Brunsfeld 531f2f48b1 Update list of available parsers 2018-07-05 16:45:27 -07:00
Max Brunsfeld be81989de2 Improve implementation page of docs 2018-06-20 09:49:23 -07:00
Max Brunsfeld 196d7f1355 Update sentence about TSInput in docs 2018-06-19 11:15:01 -07:00
Max Brunsfeld 2a2e5032d4 Fix links in docs 2018-06-14 15:27:28 -07:00
Max Brunsfeld f42cb877f3 Improve docs for lexing, keyword handling
Co-Authored-By: Ashi Krishnan <queerviolet@github.com>
2018-06-14 13:18:48 -07:00
Max Brunsfeld 587d1a740a Docs - give motivation and code example for keyword optimization 2018-06-14 10:29:03 -07:00
Max Brunsfeld 121dd15bda Docs - don't create TOC entries for h4 headers 2018-06-14 10:27:31 -07:00
Max Brunsfeld e17cd42e47 Perform keyword optimization using explicitly selected word token
rather than trying to infer the word token automatically.

Co-Authored-By: Ashi Krishnan <queerviolet@github.com>
2018-06-14 09:35:54 -07:00
Max Brunsfeld 0e487011c0 Add agda parser to the list on the docs site 🙇 @banacorn 2018-06-13 10:03:22 -07:00
Max Brunsfeld 0895ca237d Merge branch 'master' into pike-doc-extras-default 2018-06-13 09:42:22 -07:00
Max Brunsfeld 0aef70028a Dismiss docs sidebar when scrolling left on mobile 2018-06-12 19:59:30 -07:00
Max Brunsfeld 9eab5a29d9 Make docs hamburger button partially transparent 2018-06-12 18:06:07 -07:00
Max Brunsfeld 3a631616c0 Include project name in all docs page titles 2018-06-12 18:03:54 -07:00
Max Brunsfeld 10dcf050d6 Tweak docs styling, add serve-docs script 2018-06-12 17:58:38 -07:00
Max Brunsfeld 5b18fe672b Link to the documentation site from the README 2018-06-12 17:43:55 -07:00
Max Brunsfeld a7ffbd022f Make docs page readable on mobile 2018-06-12 17:43:55 -07:00
Max Brunsfeld d1665da21c Add docs 2018-06-11 19:17:10 -07:00
Max Brunsfeld 7ad50f2731 Start fleshing out docs site 2018-06-10 14:44:33 -07:00
Axel Hecht fb5c79aa32 make default extras explicit in docs 2018-04-04 10:59:13 +02:00
Yudai NAKATA b9a1993bc5 Suggest the use of devDependencies in a parser
Fix #146. [ci skip]
2018-03-17 17:11:40 +09:00
Ayman Nadeem 94815a703b
small unit test protip 2018-03-14 15:07:09 -07:00
Max Brunsfeld daf2c01d8b Add docs section about hidden rules 2018-03-05 09:35:52 -08:00
Max Brunsfeld fd77bf49a3 Add explanation of alias function in parsers doc 2018-03-02 11:09:53 -08:00
Max Brunsfeld dbecd9521f Add table of contents to docs pages 2018-02-26 17:42:42 -08:00
Max Brunsfeld b357ecd9b8 Describe DSL, precedence in parsers doc
[ci skip]
2018-02-26 13:55:13 -08:00
Max Brunsfeld 70cd827f3c Talk about tree-sitter generate command in parsers doc
[ci skip]
2018-02-26 11:37:22 -08:00
Max Brunsfeld a8d198f77c Expand the creating-parsers document
[ci skip]
2018-02-26 11:19:45 -08:00
Max Brunsfeld a7d49b4d98 Fix wording in creating-parsers doc 2018-02-26 00:43:34 -08:00
Max Brunsfeld e3e7c8ed9d Start work on grammar writing doc
[ci skip]
2018-02-26 00:38:54 -08:00
Max Brunsfeld a2aa64ec97 Start work on github pages site
[ci skip]
2018-02-24 21:39:33 -08:00