Zeal: Add support for Dash cheatsheets

Created on 20 Feb 2016  路  17Comments  路  Source: zealdocs/zeal

I couldn't find any way to add "cheatsheets" to Zeal. Dash supports them already. Velocity doesn't support them, as far as I can tell.

Cheatsheets can be found here.

They are Ruby files, using cheatset.

Hopefully this could be added somewhat easily, but I am not sure about how close Dash and Zeal are in terms of this file type.

Not sure how to implement this, but I assume it would just be to support the format like Dash does and then add the cheatsheet repository to the Zeal docsets.

typfeature

Most helpful comment

There's no need to support the .rb files (Dash doesn't). I build all cheat sheets and turn them into docsets.

To grab the list of cheat sheets:
https://kapeli.com/feeds/zzz/cheatsheets/cheat.json

To download a cheet sheet:
https://kapeli.com/feeds/zzz/cheatsheets/Android_Emulator.tgz

All 17 comments

There's no need to support the .rb files (Dash doesn't). I build all cheat sheets and turn them into docsets.

To grab the list of cheat sheets:
https://kapeli.com/feeds/zzz/cheatsheets/cheat.json

To download a cheet sheet:
https://kapeli.com/feeds/zzz/cheatsheets/Android_Emulator.tgz

@Kapeli Thanks for the information!

So how would you recommend we best support cheatsheets in Zeal? Support loading the JSON file and then downloading them just like regular docsheets?

Yep. Kind of the same as for user contributed docsets.

@Kapeli OK. Cool, good to know. Thanks, @Kapeli !

Yes, I need this feature :+1:

I need it too :+1:

+1

Would love them

Did anything come of this? I'd love to be able to install cheatsheets.

+1

+1

馃憤
Bump. 馃槃

To add to this, in the Dash iOS app, I see Main Docsets, Cheat Sheets, and User Contributed Docsets, so please add the user-contributed docsets, too. There are a HUGE number of those that look very useful.

@ChaiTRex there's #170 about that.

I made some minor modifications to sntiagoma/zealusercontributions so that it pulls the cheatsheets from the URL above. You can add the cheatsheets to Zeal the same way you would add a docset feed.

Thanks @Kapeli for providing all the necessary info and @sntiagoma for building the initial app.

To add the cheatsheets: Zeal Cheatsheets
To contribute & improve: Source

Some of the cheatsheets clash with normal docsets (e.g. Vim) so both can't be installed at the same time.
Maybe changing the names of the cheatsheets or implementing some kind of namespaces?

I would like a separate namespace and tab for cheetsheets to help distinguish from docsets. Right now, I'm manually editing the info.plist to change the name, but it should be able to be implemented since the cheatsheet plists contain a cheatsheet value.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

cweiske picture cweiske  路  5Comments

ngirard picture ngirard  路  4Comments

sheershoff picture sheershoff  路  4Comments

gueorgui picture gueorgui  路  8Comments

rugk picture rugk  路  8Comments