typedoc-plugin-markdown
typedoc-plugin-markdown copied to clipboard
A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
### What package is the bug related to? docusaurus-plugin-typedoc ### Describe the issue Single newline characters in @param blocks are preserved in the generated markdown files and are even converted...
### What package is the bug related to? typedoc-plugin-markdown ### Describe the issue After upgrading to version 4.0.1, the links to MDN generated by [`typedoc-plugin-mdn-links`](https://www.npmjs.com/package/typedoc-plugin-mdn-links) include a space in the...
### What package is the bug related to? typedoc-plugin-markdown ### Describe the issue When adding `"excludeScopesInPaths": true,` the project gves: ```sh [error] Could not write C:\Users\gusta\Documents\Projects\docs-ui\content\api-reference [error] Documentation could not...
### What package is the bug related to? typedoc-plugin-markdown ### Describe the issue I am using `typedoc` with `typedoc-plugin-markdown` to generate `.md` documentation of a package. In the entry point...
### What package is the feature request related to? typedoc-plugin-markdown ### Background is it possible to reorder the generated sections? i want the examples to show up above parameters ###...
### What package is the feature request related to? typedoc-plugin-markdown ### Background Up until v4 of the `typedoc-plugin-markdown`, it was possible to have the entry document be in a different...
### What package is the feature request related to? typedoc-plugin-markdown ### Background I have an exported variable that is a deeply nested `const` object. Using `"expandObjects": true`, I get a...
### What package is the feature request related to? typedoc-plugin-markdown ### Background The Cheerio project has [a core class with many, many methods](https://cheerio.js.org/docs/api/classes/Cheerio). The methods are already grouped by category...
### What package is the feature request related to? typedoc-plugin-markdown ### Background Hello! I am using the `outputFileStrategy: "modules"` in order to get the `typedoc-plugin-markdown` to make one Markdown page...
### What package is the feature request related to? typedoc-vitepress-theme ### Background Right now with the vitepress theme I can provide a @packageDocumentation or @module tag to add additional docs...