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

Tables do not get rendered for docs processed by recommonmark #311

Closed
1 of 2 tasks
poonai opened this issue Jul 25, 2017 · 17 comments
Closed
1 of 2 tasks

Tables do not get rendered for docs processed by recommonmark #311

poonai opened this issue Jul 25, 2017 · 17 comments
Labels

Comments

@poonai
Copy link
Contributor

poonai commented Jul 25, 2017

This is a

  • Bug report
  • Feature request

Tables not being part of the core commonmark spec aren't supported natively by recommonmark. recommonmark currently does not provide an api to create extensions. So currently table aren't rendered if present in a markdown file processed by recommonmark

@poonai
Copy link
Contributor Author

poonai commented Jul 25, 2017

@pri22296 can you check this?

@pri22296
Copy link
Member

pri22296 commented Jul 25, 2017

It seems recommonmark doesn't support Headings as list elements. As a workaround could you edit this line https://github.com/fossasia/open-event-android/blame/a01dff63e7d1e858489583c42a8c6f64029844f5/docs/apk-generator.md#L57 and https://github.com/fossasia/open-event-android/blame/a01dff63e7d1e858489583c42a8c6f64029844f5/docs/apk-generator.md#L67 so that the numbers are part of the heading and try if the error still happens?

@poonai
Copy link
Contributor Author

poonai commented Jul 25, 2017

@pri22296 will check and let you know

@pri22296
Copy link
Member

@Sch00lb0y Any update on this?

@poonai
Copy link
Contributor Author

poonai commented Jul 28, 2017

@imujjwal96
Copy link
Contributor

The table is not rendering because the markdown is incorrect

@poonai
Copy link
Contributor Author

poonai commented Jul 30, 2017

Component  | Name/Flavour | Minimum Version 
------------|--------------|----------------           
  OS        | Mac/Windows/Linux | Any 
 Node.js    | None  | v4.0 (or above) 
 Browser    | Firefox/Chrome/Safari | 21+/11+/9+ 

@imujjwal96 I'm using this still table not rendering. can you check what went wrong?

@imujjwal96
Copy link
Contributor

| Component  | Name/Flavour | Minimum Version |
|------------|--------------|----------------|
| OS        | Mac/Windows/Linux | Any |
| Node.js    | None  | v4.0 (or above) |
| Browser    | Firefox/Chrome/Safari | 21+/11+/9+ |

Try this!

@poonai
Copy link
Contributor Author

poonai commented Jul 30, 2017

I have tried but then still not rendering 😢 😢

@pri22296
Copy link
Member

Ok, It seems tables aren't part of the core commonmark spec. Check this thread for more info readthedocs/recommonmark#3

@imujjwal96
Copy link
Contributor

@pri22296 @Sch00lb0y Is this issue solved?

@pri22296
Copy link
Member

pri22296 commented Aug 9, 2017

I think it was. @Sch00lb0y can you confirm?

@poonai
Copy link
Contributor Author

poonai commented Aug 9, 2017

yeah solved. but table not rendering. close this ?

@imujjwal96
Copy link
Contributor

@pri22296 facing this issue in loklak_server as well! is there a workaround?

@pri22296
Copy link
Member

pri22296 commented Aug 21, 2017

AFAIK no for now. Maybe use an html table for now?

You can use the eval_rst codeblock to embed an rst table. However I'm not sure which approach is less hacky.

@pri22296
Copy link
Member

@imujjwal96 @Sch00lb0y If the only remaining issue is related to tables, I would suggest to close this issue and reopen a new issue stating that or edit this issue's description. I would try to find some solution to this problem, however, don't depend on that. Please proceed with temporary solutions mentioned in my previous comment or maybe just ignore the table for now.

@imujjwal96
Copy link
Contributor

@pri22296 Please edit this issue's description

@pri22296 pri22296 changed the title documentation generation failing Tables do not get rendered for docs processed by recommonmark Aug 22, 2017
@fossasia-bot fossasia-bot bot added the has-PR label Aug 23, 2017
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

3 participants