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

Table of content does not render special characters and anything in between them #1457

Closed
amimas opened this issue May 14, 2019 · 2 comments · Fixed by #1458
Closed

Table of content does not render special characters and anything in between them #1457

amimas opened this issue May 14, 2019 · 2 comments · Fixed by #1458

Comments

@amimas
Copy link

amimas commented May 14, 2019

🐛 Bug Report

I have some headers that has special characters ('<', '>'). Although the headers are rendered fine, the table of content does not render anything in between those characters.

Have you read the Contributing Guidelines on issues?

Yes

To Reproduce

(Write your steps here:)

  1. Create a doc with header like this

    ### `/<context>/status`
  2. Start the dev server and check the table of content

Expected behavior

Table of content should render that header as /<context>/status

(Write what you thought would happen.)

Actual Behavior

Table of content renders the header as //status

image

(Write what happened. Add screenshots, if applicable.)

Reproducible Demo

I think this issue is clearly explained and straight-forward to be able to reproduce. If you still need me to create a separate repo with the issue reproduced, please let me know.

@amimas
Copy link
Author

amimas commented May 16, 2019

@endiliey - Thanks a lot for looking into this so quickly. Is there any chance that this bug fix can be released as version 1.9.1? Not sure if there are any other bug fixes that can also be released at the same time. I could really use this particular fix right now.

@endiliey
Copy link
Contributor

@amimas you can use 2.0.0-alpha.16 if you want temporarily. Available on next tag of docusaurus npm package.

Docusaurus 2 is published under separate package, @docusaurus/core so there won't be any breaking changes on that npm package.

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

Successfully merging a pull request may close this issue.

2 participants