osx-compose-key icon indicating copy to clipboard operation
osx-compose-key copied to clipboard

Create script to generate the keybindings or a BINDINGS.md

Open gnarf opened this issue 8 years ago • 6 comments

Either write a script that generates the keybindings from a markdown format table, or a script that generates a markdown formatted table from the keybindings so we can have documentation of what commands are on what files.

gnarf avatar Nov 30 '16 15:11 gnarf

@gnarf I'm working on a PR and I'm building the generator script in Node.js. Every time an npm script is run it will WARN as there currently is no license field. Please suggest one for me to include. Thanks!

jacobroufa avatar Dec 03 '16 08:12 jacobroufa

I still need to update the README.md, but you can see the new BINDINGS.md that I've generated.

Per my commit message from b13f46a, my TODO items are:

  • update README to reference new NPM scripts and add contribution documentation
  • fix Phrase output
  • [maybe] add some explanation text at the top of BINDINGS.md

Please let me know about the license and any explanation text for the generated markdown. Of course if you have any other suggestions please let me know. I'm about out of steam right now or I'd finish the rest of this stuff... I'll pick it back up in the next couple few days.

jacobroufa avatar Dec 03 '16 10:12 jacobroufa

I'm a fan of MIT or CC0

On Dec 3, 2016 03:30, "Jacob M. Roufa" [email protected] wrote:

@gnarf https://github.com/gnarf I'm working on a PR and I'm building the generator script in Node.js. Every time an npm script is run it will WARN as there currently is no license field. Please suggest one for me to include. Thanks!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/gnarf/osx-compose-key/issues/17#issuecomment-264625835, or mute the thread https://github.com/notifications/unsubscribe-auth/AAhh61fqdCeZojj751Hyn_WpdxgV1peMks5rESidgaJpZM4LAUkl .

gnarf avatar Dec 03 '16 15:12 gnarf

here's a nextstep plist parser and stringifier: https://github.com/chee/nextstep-plist

it's GPL'd but i hereby give every contributer to this repo permission to use it as they see fit

chee avatar May 05 '17 02:05 chee

just tried it out using literate coffeescript:

litcoffee

md

and it works

ωωωωωωω

chee avatar May 05 '17 02:05 chee

for an example of use, there is this:

.macoscompose

it lets you create a file like

# thumbs
+1: 👍
-1: 👎

# hearts
yellow heart: 💛
heart: ❤

as ~/.macoscompose, and then you run that program and it will merge your .macoscompose with your ~/Library/KeyBindings/DefaultKeyBinding.dict

🙃

chee avatar May 07 '17 19:05 chee