Mercurial > forks > helix
changeset 5810:3c4403798188
Fix multiple broken links in the documentation (#10953)
* Fix multiple broken links in the documentation
* Apply code review suggestion
Co-authored-by: Michael Davis <[email protected]>
---------
Co-authored-by: Michael Davis <[email protected]>
author | David Else <12832280+David-Else@users.noreply.github.com> |
---|---|
date | Tue, 18 Jun 2024 09:43:36 +0100 |
parents | 00d17ab66cd8 |
children | a0d39cd1d730 |
files | book/src/keymap.md book/src/syntax-aware-motions.md book/src/textobjects.md |
diffstat | 3 files changed, 5 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/book/src/keymap.md Tue Jun 18 09:42:46 2024 +0100 +++ b/book/src/keymap.md Tue Jun 18 09:43:36 2024 +0100 @@ -25,7 +25,7 @@ > 💡 Mappings marked (**TS**) require a tree-sitter grammar for the file type. -> ⚠️ Some terminals' default key mappings conflict with Helix's. If any of the mappings described on this page do not work as expected, check your terminal's mappings to ensure they do not conflict. See the (wiki)[https://github.com/helix-editor/helix/wiki/Terminal-Support] for known conflicts. +> ⚠️ Some terminals' default key mappings conflict with Helix's. If any of the mappings described on this page do not work as expected, check your terminal's mappings to ensure they do not conflict. See the [wiki](https://github.com/helix-editor/helix/wiki/Terminal-Support) for known conflicts. ## Normal mode @@ -233,8 +233,7 @@ Accessed by typing `m` in [normal mode](#normal-mode). -See the relevant section in [Usage](./usage.md) for an explanation about -[surround](./usage.md#surround) and [textobject](./usage.md#navigating-using-tree-sitter-textobjects) usage. +Please refer to the relevant sections for detailed explanations about [surround](./surround.md) and [textobjects](./textobjects.md). | Key | Description | Command | | ----- | ----------- | ------- |
--- a/book/src/syntax-aware-motions.md Tue Jun 18 09:42:46 2024 +0100 +++ b/book/src/syntax-aware-motions.md Tue Jun 18 09:43:36 2024 +0100 @@ -64,5 +64,3 @@ selection to the "func" `identifier`. [lang-support]: ./lang-support.md -[unimpaired-keybinds]: ./keymap.md#unimpaired -[tree-sitter-nav-demo]: https://user-images.githubusercontent.com/23398472/152332550-7dfff043-36a2-4aec-b8f2-77c13eb56d6f.gif
--- a/book/src/textobjects.md Tue Jun 18 09:42:46 2024 +0100 +++ b/book/src/textobjects.md Tue Jun 18 09:43:36 2024 +0100 @@ -27,7 +27,7 @@ > 💡 `f`, `t`, etc. need a tree-sitter grammar active for the current document and a special tree-sitter query file to work properly. [Only -some grammars][lang-support] currently have the query file implemented. +some grammars](./lang-support.md) currently have the query file implemented. Contributions are welcome! ## Navigating using tree-sitter textobjects @@ -37,9 +37,9 @@ example to move to the next function use `]f`, to move to previous type use `[t`, and so on. -![Tree-sitter-nav-demo][tree-sitter-nav-demo] + -For the full reference see the [unimpaired][unimpaired-keybinds] section of the key bind +For the full reference see the [unimpaired](./keymap.html#unimpaired) section of the key bind documentation. > 💡 This feature relies on tree-sitter textobjects