diff options
| author | Christian Clason <c.clason@uni-graz.at> | 2024-01-20 11:15:16 +0100 |
|---|---|---|
| committer | Christian Clason <c.clason@uni-graz.at> | 2024-01-21 12:04:42 +0100 |
| commit | 6806d7a783e3b7a3bfe775e5f8b9d2b66539fdbe (patch) | |
| tree | 37d69b8d5c204d5f734bd592c1e1b404724fe209 /CONTRIBUTING.md | |
| parent | feat(perl): add more highlights (diff) | |
| download | nvim-treesitter-6806d7a783e3b7a3bfe775e5f8b9d2b66539fdbe.tar nvim-treesitter-6806d7a783e3b7a3bfe775e5f8b9d2b66539fdbe.tar.gz nvim-treesitter-6806d7a783e3b7a3bfe775e5f8b9d2b66539fdbe.tar.bz2 nvim-treesitter-6806d7a783e3b7a3bfe775e5f8b9d2b66539fdbe.tar.lz nvim-treesitter-6806d7a783e3b7a3bfe775e5f8b9d2b66539fdbe.tar.xz nvim-treesitter-6806d7a783e3b7a3bfe775e5f8b9d2b66539fdbe.tar.zst nvim-treesitter-6806d7a783e3b7a3bfe775e5f8b9d2b66539fdbe.zip | |
docs(contributing): typos and examples
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca681832a..25c13edfb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ If you haven't already, you should really come and reach out to us on our As you know, `nvim-treesitter` is roughly split in two parts: - Parser configurations : for various things like `locals`, `highlights` -- What we like to call _modules_ : tiny lua modules that provide a given feature, based on parser configurations +- What we like to call _modules_ : tiny Lua modules that provide a given feature, based on parser configurations Depending on which part of the plugin you want to contribute to, please read the appropriate section. @@ -63,7 +63,7 @@ Here are some global advices: you can install the [playground plugin](https://github.com/nvim-treesitter/playground). - If your language is listed [here](https://github.com/nvim-treesitter/nvim-treesitter#supported-languages), you can debug and experiment with your queries there. -- If not, you should consider installing the [tree-sitter cli](https://github.com/tree-sitter/tree-sitter/tree/master/cli), +- If not, you should consider installing the [tree-sitter CLI](https://github.com/tree-sitter/tree-sitter/tree/master/cli), you should then be able to open a local playground using `tree-sitter build-wasm && tree-sitter web-ui` within the parsers repo. - Examples of queries can be found in [queries/](queries/) @@ -93,7 +93,7 @@ Should you need to preserve a specific format for a node, you can exempt it (and ### Highlights -As languages differ quite a lot, here is a set of captures available to you when building a `highlights.scm` query. Note that your colorscheme needs to define (or link) these captures as highlight groups. +As languages differ quite a lot, here is a set of captures available to you when building a `highlights.scm` query. Note that your color scheme needs to define (or link) these captures as highlight groups. #### Identifiers @@ -205,8 +205,8 @@ Mainly for markup languages. ```query @markup.strong ; bold text -@markup.italic ; text with emphasis -@markup.strikethrough ; strikethrough text +@markup.italic ; italic text +@markup.strikethrough ; struck-through text @markup.underline ; underlined text (only for literal underline markup!) @markup.heading ; headings, titles (including markers) @@ -219,7 +219,7 @@ Mainly for markup languages. @markup.link.label ; link, reference descriptions @markup.link.url ; URL-style links -@markup.raw ; literal or verbatim text (e.g., inline code) +@markup.raw ; literal or verbatim text (e.g. inline code) @markup.raw.block ; literal or verbatim text as a stand-alone block ; (use priority 90 for blocks with injections) @@ -235,9 +235,9 @@ Mainly for markup languages. ``` ```query -@tag ; XML tag names -@tag.attribute ; XML tag attributes -@tag.delimiter ; XML tag delimiters +@tag ; XML-style tag names (and similar) +@tag.attribute ; XML-style tag attributes +@tag.delimiter ; XML-style tag delimiters ``` #### Non-highlighting captures |
