zealdocs / zeal

Offline documentation browser inspired by Dash
https://zealdocs.org
GNU General Public License v3.0
11.51k stars 782 forks source link

Add support for Dash cheatsheets #498

Open DerekTurtleRoe opened 8 years ago

DerekTurtleRoe commented 8 years ago

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.

Kapeli commented 8 years ago

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

DerekTurtleRoe commented 8 years ago

@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?

Kapeli commented 8 years ago

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

DerekTurtleRoe commented 8 years ago

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

jujes commented 8 years ago

Yes, I need this feature :+1:

thuandt commented 8 years ago

I need it too :+1:

clfsoft commented 8 years ago

+1

th-lange commented 7 years ago

Would love them

changeling commented 7 years ago

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

wesol05 commented 7 years ago

+1

dzschille commented 7 years ago

+1

DerekTurtleRoe commented 7 years ago

👍 Bump. 😄

ChaiTRex commented 6 years ago

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.

trollixx commented 6 years ago

@ChaiTRex there's #170 about that.

opes commented 5 years ago

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

arielsalvo commented 5 years ago

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?

mondele commented 3 years ago

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.

zuernBernhard commented 1 year ago

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

--> Zeal says: invalid docset feed

MidStein commented 11 months ago

@zuernBernhard Use the XML feed link from https://zealusercontributions.vercel.app/cheatsheets