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

Support for Markdown Tables #1064

Closed
pratyushtewari opened this issue Sep 9, 2015 · 5 comments
Closed

Support for Markdown Tables #1064

pratyushtewari opened this issue Sep 9, 2015 · 5 comments
Labels
Milestone

Comments

@pratyushtewari
Copy link

Is there any plan to include the GFM Tables in jsdoc3?

Would really appreciate it.
Thank you.

@hegemonic
Copy link
Contributor

Our Markdown parser is marked, which supports GFM tables, so they should work in JSDoc. If you've enabled the Markdown plugin, and GFM tables aren't working, please let me know.

@pratyushtewari
Copy link
Author

Hi Jeff,

I Have enabled the markdown plugin in the conf file.

Here is the markdown

* | name             | argument     | triggering UI event |
* | :--------------- | :----------  | :------------------ |
* | WIDGETSELECTED   | none         | onClick             |

and here is the output

screen shot 2015-09-10 at 9 27 00 am

I think there is a CSS issue. I dont see any borders/colors in the tables. Hope I am not making stupid typo errors in the markdown.

Please advice.
Thanks

@pratyushtewari
Copy link
Author

I was inspecting the html and the parameter table has the same HTML structure but somehow the default CSS is working on that.

eg:
screen shot 2015-09-10 at 2 07 36 pm

but the markdown table still is showing without any css borders/colors.

eg:

screen shot 2015-09-10 at 9 27 00 am

@hegemonic
Copy link
Contributor

Yep, looks like we need to fix this CSS issue in the template.

@hegemonic hegemonic reopened this Oct 21, 2015
@hegemonic hegemonic added this to the 3.4.0 milestone Oct 21, 2015
@hegemonic hegemonic modified the milestones: 3.4.x, 3.4.0 Dec 15, 2015
@hegemonic
Copy link
Contributor

Fixed on master and releases/3.4. The fix will be included in JSDoc 3.4.1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants