typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
689 stars 172 forks source link

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

Closed axel7083 closed 5 months ago

axel7083 commented 5 months ago
image

I am using the following dependencies

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 commented 5 months ago

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

image

tgreyuk commented 5 months ago

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).

axel7083 commented 5 months ago

Closing as resolved by using sidebar config generated