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

Provide a Configuration to Generate Object Type Declaration Members in List Mode #362

Closed
capraynor opened this issue Oct 28, 2022 · 3 comments

Comments

@capraynor
Copy link

capraynor commented Oct 28, 2022

Hi, I'm about to create a configuration:

objectTypeDeclarationStyle: "table" | "list". 

This configuration behaviors like the following:

When objectTypeDeclarationStyle == "table": (default value)
The "Object Type Declaration" (the type declaration that have children) will be rendered as table.
The "Call Signature Type Declaration" will works as before.
The "Union Type Declaration" will works as before.

When objectTypeDeclarationStyle == "list":
The "Object Type Declaration" (the type declaration that have children) will be rendered as list, just like current behavior of class properties.
The "Call Signature Type Declaration" will works as before.
The "Union Type Declaration" will works as before.

Will submit my PR with test spec later.

@capraynor
Copy link
Author

capraynor commented Oct 28, 2022

Related: #109, but won't solve #109 in this work item.

@capraynor capraynor changed the title Provide a Configuration to Generate Object Type Declaration Members in Plain Mode Provide a Configuration to Generate Object Type Declaration Members in List Mode Oct 28, 2022
capraynor added a commit to capraynor/typedoc-plugin-markdown that referenced this issue Oct 28, 2022
@capraynor
Copy link
Author

If use objectTypeDeclarationStyle == "list":

The rendered result will be:
image

And the multi line comment will shows like:

image

@tgreyuk
Copy link
Member

tgreyuk commented Dec 2, 2022

Thanks. PR merged available in typedoc-plugin-markdown@3.14.0.

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

No branches or pull requests

2 participants