typedoc-plugin-markdown

typedoc-plugin-markdown copied to clipboard

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

4

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...

mtirionMSFT

How to improve the formatting for types?

4

The output of `typedoc-plugin-markdown` can sometimes be very difficult to read, especially when compared to its HTML counterpart. Here's an example of HTML and Markdown outputs from the same codebase:...

ziad-saab

[next] Items in tables are not linkable

4

When referring to some items using `{@ link }` syntax it can result in broken links when using a table format and referencing an object in that table. This so...

lorenzolewis

[docusaurus-plugin-typedoc]: add the ability to add a separate frontmatter for readme file.

1

Readme is an essential part of the documentation, sometimes it serves as the main page for docs, I want to add a separate frontmatter for a readme file, such as...

aamir1995

Add custom partials and templates

2

Just after I finished this, I noticed the `next` branch which totally refactors the templating process, so this solution won't work once you roll that out. However, here's a pull...

dustinboss

`@group` is not respected when placed over a `type` and `allReflectionsHaveOwnDocument` is `false`

10

I'm migrating MapLibre project documentation site to use TSDoc comments + TypeDoc + this plugin + mkdocs. When I generate the site with out using this plugin I get the...

HarelM

Export Docusaurus plugin options type

1

Could you also export the type of the plugin options of Docusaurus so it could be used with JSDoc like this? ```js /** @type {import('@docusaurus/types').Config} */ const config = {...

PatrikTrefil

How to export interface as a table

10

I find the table form is more beautiful, can I output the definition of interface as a table form now?

ccnwjsqdfky55

Copy referenced markdown and assets in the README.md

2

Im using the docusaurus plugin within a monorepo. So I use a single instance of the plugin for each library in the repo. So libraries link to other markdown files...

blessanm86

Using "vuepress" theme independently

3

It appears currently impossible to use the "vuepress" theme (which is the "markdown" theme with the vuepress-specific slugification : https://github.com/tgreyuk/typedoc-plugin-markdown/commit/78cd78fa5d0ddf0f328459e715099085c45b3b23 ), without using the `vuepress-plugin-typedoc` plugin for VuePress. What I...

arantes555