search

nene / guider

A guides engine extracted out of JSDuck
GNU General Public License v3.0
1 stars 1 forks source link

GitHub Markdown Parser #10

Closed branflake2267 closed 11 years ago

branflake2267 commented 11 years ago

What would you think of using the GitHub Markdown parser? I see it's in ruby :)

https://github.com/github/github-flavored-markdown - source home https://github.com/github/github-flavored-markdown/blob/gh-pages/index.md - sample

I think it has some nice markdown improvements. And the added bonus is when previewing it on github it would rendering closer to the end product :)

branflake2267 commented 11 years ago

Looks like the code above is only extending.

nene commented 11 years ago

Most of those things have been incorporated by various different Markdown engines. But I don't think we really want all of these features. Mainly the treatment of newlines - we already have content that assumes the standard Markdown treatment of newlines and we also pretty much decided that's the way we want to go.

And as you said... this code is just layering on top of Redcarpet, the actual engine that Github uses. But that in turn is a Ruby binding to Sundown, which is a C library, but I'd like to keep these things out of the guider project to avoid complicating the installation procedure.

branflake2267 commented 11 years ago

I'd really like to see github parser added, would this be a possibility. I think the markdown options allow for better storying telling.

Some things I'd like to see:

  1. Tabbing in for code formatting is all the same for all types of code, where github allows for better differentiation of the code style types.
  2. Single ticks to highlight code has a better style.
  3. H2 Underline is better devision between topics.

Example of github style: https://github.com/branflake2267/gxt/blob/docs_draft13_xtemplates/docs/guides/utility/xtemplates/XTemplates.md

Screen Shot 2013-04-12 at 1 40 51 PM

branflake2267 commented 11 years ago

Side by side comparison.. This is just a look at the difference, well probably only style difference too...

Screen Shot 2013-04-12 at 1 49 49 PM

branflake2267 commented 11 years ago

One more reason I think this would make sense to do is b/c of the github editor. I know George is using it to edit documents. I think it would be handy to edit docs now and then and get a github preview. I wouldn't think they have to be exact but a close representation would allow to take advantage of the github parser benefits. :)