Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add all commands (including those without keymaps) to documentation #10970

Open
thomasschafer opened this issue Jun 15, 2024 · 3 comments · May be fixed by #11950
Open

Add all commands (including those without keymaps) to documentation #10970

thomasschafer opened this issue Jun 15, 2024 · 3 comments · May be fixed by #11950
Labels
A-documentation Area: Documentation improvements C-enhancement Category: Improvements

Comments

@thomasschafer
Copy link
Contributor

There are a number of commands (here) such as select_line_above that can be used in custom keymaps but are (as far as I can tell) not formally documented, so the only way to determine which commands can be used is to read the source code or possibly from perusing the changelog. It would be nice to have these commands documented somewhere, e.g. at the end of https://docs.helix-editor.com/keymap.html under a new section that contains all of those commands that are not bound by default to a keymap but that can be used in config.toml.

@thomasschafer thomasschafer added the C-enhancement Category: Improvements label Jun 15, 2024
@kirawi
Copy link
Member

kirawi commented Jun 15, 2024

You can see all commands that exist in space-?

@thomasschafer
Copy link
Contributor Author

You can see all commands that exist in space-?

I was meaning to have them documented somewhere on the website - I think it's useful to be able to review these outside of the editor. For instance, inside Helix you can see all of the command mode commands by hitting : and tabbing through them, but they are also documented at https://docs.helix-editor.com/commands.html

@adamperkowski
Copy link
Contributor

Added in #11152

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements C-enhancement Category: Improvements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants