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

Insufficient information about references #254

Closed
KillyMXI opened this issue Oct 5, 2021 · 2 comments
Closed

Insufficient information about references #254

KillyMXI opened this issue Oct 5, 2021 · 2 comments

Comments

@KillyMXI
Copy link

KillyMXI commented Oct 5, 2021

Let's say I have following exports:

/** ... */
export function foo () {};

export { foo as bar };

typedoc generates html with following contents in the References section:

bar
Renames and re-exports foo

I wish it just shown that foo has an alias bar, but it is still usable as is.


typedoc-plugin-markdown generates following contents in the References section:

### bar**bar**: `Object`

bar

bar: Object

This is unusable - reference target is lost.
Is it possible to make it on par with typedoc itself?
Or is there a way to remove the References section from the output at least?
It really makes no sense to put it into documentation like this.

@tgreyuk
Copy link
Member

tgreyuk commented Oct 5, 2021

typedoc-plugin-markdown@3.11.3 contains a fix that should make references behave in the same way as the typedoc html theme. To hide completely I think would be responsibility of a custom plugin. Similar request here TypeStrong/typedoc#1271

@KillyMXI
Copy link
Author

KillyMXI commented Oct 5, 2021

Awesome! It works fine now.
Thank you for a quick fix!

@KillyMXI KillyMXI closed this as completed Oct 5, 2021
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