You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I just got started using the typedoc-plugin-markdown plugin (and typedoc in general). First of all: this is an awesome project, thank you so much for investing your time in helping other generate great docs out of JSDoc.
While using this plugin, I noticed that @example blocks are rendered in a weird way, where "Example" is not a headline, but rendered as bold code:
Input
/** * A function that does something. * * @example * This is an example * * ```ts * const foo = 'bar'; * * @param name - Your name * @returns Whether the name is not null */exportfunctionmyFunction(name: string){returnname!=null;}
### myFunction
▸ **myFunction**(`name`): `boolean`
A function that does something.
#### Parameters
| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | `string` | Your name |
#### Returns
`boolean`
Whether the name is not null
**`Example`**
This is an example
```ts
const foo = 'bar';
```
#### Defined in
...
In my opinion, it should be rendered as #### Example, just like the other headlines.
Is there a way to customize this behavior, or is this a bug?
The text was updated successfully, but these errors were encountered:
I just got started using the
typedoc-plugin-markdown
plugin (andtypedoc
in general). First of all: this is an awesome project, thank you so much for investing your time in helping other generate great docs out of JSDoc.While using this plugin, I noticed that
@example
blocks are rendered in a weird way, where "Example" is not a headline, but rendered as bold code:Input
In my opinion, it should be rendered as
#### Example
, just like the other headlines.Is there a way to customize this behavior, or is this a bug?
The text was updated successfully, but these errors were encountered: