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
697 stars 173 forks source link

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

Closed mtirionMSFT closed 3 months ago

mtirionMSFT commented 10 months ago

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 commented 10 months ago

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 commented 10 months ago

@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 commented 10 months ago

@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 commented 10 months ago

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

tgreyuk commented 3 months ago

typedoc-plugin-markdown@4.0.0