Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

markdown to html link converter fails on links within tables #15206

Closed
aaronmarkham opened this issue Jun 11, 2019 · 4 comments
Closed

markdown to html link converter fails on links within tables #15206

aaronmarkham opened this issue Jun 11, 2019 · 4 comments

Comments

@aaronmarkham
Copy link
Contributor

Description

The converter for markdown links to html links used in the website doesn't work for links in tables.
This has been causing broken links.
Take for example this table in the build from source guide:
https://mxnet.incubator.apache.org/versions/master/install/build_from_source.html#installing-mxnet-language-bindings

At the moment these links are broken. They should have been converted but were not. The links are fixed by hardcoding them to be .html links. I did this in #15205. But, then browsing this file on github will make those links broken. I chose website > github. Anyway this conversion tool or feature needs to be looked into to see if we can't fix it for when links are in tables.

@mxnet-label-bot
Copy link
Contributor

Hey, this is the MXNet Label Bot.
Thank you for submitting the issue! I will try and suggest some labels so that the appropriate MXNet community members can help resolve it.
Here are my recommended labels: Doc

@aaronmarkham
Copy link
Contributor Author

I researched this problem and found that there's an upgrade to recommonmark compared to what we're using.
On a test server:
I upgraded recommonmark to v0.5.0 and ccommonmark>=0.7.3 which ends up being 0.9.0.
I successfully build, but saw many new warnings (which will fail in CI). Aside from this, the upgrade still didn't fix the links in markdown tables. It looks like table support has been requested since 2015.
We need another utility with better features, or just don't use markdown tables. Neither sounds appealing.

@aaronmarkham
Copy link
Contributor Author

Also, we've been having issues with recommonmark for a long time:
https://issues.apache.org/jira/browse/MXNET-958
Maybe an alternative package is the right way to go.

@aaronmarkham
Copy link
Contributor Author

Moot issue

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

No branches or pull requests

2 participants