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

is it possible to reorder generated sections? #627

Closed
ramitheeb opened this issue Jun 5, 2024 · 3 comments
Closed

is it possible to reorder generated sections? #627

ramitheeb opened this issue Jun 5, 2024 · 3 comments

Comments

@ramitheeb
Copy link

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
Copy link
Member

tgreyuk commented Jun 6, 2024

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
Copy link
Member

tgreyuk commented Jul 10, 2024

You can now do:

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

Available in typedoc-plugin-markdown@4.2.0

@ramitheeb
Copy link
Author

@tgreyuk thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants