Triply-Dev / YASGUI.YASQE-deprecated

Deprecated, see https://github.com/TriplyDB/Yasgui for the Yasgui monorepo
MIT License
73 stars 36 forks source link

Make gists for usage examples #22

Closed LaurensRietveld closed 9 years ago

LaurensRietveld commented 10 years ago

Connected to #20. Examples:

LaurensRietveld commented 10 years ago

https://github.com/blairvanderhoof/gist-embed looks interesting. use that one.

And, annotate the gists with #yasqe and/or #yasr, so we can dynamically search/include these on our documents page by searching for username (Laurensrietveld) and these tag names. Gists don't support proper tags yet though, so put these tag names in title

LaurensRietveld commented 10 years ago

havent found a way to use search api for gists. Instead, just fetch the gists connected to my account, and filter based on description tags (https://api.github.com/users/LaurensRietveld/gists)

LaurensRietveld commented 10 years ago

Perhaps, alternatively to the gist-embed library, use the bl.ocks service. See http://bl.ocks.org/LaurensRietveld/7d8beca5dbeb6b909b6f and http://bl.ocks.org/LaurensRietveld/raw/7d8beca5dbeb6b909b6f

This does not mess up our interface with code examples, and would make this addition very lightweight.

E.h., link to the /raw/ bl.ocks.org page, link to the regular github page (so people can leave comments and see the history+code), and on the YASQE page show the title, and fetch the README.md text (if there is any). https://api.github.com/gists/7d8beca5dbeb6b909b6f

jneubert commented 10 years ago

This sounds really interesting - looking forward to it! Cheers, Joachim