search

xi-editor / xi-mac

The xi-editor mac frontend.
Apache License 2.0
3.02k stars 148 forks source link

Create a Help Book for xi-mac #252

Open jansol opened 6 years ago

jansol commented 6 years ago

This could contain a table of default shortcuts, available config variables and their defaults, theming docs etc...

To achieve this a .help bundle needs to be added to the .app bundle's Resources directory. For details on how to create a .help bundle, see https://developer.apple.com/library/archive/documentation/Carbon/Conceptual/ProvidingUserAssitAppleHelp/authoring_help/authoring_help_book.html#//apple_ref/doc/uid/TP30000903-CH206-CIHEAADH

The first step would be to create a help bundle with a single page containing a table of keyboard shortcuts.

jansol commented 5 years ago

^ The above PR is meant as a starting point for anyone who wants to contribute some HTML and this issue is still up for grabs (just wanted to clarify that here). Feel free to start directly from the PR or just use it as a reference. (you can pull the PR into your local clone directly even though it is not merged if you want to go that route)

TzviPM commented 5 years ago

Hey, I noticed that some work was started on this here: https://github.com/xi-editor/xi-mac/pull/262. Since it hasn't been touched in a while, I presume it's safe for me to take a stab at it?

jansol commented 5 years ago

Sure, the existing work was actually meant as a starting point for someone interested, since I wasn't sure about some relevant details when creating this issue.

TzviPM commented 5 years ago

For the next step here, I'd like to get a folder set up with .md files that we can somehow compile into a help bundle. I'll ping you (@jansol) on zulip to discuss possible approaches, and then post a summary here for reference before opening a PR.