Skip to content
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

Make a Dash cheat sheet #18

Open
kissgyorgy opened this issue Apr 24, 2015 · 5 comments
Open

Make a Dash cheat sheet #18

kissgyorgy opened this issue Apr 24, 2015 · 5 comments
Milestone

Comments

@kissgyorgy
Copy link

Great resource! I would like to see a Dashdoc cheat sheet from this: https://github.com/Kapeli/cheatset#readme

@zerok
Copy link
Collaborator

zerok commented Apr 25, 2015

Interesting, hadn't heard of this Dash feature before :-) Have you created such a cheatsheet before? Right now I'd say that our descriptions, old- and new-style formats as well as the output should probably all simply be put into notes, right?

@zerok
Copy link
Collaborator

zerok commented Apr 29, 2015

@kissgyorgy am I right to assume that that cheat sheet would have to be hosted in https://github.com/Kapeli/cheatsheets ? If so, that would complicate matters a bit but we couldn't give it a try anyway.

@kissgyorgy
Copy link
Author

Dash is a documentation viewer which allows cheat sheets like this.
Making one is just a matter of writing the examples in it's DSL. Yes it would be hosted on that repository where anyone could download it. Here is and example:
similar cheat sheet

@zerok
Copy link
Collaborator

zerok commented Apr 30, 2015

I know what Dash is but hadn't heard of that cheat sheet feature before :-)

The one problem I see right now is that we would have to update that cheat sheet in a foreign repo whenever one of the examples changes in ours. I'm not yet sure how we could solve this. It was be awesome if Dash supported additional repos instead of just its own for people to link to, but we could absolutely extend the current script to also generate these cheat sheets.

@ulope ulope added the content label Aug 18, 2015
@ulope ulope added this to the future milestone Oct 12, 2016
@madphysicist
Copy link
Contributor

Does GitHub support submodules?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants