search

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
725 stars 177 forks source link

is it possible to reorder generated sections? #627

Closed ramitheeb closed 4 months ago

ramitheeb commented 5 months ago

What package is the feature request related to?

typedoc-plugin-markdown

Background

is it possible to reorder the generated sections? i want the examples to show up above parameters

Proposed solution

No response

tgreyuk commented 5 months ago

So the ordering currently follows the behaviour of the default theme whereby block tags are intentionally rendered below the signature, but we could introduce an option to re-order how block tags are rendered. Would need to have a bit of a think on how this would be configured.

tgreyuk commented 4 months ago

You can now do:

{
  "blockTagsPreserveOrder": ["@example"]
}

Available in typedoc-plugin-markdown@4.2.0

ramitheeb commented 4 months ago

@tgreyuk thanks!