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

"_" is removed in sidebar and search box from some header containing underscore #1208

Open
1 task done
nelson6e65 opened this issue Jan 19, 2019 · 2 comments
Open
1 task done

Comments

@nelson6e65
Copy link
Contributor

nelson6e65 commented Jan 19, 2019

  • I confirm that this is an issue rather than a question.

Bug report

When I have a header (## ) that contains an underscore (_), the title in sidebar misses the _ character. Also, in the search box result title is displayed without _ and also is exclude from results if I type the title containing _.

The weird thing is that this does not happen in all cases:

Screenshot-1

NML_VERSION, in this case, works as expected.

PD: The link reference is ok, like in the screenshot that works fine (https://nelson6e65.github.io/php_nml/api/constants.html#nml-gettext-domain)

Version

  • 0.14.8
  • 1.0.0-alpha.32

Steps to reproduce

  • Generate documentation
  • View resulting page

What is expected?

  • Headers containing _ are searchable.
  • Display _ in sidebar and search box (from screenshot: NML_GETTEXT_DOMAIN)

What is actually happening?

_ is being hidden from sidebar and search in some cases

Other relevant information

  • Your OS: Fedora 28
  • Node.js version: v8.11.2
  • Browser version: Chrome
  • Is this a global or local install? Both
  • Which package manager did you use for the install?
@nelson6e65
Copy link
Contributor Author

nelson6e65 commented Jan 19, 2019

If I escape _ in the title, they display well:

- ## NML_GETTEXT_DOMAIN
+ ## NML\_GETTEXT\_DOMAIN

Maybe is misinterpreted as markdown cursive in sidebar and search indexes?

@pajachiet
Copy link

Maybe a duplicate of #544 ?

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

No branches or pull requests

2 participants