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

Using the pluging always result in 1 module page with undefined links #474

Closed
mtirionMSFT opened this issue Sep 25, 2023 · 5 comments
Closed

Comments

@mtirionMSFT
Copy link

This is a Newby question for this plugin I'm afraid.

typedoc normally generates a hierarchy of the APi. Adding this plugin with or without --allReflectionsHaveOwnDocument results in a modules.md (just that one) with all links as undefined. Piece of the generated code:

## Table of contents

### Classes

- [Calendar](undefined)

### Interfaces

- [AbsolutePosition](undefined)
- [AbsolutePositionOutput](undefined)

typedoc has seperate files for classes, functions, interfaces and types. How can I get that and fix the link issue?

@tgreyuk
Copy link
Member

tgreyuk commented Sep 25, 2023

typedoc has seperate files for classes, functions, interfaces and types. How can I get that and fix the link issue?

If recommend using the 'next' version that exports all members to own file (as per html theme) as default:

https://github.com/tgreyuk/typedoc-plugin-markdown/tree/next/packages/typedoc-plugin-markdown#readme

@mtirionMSFT
Copy link
Author

@tgreyuk aha, that's useful. However, just tried it - @next version doesn't output anything now except for a .nojekyll file. Any way to see what's going wrong? I have tested I'm using the correct version.

@tgreyuk
Copy link
Member

tgreyuk commented Sep 26, 2023

@mtirionMSFT ok that is not correct - i don't suppose you'd be able to share your code/repo? I would be interested to know what is causing your issue and fix it?

@mtirionMSFT
Copy link
Author

@tgreyuk no, can't share that I'm afraid. Let me see if I can "minify" the problem.

@tgreyuk
Copy link
Member

tgreyuk commented May 3, 2024

typedoc-plugin-markdown@4.0.0

@tgreyuk tgreyuk closed this as completed May 3, 2024
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