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

docs: change angle brackets to backticks in comment #1726

Merged
merged 1 commit into from
Dec 22, 2021

Commits on Dec 17, 2021

  1. Fix: change angle brackets to backticks in comment

    This change was done b/c the angle brackets break the compiler for [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown), a library for converting Typedoc to markdown. It interprets the angle brackets as an HTML tag, whereas it's just being used for emphasis.
    
    This issue occurred specifically when using [docusaurus-plugin-typedoc](https://www.npmjs.com/package/docusaurus-plugin-typedoc). More details about this problem can be found here - typedoc2md/typedoc-plugin-markdown#276
    
    This change fixes the issues by replacing the backticks (`<` and `>`) with markdown backticks to highlight the word and achieve the same desired emphasis without breaking the markdown parser.
    
    i was able to validate that this works in my local environment.
    mongodben committed Dec 17, 2021
    Configuration menu
    Copy the full SHA
    5facd6a View commit details
    Browse the repository at this point in the history