search

justbur / emacs-which-key

Emacs package that displays available keybindings in popup
GNU General Public License v3.0
1.74k stars 87 forks source link

Info documentation #281

Open DSMasterson opened 3 years ago

DSMasterson commented 3 years ago

It would be nice if which-key had Info documentation. Should be easily possible by exporting README.org to README.texinfo and then using 'makeinfo' to generate the which-key.info file. Or you could use 'pandoc'. Then just add a generic 'dir' file and the .info file to the MELPA package. Emacs will do the rest on package installation,

justbur commented 3 years ago

I've not done this before. What do you use for the org->texinfo step?

DSMasterson commented 3 years ago

Org. Check the Org Info manual. There's a large chapter on Export. If you have the right stuff installed (Tex, makeinfo, .emacs, ...), it should all just work. Try loading you're README.org into Emacs, Be sure the major-mode is org-mode, then try "C-c C-e i t" or "C-c C-e i i". You could also look at the Publishing chapter on building a script to "publish" your README.org before you want to ship things to MELPA (I'm not familiar with how that is done) or wrap it in a makefile. Lots of ways to do it -- see what works for you.