typedoc-plugin-markdown

typedoc-plugin-markdown copied to clipboard

Recommended way to match format and styles

4

hi there, i want to use this project to match the documentation formatting and styling coming out of pydoc-markdown. what is the recommended way to adjusting the formatting and styling...

jeffchuber

Error from plugin does not crash Docusaurus build

1

## Observed behavior If the generation of the markdown files throws errors, then the whole build is considered to be successful. ## Expected behavior The build should fail. ## Steps...

PatrikTrefil

Broken Link caused by Typescript class being defined in an index file

3

Note: I have previously discussed this bug on the docusaurus repo and they referred me here. I have created a reproduction for the bug in this repo: https://github.com/rbala19/docusarus-reprod. Because this...

rbala19

The readmeFile param monorepo config is not considered when the .md file is generated

1

As it says in https://typedoc.org/guides/monorepo/#typedoc-package-config, the README file set in the `readmeFile` config should be displayed on the index page of the package doc. Still, when the plugin generates the...

maz-e

Markdown plugin inserts unnecessary escape characters

4

Hello, and thanks for the plugin. ### What `typedoc-plugin-markdown` currently does In the Markdown format, underscores are used to denote italics and bold. Thus, this plugin zealously escapes them at...

Zamiell

Potential bug with optional function argument

2

Hello, I think I found a bug in the plugin. Here's the source code for a function called "spawnCustomGridEntity": We can see that it has, in order: - 2 mandatory...

Zamiell

Hi team, I am unable to generate typedoc and getting below error Info: Loaded plugin typedoc-plugin-markdown Rendering [====------------------------------------] 10%TypeDoc exiting with unexpected error: TypeError: Right-hand side of 'instanceof' is not...

supriyavedpathak

Version Packages

1

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically....

github-actions[bot]

Broken tables

11

### What package is the bug related to? typedoc-plugin-markdown ### Describe the issue Related to #615 Issues I notice with table formatting, in version 4.0.2. ## Interface members, unexpected line-breaks...

KillyMXI

Generates Filenames with special chars

4

### What package is the bug related to? typedoc-plugin-markdown ### Describe the issue I used the 4.0.1 on https://github.com/project-chip/matter.js with the updated config in https://github.com/project-chip/matter.js/pull/875 and got this warning: >...

Apollon77