markdown-js icon indicating copy to clipboard operation
markdown-js copied to clipboard

Support for GitHub Flavored Markdown

Open akzhan opened this issue 12 years ago • 29 comments

What about support of widely used GitHub Flavored Markdown?

We need it. This dialect known as the Redcarpet.

akzhan avatar Apr 03 '12 16:04 akzhan

Support for this as a dialect should possible.

Its probably not that much work if you base it on the existing standard dialect (look for Maruku how do that).

Unfortunately I don't have time to do this right so 'patches welcome' I'm afraid.

ashb avatar Apr 03 '12 16:04 ashb

So I have actually already done this: https://github.com/gjtorikian/namp/blob/master/lib/markdown.js#L1143

But my repo is currently messed up because of some changes I made a month ago. I don't think it would be appropriate to do a PR but you can by all means just copy the dialect code.

gjtorikian avatar Apr 03 '12 17:04 gjtorikian

@gjtorikian, thanks a lot. I will rebase your commits to send PR.

akzhan avatar Apr 03 '12 18:04 akzhan

Also forgot to add that I also do not have the time to fix my own code at the moment--hence lack of PR ;p

gjtorikian avatar Apr 03 '12 18:04 gjtorikian

NP. Anyway some codebase is very good point to work on than from scratch.

akzhan avatar Apr 03 '12 19:04 akzhan

+1

@akzhan, it is ready?

rlidwka avatar Apr 07 '12 02:04 rlidwka

@rlidwka, @1602 shows me another project at https://github.com/isaacs/github-flavored-markdown, and now it meets my needs.

akzhan avatar Apr 07 '12 07:04 akzhan

@akzhan , oh... that's the same old Markdown engine originally written in Perl and ported line-by-line then.

Unfortunately, it has no central repository (forks are scattered all over the internet). It's written using regexp very much that's good in perl but hard to maintain in javascript. It has no plugin system, so everyone just naturally rewriting it's core to every specific project.

I think i'd stick with this one...

rlidwka avatar Apr 07 '12 20:04 rlidwka

As you might have noticed I did a lot of tidying up (mainly getting the test suite running again) and closing of the easier bugs on the markdown project this weekend.

Hopefully I'll be getting onto this soon if someone else doesn't beat me too it.

ashb avatar Apr 09 '12 15:04 ashb

I'm working on a super simple, open source Markdown editor in the browser (based on Mou). I'd absolutely love to have github flavored markdown, and basically would love to have this feature included in markdown.js.

Just voicing my support on this issue.

Thanks so much for your work, @ashb.

dpaola2 avatar May 13 '12 20:05 dpaola2

any news here? I'd love to have this as well.

mattly avatar Oct 22 '12 00:10 mattly

I made a start on the gfm branch - Can't remember how far I've gotten though...

ashb avatar Jan 14 '13 22:01 ashb

I got really inspired by seeing the checkmark support in GFM (https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments) and would like to see this adopted in.

However, when I started to poke at it it seems that is conflicts with the check for links [.*] vs [ ] and [x]. I'm not sure how best to solve this in a good way, but I got it working by simply doing a check in the link handler if the res[1] is ' ' or 'x'.

If you want to give some further guidance, I can try my hand at some other contribution.

And not to hijack, but I don't think GFM is feature complete without being able to update the checkmark content in some capacity. Is this something you think ultimately markdown-js should facilitate or should it be entirely up to the application?

jshirley avatar Jan 22 '13 19:01 jshirley

Yay for ambiguous markdown syntax. Cos there's not enough of that already...

And not to hijack, but I don't think GFM is feature complete without being able to update the checkmark content in some capacity. Is this something you think ultimately markdown-js should facilitate or should it be entirely up to the application?

My first thought is that this is something application specific, but we might be able to help by giving functions to find the character offset to the [ ] so that it can be easily changed... Hmmm.

ashb avatar Jan 23 '13 16:01 ashb

Getting the character offset would be really useful, generating markup like would make this pretty easy to implement in any application. As it stands, I did a really terrible regex based on the remaining line so I can match.

I pushed my earlier attempt to http://j.shirley.im/tech/yui/gallery-markdown/ which shows it working with the horrible regex, just to demonstrate usage.

I plopped my hack in the Gruber inline section, simply because there wasn't a GFM dialect present and I wanted to just experiment with it from a user-facing perspective.

jshirley avatar Jan 23 '13 16:01 jshirley

I'd like to see this implemented as well.

Snugug avatar Dec 21 '13 15:12 Snugug

It would indeed be great to have this! Any progress? IMO, the most important things are: distinguishing single backticks and triple backticks (including their “type tag”) and tables.

rauschma avatar Apr 23 '14 09:04 rauschma

Any workarounds different that using branch that is 160+ commits and 2 years behind master?

meeDamian avatar May 11 '14 21:05 meeDamian

It's a shame that it markdown-js doesn't support it. I have to use marked for it which doesn't support custom syntax, a loss-loss both ways.

herkyl avatar Aug 21 '14 14:08 herkyl

+1

jeffbski avatar Sep 10 '14 16:09 jeffbski

i would consider github flavored markdown the current standard in markdown, at least among all the users i know. definitely :+1: for this feature

Soleone avatar Sep 15 '14 15:09 Soleone

+1

jaredatron avatar Oct 06 '14 02:10 jaredatron

If you can live without maruku-like attributes, you can try https://github.com/markdown-it/markdown-it . It supports all GFM / PHP Markdown Extra / Pandoc extensions, and provides api for plugins.

puzrin avatar Nov 29 '14 18:11 puzrin

+1

dometto avatar Jan 21 '15 16:01 dometto

I would +1 to this feature. At the very least, having the Syntax highlighting php //code here support would be phenomonal

eric-holmes avatar Jan 30 '15 15:01 eric-holmes

+1

smohadjer avatar Feb 17 '15 17:02 smohadjer

+1

pauldotknopf avatar Jul 19 '15 10:07 pauldotknopf

Found this issue by not being able to use 3 backticks (before/after) while trying to format a bit of code. Had to use 4 indents instead, which is very annoying. Then I stumbled upon this issue but noticed it's no longer active.

I have 2 questions:

  • Are people still interested in getting this? If yes, any chance someone's gonna work on implementing - at least - the GH format for code blocks?
  • Are people considering using http://commonmark.org/ which is supposed to become the new Markdown standard?

anavarre avatar Feb 17 '16 11:02 anavarre

+1

wzpan avatar Jul 22 '17 02:07 wzpan