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
689 stars 172 forks source link

Could not write when excludeScopesInPaths true. #610

Closed fenilli closed 1 month ago

fenilli commented 1 month ago

What package is the bug related to?

typedoc-plugin-markdown

Describe the issue

When adding "excludeScopesInPaths": true, the project gves:

[error] Could not write C:\Users\gusta\Documents\Projects\docs-ui\content\api-reference
[error] Documentation could not be generated due to the errors above.

TypeDoc configuration

{
  "entryPoints": [
    "packages/core",
    "packages/vue",
    "packages/addons",
    "packages/i18n",
    "packages/inputs",
    "packages/observer",
    "packages/utils",
    "packages/validation",
    "packages/zod",
  ],
  "plugin": [
    "typedoc-plugin-markdown",
  ],
  "entryPointStrategy": "packages",
  "excludeNotDocumented": true,
  "excludeInternal": true,
  "excludePrivate": true,
  "readme": "none",
  // typedoc-plugin-markdown
  "entryFileName": "index",
  "enumMembersFormat": "table",
  "parametersFormat": "table",
  "propertiesFormat": "table",
  "typeDeclarationFormat": "table",
  "indexFormat": "table",
  "mergeReadme": true,
  "excludeScopesInPaths": true,
}

Expected behavior

It is expected to create a flat structure without the @scope for the projects.

tgreyuk commented 1 month ago

Thank you. Fixed in typedoc-plugin-markdown@4.0.2.