:h[elp] command

[Omnikar]

I think that :h <command> where <command> is a command name from commands.rs would open documentation for the command in the editor, and :h <keybind> would act like :h <command> for the keybind's bound command.

[sudormrfbin]

Vim's help system is really good (even though the amount of documentation is a bit overwhelming) and it would be nice if we could have something similar. I propose using markdown to write the docs itself, which has the advantage of being easily hostable in the website and already having the pulldown-cmark markdown parser as a dependency (asciidoc is a better alternative for technical documentation, but we'll have to pull even more dependencies and it's one additional thing to learn).

[pickfire]

The issue with markdown is that there is no links between them.

[Omnikar]

I think this should have the A-documentation label?

[diktomat]

The issue with markdown is that there is no links between them.

Wikilinks ([[link|optional description]]) are commonly used in note-taking and similar applications. While not being a feature of standard Markdown, it'd be an easier solution than using HTML or any custom markup language (like Vims help syntax). That said, I think more custom syntax would be needed, like different tags for commands, key binds, options, later maybe Wasm API calls etc. These all would be anchors, too, as most note-taking only supports linking documents and headers. Using Vims syntax for these would be easiest probably, maybe wrapped in `` for standard Markdown compatibility:

`:command`
`'option'`
`*xd*` key bind
`api_call()`

Markdown as base for this would be great!

[emschwartz]

As a new user, this would be very helpful. I've been trying out Helix for the past two days and have basically needed to keep the docs site open in a browser tab to remember the helix-specific keyboard shortcuts that I'm still learning.

A related thing that would also be nice would be a kind of quick help (maybe bound to ?) that would show a popup with the base keys (especially to enter the different modes). I like how the space menu and match menus have little popups that remind you what the available combinations are, but it would be very nice to have a quick way to see what those different modes are in the first place.

[poelzi]

second time I was confuzed that there is no :help command. Simple things like how to select lines is not possible to find out inside the editor.

[Omnikar]

@poelzi have you had a look at the tutor? You can access it using hx --tutor or :tutor from within the editor.