Skip to content

No longer compatible with multiple outputs #788

@tgreyuk

Description

@tgreyuk

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

See #787 (comment)

Hi, im trying to setup typedoc so that it generates the default HTML pages and additionally the Markdown for the Github-Wiki. I have the following config (according to the docs):

{
    "entryPoints": ["./src"],
    "entryPointStrategy": "expand",
    "plugin": ["typedoc-plugin-markdown", "typedoc-github-wiki-theme"],
    "outputs": [
        {
            "name": "html",
            "path": "./docs/html"
        },
        {
            // requires typedoc-plugin-markdown
            "name": "markdown",
            "path": "./docs/markdown"
        }
    ]
}

But when i run typedoc i always get:

[info] Loaded plugin typedoc-plugin-markdown
[info] Loaded plugin typedoc-github-wiki-theme
[error] The router 'kind' is not defined. The available routers are: member, module
[error] html output could not be generated due to the errors above
[info] markdown generated at ./docs/markdown
[error] Found 2 errors and 0 warnings

When i exclude the markdown object from the outputs and the plugin key, it works as expected and generates the html. As soon as i add this plugin i get the errors. I tried adding options like:

{
    "entryPoints": ["./src"],
    "entryPointStrategy": "expand",
    "plugin": ["typedoc-plugin-markdown", "typedoc-github-wiki-theme"],
    "outputs": [
        {
            "name": "html",
            "path": "./docs/html",
            "options": {
                "theme": "default",
                "router": "kind"
            }
        },
        {
            // requires typedoc-plugin-markdown
            "name": "markdown",
            "path": "./docs/markdown",
            "options": {
                "theme": "markdown",
                "router": "member"
            }
        }
    ]
}

But i still get the same errors.

I tested this with a fresh pnpm create vite@latest project

TypeDoc configuration

No response

Expected behavior

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugIssue raised as a bug.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions