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

FAQ Markdown is broken #1771

Closed
DeltaF1 opened this issue Oct 29, 2019 · 7 comments
Closed

FAQ Markdown is broken #1771

DeltaF1 opened this issue Oct 29, 2019 · 7 comments

Comments

@DeltaF1
Copy link
Contributor

@DeltaF1 DeltaF1 commented Oct 29, 2019

What operating system, Node.js, and npm version?
Firefox 70, windows 10
What happened?
The list of URLS in the "Who is using WebTorrent today?" is showing its markdown without parsing it after the link to GitTorrent
Are you willing to submit a pull request to fix this bug?
Yep! See #1772

@DeltaF1

This comment has been minimized.

Copy link
Contributor Author

@DeltaF1 DeltaF1 commented Oct 29, 2019

Visual description

image

@passstab

This comment has been minimized.

Copy link

@passstab passstab commented Nov 6, 2019

The document is inconsistent about "–" vs "-".

@DeltaF1

This comment has been minimized.

Copy link
Contributor Author

@DeltaF1 DeltaF1 commented Nov 6, 2019

@feross

This comment has been minimized.

Copy link
Member

@feross feross commented Nov 6, 2019

This was fixed by an unrelated PR in #1772 to move the HTML comments to the bottom of the list. For some reason, the HTML comments mid-list were confusing the markdown renderer.

I just redeployed the site.

@feross feross closed this Nov 6, 2019
@passstab

This comment has been minimized.

Copy link

@passstab passstab commented Nov 6, 2019

Thank you, much better.
BTW The markdown list syntax is all short dashes, but the content of the list is inconsistent.
Compare "webtorrent desktop" to "instant.io"

@DeltaF1

This comment has been minimized.

Copy link
Contributor Author

@DeltaF1 DeltaF1 commented Nov 6, 2019

That's my PR as well, I just created this issue because the PR template asks for an issue that it solves

@DeltaF1

This comment has been minimized.

Copy link
Contributor Author

@DeltaF1 DeltaF1 commented Nov 6, 2019

@passstab Good catch! You should open a PR to fix that inconsistency

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.