helix-mods/book/src/SUMMARY.md

# Summary

[Helix](./title-page.md)

- [Installation](./install.md)
  - [Package Managers](./package-managers.md)
  - [Building from source](./building-from-source.md)
- [Usage](./usage.md)
  - [Registers](./registers.md)
  - [Surround](./surround.md)
  - [Textobjects](./textobjects.md)
  - [Syntax aware motions](./syntax-aware-motions.md)
  - [Pickers](./pickers.md)
  - [Keymap](./keymap.md)
  - [Commands](./commands.md)
  - [Language support](./lang-support.md)
- [Migrating from Vim](./from-vim.md)
- [Configuration](./configuration.md)
  - [Editor](./editor.md)
  - [Themes](./themes.md)
  - [Key remapping](./remapping.md)
  - [Languages](./languages.md)
- [Guides](./guides/README.md)
  - [Adding languages](./guides/adding_languages.md)
  - [Adding textobject queries](./guides/textobject.md)
  - [Adding indent queries](./guides/indent.md)
  - [Adding injection queries](./guides/injection.md)
Add book/ (mdbook based user guide) 2021-04-05 08:18:43 +02:00			`# Summary`

Deploy docs for master separately (#1783) * Deploy docs for master separately * Output docs for every tagged release * Update .github/workflows/gh-pages.yml Co-authored-by: Blaž Hrastnik <blaz@mxxn.io> 2022-03-14 03:46:40 +01:00			`[Helix](./title-page.md)`

Add book/ (mdbook based user guide) 2021-04-05 08:18:43 +02:00			`- [Installation](./install.md)`
Improve the structure of the documentation (#10619) 2024-05-06 17:39:06 +02:00			`- [Package Managers](./package-managers.md)`
			`- [Building from source](./building-from-source.md)`
Add book/ (mdbook based user guide) 2021-04-05 08:18:43 +02:00			`- [Usage](./usage.md)`
Improve the structure of the documentation (#10619) 2024-05-06 17:39:06 +02:00			`- [Registers](./registers.md)`
			`- [Surround](./surround.md)`
			`- [Textobjects](./textobjects.md)`
			`- [Syntax aware motions](./syntax-aware-motions.md)`
Document use of filter columns in pickers (#11218) * Document use of filter columns in pickers. Filtering on columns was implemented in #9647. The only documentation I could find on this feature was the PR itself, and the video demo used a different syntax. * Note that column filters are space-separated. * Note that picker filters can be abbreviated. * Specify correct picker in docs. * Clarify picker filter prefix shortenting. Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Move picker docs to their own section. * Update book/src/pickers.md Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Improve docs on picker registers, keybinds, and syntax. * Clarify wording around picker queries. Co-authored-by: Michael Davis <mcarsondavis@gmail.com> --------- Co-authored-by: Ryan Roden-Corrent <ryan@rcorre.net> Co-authored-by: Michael Davis <mcarsondavis@gmail.com> 2024-07-24 18:25:00 +02:00			`- [Pickers](./pickers.md)`
docs: Auto generate command list 2021-11-17 14:30:11 +01:00			`- [Keymap](./keymap.md)`
			`- [Commands](./commands.md)`
Rewrite and refactor all documentation (#5534) * Rewrite and refactor all documentation * Rewrite and refactor the guides * update runtime directory instructions for windows * Update the Ubuntu 3rd party repo section with 22.10 * Merge from upstream * Rewrite and refactor all documentation * Apply suggestions from code review Apply the suggestions that can be committed from the GitHub web interface. Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Add Windows themes folder Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com> * Apply the rest of the suggestions from the code review * Revert "Apply the rest of the suggestions from the code review" This reverts commit 498be1b7a1aec3ff567b95130148628beeef9b77. * Revert "Merge branch 'rewrite-and-refactor-all-documentation' of github.com:David-Else/helix into rewrite-and-refactor-all-documentation" This reverts commit 7c8404248ffef73b80b9051d5a4359c5bcfa5d1a, reversing changes made to d932969cfc9fadda12a74cc01665919dee7152fb. * Apply code review suggestions * Changes after re-reading all documents * Missed a full stop * Code review suggestions and remove macOS and Windows specific sections * Add OpenBSD to heading * Add back macOS and Windows sections and further simplify and improve * Change wording to nightly * Remove README installation section and turn into a link * Simplify building from source and follow code review suggestions * Code review revisions * Fix copy paste mistake * Apply the latest code review suggestions * More small code review items * Change minor modes for code review * Fix link and typos * Add note that you need a c++ compiler to install the tree-sitter grammars * Add pacman example * Make sure all headings are lower case * Revert to the original passage adding a reference to Windows that was missing * Update book/src/guides/adding_languages.md Fix grammar typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Update book/src/install.md Fix tree sitter typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Remove TOC links to main heading --------- Co-authored-by: CptPotato <3957610+CptPotato@users.noreply.github.com> Co-authored-by: Michael Davis <mcarsondavis@gmail.com> Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com> 2023-03-06 10:27:17 +01:00			`- [Language support](./lang-support.md)`
Add docs for registers, multi key remaps (#557) 2021-08-18 02:53:50 +02:00			`- [Migrating from Vim](./from-vim.md)`
Add book/ (mdbook based user guide) 2021-04-05 08:18:43 +02:00			`- [Configuration](./configuration.md)`
Improve the structure of the documentation (#10619) 2024-05-06 17:39:06 +02:00			`- [Editor](./editor.md)`
Update docs 2021-06-19 13:19:31 +02:00			`- [Themes](./themes.md)`
Rewrite and refactor all documentation (#5534) * Rewrite and refactor all documentation * Rewrite and refactor the guides * update runtime directory instructions for windows * Update the Ubuntu 3rd party repo section with 22.10 * Merge from upstream * Rewrite and refactor all documentation * Apply suggestions from code review Apply the suggestions that can be committed from the GitHub web interface. Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Add Windows themes folder Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com> * Apply the rest of the suggestions from the code review * Revert "Apply the rest of the suggestions from the code review" This reverts commit 498be1b7a1aec3ff567b95130148628beeef9b77. * Revert "Merge branch 'rewrite-and-refactor-all-documentation' of github.com:David-Else/helix into rewrite-and-refactor-all-documentation" This reverts commit 7c8404248ffef73b80b9051d5a4359c5bcfa5d1a, reversing changes made to d932969cfc9fadda12a74cc01665919dee7152fb. * Apply code review suggestions * Changes after re-reading all documents * Missed a full stop * Code review suggestions and remove macOS and Windows specific sections * Add OpenBSD to heading * Add back macOS and Windows sections and further simplify and improve * Change wording to nightly * Remove README installation section and turn into a link * Simplify building from source and follow code review suggestions * Code review revisions * Fix copy paste mistake * Apply the latest code review suggestions * More small code review items * Change minor modes for code review * Fix link and typos * Add note that you need a c++ compiler to install the tree-sitter grammars * Add pacman example * Make sure all headings are lower case * Revert to the original passage adding a reference to Windows that was missing * Update book/src/guides/adding_languages.md Fix grammar typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Update book/src/install.md Fix tree sitter typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Remove TOC links to main heading --------- Co-authored-by: CptPotato <3957610+CptPotato@users.noreply.github.com> Co-authored-by: Michael Davis <mcarsondavis@gmail.com> Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com> 2023-03-06 10:27:17 +01:00			`- [Key remapping](./remapping.md)`
feat(book/src/languages.md) (#979) * feat(book/src/languages.md) Add a section in the book about language-specific settings and the languages.toml file. * Update book/src/languages.md Co-authored-by: Gokul Soumya <gokulps15@gmail.com> * feat(book/src/guides/adding_languages.md) Add book section on adding a new language to the compile-time/root languages.toml file. * Update book/src/guides/adding_languages.md Co-authored-by: Blaž Hrastnik <blaz@mxxn.io> * Update book/src/guides/adding_languages.md Co-authored-by: Blaž Hrastnik <blaz@mxxn.io> * refactor(revise book/src/languages.md) Change the book page on language settings to match suggestions by archseer and mention both toml files. Co-authored-by: Gokul Soumya <gokulps15@gmail.com> Co-authored-by: Blaž Hrastnik <blaz@mxxn.io> 2021-11-07 02:31:12 +01:00			`- [Languages](./languages.md)`
Add treesitter textobjects (#728) * Add treesitter textobject queries Only for Go, Python and Rust for now. * Add tree-sitter textobjects Only has functions and class objects as of now. * Fix tests * Add docs for tree-sitter textobjects * Add guide for creating new textobject queries * Add parameter textobject Only parameter.inside is implemented now, parameter.around will probably require custom predicates akin to nvim' `make-range` since we want to select a trailing comma too (a comma will be an anonymous node and matching against them doesn't work similar to named nodes) * Simplify TextObject cell init 2021-10-23 04:41:19 +02:00			`- [Guides](./guides/README.md)`
Rewrite and refactor all documentation (#5534) * Rewrite and refactor all documentation * Rewrite and refactor the guides * update runtime directory instructions for windows * Update the Ubuntu 3rd party repo section with 22.10 * Merge from upstream * Rewrite and refactor all documentation * Apply suggestions from code review Apply the suggestions that can be committed from the GitHub web interface. Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Add Windows themes folder Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com> * Apply the rest of the suggestions from the code review * Revert "Apply the rest of the suggestions from the code review" This reverts commit 498be1b7a1aec3ff567b95130148628beeef9b77. * Revert "Merge branch 'rewrite-and-refactor-all-documentation' of github.com:David-Else/helix into rewrite-and-refactor-all-documentation" This reverts commit 7c8404248ffef73b80b9051d5a4359c5bcfa5d1a, reversing changes made to d932969cfc9fadda12a74cc01665919dee7152fb. * Apply code review suggestions * Changes after re-reading all documents * Missed a full stop * Code review suggestions and remove macOS and Windows specific sections * Add OpenBSD to heading * Add back macOS and Windows sections and further simplify and improve * Change wording to nightly * Remove README installation section and turn into a link * Simplify building from source and follow code review suggestions * Code review revisions * Fix copy paste mistake * Apply the latest code review suggestions * More small code review items * Change minor modes for code review * Fix link and typos * Add note that you need a c++ compiler to install the tree-sitter grammars * Add pacman example * Make sure all headings are lower case * Revert to the original passage adding a reference to Windows that was missing * Update book/src/guides/adding_languages.md Fix grammar typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Update book/src/install.md Fix tree sitter typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Remove TOC links to main heading --------- Co-authored-by: CptPotato <3957610+CptPotato@users.noreply.github.com> Co-authored-by: Michael Davis <mcarsondavis@gmail.com> Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com> 2023-03-06 10:27:17 +01:00			`- [Adding languages](./guides/adding_languages.md)`
			`- [Adding textobject queries](./guides/textobject.md)`
			`- [Adding indent queries](./guides/indent.md)`
inject language based on file extension & shebang (#3970) * inject language based on file extension Nodes can now be captured with "injection.filename". If this capture contains a valid file extension known to Helix, then the content will be highlighted as that language. * inject language by shebang Nodes can now be captured with "injection.shebang". If this capture contains a valid shebang line known to Helix, then the content will be highlighted as the language the shebang calls for. * add documentation for language injection * nix: fix highlights The `@` is now highlighted properly on either side of the function arg. Also, extending the phases with `buildPhase = prev.buildPhase + ''''` is now highlighted properly. Fix highlighting of `''$` style escapes (requires tree-sitter-nix bump) Fix `inherit` highlighting. * simplify injection_for_match Split out injection pair logic into its own method to make the overall flow easier to follow. Also transform the top-level function into a method on a HighlightConfiguration. * markdown: add shebang injection query 2023-04-28 11:21:34 +02:00			`- [Adding injection queries](./guides/injection.md)`