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

doc: headerlines not rendered correctly with extra backslash #22123

Closed
fhinkel opened this issue Aug 4, 2018 · 3 comments
Closed

doc: headerlines not rendered correctly with extra backslash #22123

fhinkel opened this issue Aug 4, 2018 · 3 comments
Labels
doc Issues and PRs related to the documentations. duplicate Issues and PRs that are duplicates of other issues or PRs.

Comments

@fhinkel
Copy link
Member

fhinkel commented Aug 4, 2018

Looks like something changed in how we render documentation for 8 vs 10. Headers used to need \ to escape special characters. Now the backslash is rendered and our docs look weird.
Here is an example, source:

### DEP0002: require('\_linklist')

How it looks in docs for 10 (here):

DEP0002: require('\_linklist')

 

 

How it looks in docs for 8 (here):

DEP0002: require('_linklist')

I think we can remove the extra \, .md files viewed on GitHub would render correctly.

cc @nodejs/website

@fhinkel fhinkel added the doc Issues and PRs related to the documentations. label Aug 4, 2018
@targos
Copy link
Member

targos commented Aug 4, 2018

Duplicate of #22065

@targos targos marked this as a duplicate of #22065 Aug 4, 2018
@lpinca
Copy link
Member

lpinca commented Aug 4, 2018

PR #22084

@fhinkel
Copy link
Member Author

fhinkel commented Aug 4, 2018

Thanks @targos , I wasn't searching well enough 😄

@fhinkel fhinkel closed this as completed Aug 4, 2018
@targos targos added the duplicate Issues and PRs that are duplicates of other issues or PRs. label Aug 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. duplicate Issues and PRs that are duplicates of other issues or PRs.
Projects
None yet
Development

No branches or pull requests

3 participants