suimeng
/
helix
mirror of https://github.com/helix-editor/helix
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
helix/book/src/SUMMARY.md

19 lines
546 B
Markdown
Raw Normal View History

Add book/ (mdbook based user guide)
2021-04-05 14:18:43 +08: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 10:46:40 +08:00
[Helix](./title-page.md)
Add book/ (mdbook based user guide)
2021-04-05 14:18:43 +08:00
- [Installation](./install.md)
- [Usage](./usage.md)
docs: Auto generate command list
2021-11-17 21:30:11 +08:00
- [Keymap](./keymap.md)
- [Commands](./commands.md)
Auto generate docs for language support
2021-11-22 02:55:08 +08:00
- [Language Support](./lang-support.md)
Add docs for registers, multi key remaps (#557)
2021-08-18 08:53:50 +08:00
- [Migrating from Vim](./from-vim.md)
Add book/ (mdbook based user guide)
2021-04-05 14:18:43 +08:00
- [Configuration](./configuration.md)
Update docs
2021-06-19 19:19:31 +08:00
- [Themes](./themes.md)
Configurable keys 2 (Mapping keys to commands) (#268) * Add convenience/clarity wrapper for Range initialization * Add keycode parse and display methods * Add remapping functions and tests * Implement key remapping * Add remapping book entry * Use raw string literal for toml * Add command constants * Make command functions private * Map directly to commands * Match key parsing/displaying to Kakoune * Formatting pass * Update documentation * Formatting * Fix example in the book * Refactor into single config file * Formatting * Refactor configuration and add keymap newtype wrappers * Address first batch of PR comments * Replace FromStr with custom deserialize
2021-06-17 19:08:05 +08: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 09:31:12 +08: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 10:41:19 +08:00
- [Guides](./guides/README.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 09:31:12 +08:00
- [Adding Languages](./guides/adding_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 10:41:19 +08:00
- [Adding Textobject Queries](./guides/textobject.md)
Indentation rework (#1562) * WIP: Rework indentation system * Add ComplexNode for context-aware indentation (including a proof of concept for assignment statements in rust) * Add switch statements to Go indents.toml (fixes the second half of issue #1523) Remove commented-out code * Migrate all existing indentation queries. Add more options to ComplexNode and use them to improve C/C++ indentation. * Add comments & replace Option<Vec<_>> with Vec<_> * Add more detailed documentation for tree-sitter indentation * Improve code style in indent.rs * Use tree-sitter queries for indentation instead of TOML config. Migrate existing indent queries. * Add documentation for the new indent queries. Change xtask docgen to look for indents.scm instead of indents.toml * Improve code style in indent.rs. Fix an issue with the rust indent query. * Move indentation test sources to separate files. Add `#not-kind-eq?`, `#same-line?` and `#not-same-line` custom predicates. Improve the rust and c indent queries. * Fix indent test. Improve rust indent queries. * Move indentation tests to integration test folder. * Improve code style in indent.rs. Reuse tree-sitter cursors for indentation queries. * Migrate HCL indent query * Replace custom loading in indent tests with a designated languages.toml * Update indent query file name for --health command. * Fix single-space formatting in indent queries. * Add explanation for unwrapping. Co-authored-by: Triton171 <triton0171@gmail.com>
2022-03-30 23:08:07 +08:00
- [Adding Indent Queries](./guides/indent.md)