Adding Support for GFM Tables

[kitsonk]

Here is a modified pull request that only adds support for tables that are supported (but undocumented) as part of GFM. It is implemented in the same fashion as other GFM features. It appears to be fully compatible with the Sundown library (which is the markdown parser GFM is based on), though it is strictly based on the PHP Markdown Extra who appears to have introduced the "standard".

The following:

Header 1 | Header 2
-------- | --------
Cell 1   | Cell 2
Cell 3   | Cell 4

Will render as:

Header 1	Header 2
Cell 1	Cell 2
Cell 3	Cell 4

[arikon]

Any chances that it will be merged?

[bbailes]

+1 for merging this into master!

[fengmk2]

+1 We need this!

[davidsteinberger]

+1

[jcla1]

+1

[leeoniya]

+1

[aleafs]

++1

[chjj]

Will look at this later.

[harrisj]

So, is this happening? I'd love it too

[chjj]

So, I spent a little while fixing/optimizing/refactoring @kitsonk's implementation a little bit. I'm going to consider this feature experimental for a little while. You can disable it with the tables option. @kitsonk, thank you for the PR.

[harrisj]

Awesome. Thank you!

On Jan 3, 2013, at 7:29 AM, "Christopher Jeffrey" <notifications@gh.neting.ccmailto:notifications@github.com> wrote:

So, I spent a little while fixing/optimizing/refactoring @kitsonkhttps://github.com/kitsonk's implementation a little bit. I'm going to consider this feature experimental for a little while. You can disable it with the tables option. @kitsonkhttps://github.com/kitsonk, thank you for the PR.

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/74#issuecomment-11842143.

[chjj]

Just a quick test.

testing

paragraph

one	two
3	4

testing

testing

paragraph
| one | two |
| ----- | ----- |
| 3    |   4   |

testing

[chjj]

Once more.

testing

one	two
3	4

testing

And one other:

paragraph

var foo = 1;

test

#one	two
3	4

strike strike

code: foo
code: ```

[xiaohulu]

how to escape | in gfm table?

[kitsonk]

Best thing to do use use the HTML entity: |

[xiaohulu]

| one | two |
| ----- | ----- |
| 1    |   2 `a|a`   |
| 1    |   2 `a|a`   |

How to escape | in a|a

[kitsonk]

That appears to be an issue with the sundown parser that GitHub uses as well, so technically it is feature parity:

| one | two |
|-----|-----|
| 1 | 2 `a|a` |
| 1 | a|a |
| 1 | `a|a` |

Renders as:

one	two
1	2 a|a
1	a|a
1	`a

[kitsonk]

Just realised, there is a way around this:

| one |
|-----|
| <code>a&#124;a</code> |

Will render as:

one
a|a

In both marked and sundown.

[hahmed]

Is there any way to actually set the width of a table column?

[kitsonk]

Via CSS... :nth-child and other pseudo-selectors address this.

[hahmed]

@kitsonk I mean through markdown so some tables will be rendered bigger or smaller depending on width % set?

I am basically thinking how good this will be for writing documents that have tables in them.

[kitsonk]

It isn't part of the standard it is based on, and for good reason. Hard coding presentation in the markup doesn't allow flexibility when it renders. The only potential imrpovement would be to allow the specification of a class for a table, but again, none of the standards out there specify that, so I suspect @chjj wouldn't be interested in adding it, though there are some other issues here that talk about allowing some form of customisation of the output.

You can always use <table> if you need more flexibility.

[bdougie]

Anyone else having trouble getting tables to render using marked?

var singleColTest = "| one ||-----|  | <code>a&#124;a</code> |"

app.get('/', function (req, res) {
    // res.send('Hello World!');
    res.send(marked(singleColTest));
});

returns this

| one 
|-----|
| <code>a&#124;a</code> |