-
Notifications
You must be signed in to change notification settings - Fork 275
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
Generating Readmes #265
Comments
Yeah, you can create a view with a predicate (e.g. |
Do you want to generate a catalogue out of all keybinding maps for all the modes, like a |
It'd be similar to https://github.com/emacs-evil/evil-collection/tree/master/modes/ediff or https://github.com/emacs-evil/evil-magit/blob/master/README.org which has keybindings, some documentation around certain defcustoms, gotchas, etc. I think we can probably just generate an initial set of docs using @noctuid 's annalist and then manually change them later to polish them up. Automating it would be cool but I'm thinking about the complications around adding extra documentation other than keybindings. |
Well, it is the "extra documentation" that would be really interesting, like rationale for certain bindings or interplay between two different packages. :) I think a reasonable first step would be to produce such a |
I think readme's with keybindings should be the first step. Some people, I suspect, just don't like browsing code when trying to figure out keybindings. A nice web view with a list of keybindings in a pretty table is probably more palatable. I think most packages don't really need extravagant documentation so the the extra documentation would be a cherry on top, IMO. |
Should be possible to have it completely automated (would be easier especially if you ever wanted to change the formatting or sorting later). Like a package like org-toc (automatic table of contents insertion), annalist could provide a way to insert/replace a table under a specific heading (and potentially with a filter if you wanted to split the keybindings for a file into multiple sections). |
@noctuid I was curious what you thought of annalist and generating readmes of the mode bindings?
I think it'd be cool to have something (not sure if already there) where we can query annalist for specific keymaps and have it return a table we can use in a readme.
e.g. something like this already looks 99% of the way there for a readme.
The text was updated successfully, but these errors were encountered: