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

< and > character are prefixed with \ in breadcrumb and sidebar title #557

Closed
axel7083 opened this issue Jan 30, 2024 · 3 comments
Closed
Labels
next Fix available in the '@next' release

Comments

@axel7083
Copy link
Contributor

image

I am using the following dependencies

  • "typedoc-plugin-markdown": "4.0.0-next.43"
  • "typedoc": "0.25.7"
  • "docusaurus-plugin-typedoc": "1.0.0-next.25"

Here is the EventEmitter code in typescript, it is a generic type.

  /**
   * A class to create and manage an {@link Event} for clients to subscribe to.
   * The emitter can only send one kind of event.
   *
   * Use this class to send events inside extension or provide API to the other
   * extensions.
   */
  export class EventEmitter<T> {
    /**
     * For the public to allow to subscribe to events from this Emitter
     */
    event: Event<T>;
    /**
     * To fire an event to the subscribers
     * @param event The event to send to the registered listeners
     */
    fire(data: T): void;
    /**
     * Dispose by removing registered listeners
     */
    dispose(): void;
  }
@nicfv
Copy link

nicfv commented Jan 30, 2024

I've experienced this in other areas as well, e.g. constructors:

image

@tgreyuk
Copy link
Member

tgreyuk commented Jan 30, 2024

So the plugin isn't designed to be used with an autogenerated sidebar configuration. If you follow the instructions here https://www.typedoc-plugin-markdown.org/integrations/docusaurus/guides/sidebar , then you won't experience these issues. You can use a mixture of autogenerated and manual config by using sidebar slices (if required).

@tgreyuk tgreyuk added the next Fix available in the '@next' release label Jan 30, 2024
@axel7083
Copy link
Contributor Author

Closing as resolved by using sidebar config generated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next Fix available in the '@next' release
Projects
None yet
Development

No branches or pull requests

3 participants