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

Markdown tables are not supported? #196

Closed
afarran opened this issue Mar 3, 2015 · 4 comments
Closed

Markdown tables are not supported? #196

afarran opened this issue Mar 3, 2015 · 4 comments

Comments

@afarran
Copy link

afarran commented Mar 3, 2015

Having ldoc comments in this markdown format:

Item 1,1 Item 1,2
Item 2,1 Item 2,2
Item 3,1 Item 3,2

does not produce the following expected HTML table output:

Item 1,1 Item 1,2
Item 2,1 Item 2,2
Item 3,1 Item 3,2

Is this a bug? Is there a workaround other than embedding HTML table tags in the ldoc comments?

Tested with Ldoc v1.4.3.
config.ld has the following settings:

  • no_summary=false
  • not_luadoc=true
  • format='markdown'
  • plain=false
  • boilerplate=false
@stevedonovan
Copy link
Contributor

You certainly get a generated table with Discount (built-in markdown.lua doesn't support tables) but we don't have a nice style sheet that makes that table look pretty. Should be an easy fix.

@keneanung
Copy link

I've been also using ldoc 1.4.3 with the config.ld set to format="discount" and the following table:

...
Dependencies:

| Dependency          | Version |
|---------------------|---------|
| `IOE.Core`          | 2       |

### Purpose
...

But the output I get is http://ioe.gitlab.io/topics/IOE.TargettingREADME.md.html

I have no idea what I'm doing wrong, can you help?

@cloewen8
Copy link

I also had trouble getting tables to work. I used lua-discount, but it turns out that the current version of lua-discount does not support tables. I managed to fix it by using https://github.com/squeek502/lua-discount (a real pain to install with a lot of undocumented bugs). It seems to be by the same creator of the discount (not lua-discount) rock, but I can't verify that.

@alerque
Copy link
Member

alerque commented Sep 29, 2020

As noted, this is entirely up to the Markdown parser you use. There are several more available now, with Pandoc in the works (see #327) which will be another option besides discount that supports tables.

@alerque alerque closed this as completed Sep 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

5 participants