search

krisztianb / typedoc-plugin-merge-modules

Plugin for TypeDoc that merges the content of modules
ISC License
21 stars 4 forks source link

projectDocuments option not working #17

Open eu81273 opened 3 weeks ago

eu81273 commented 3 weeks ago

TypeDoc v0.26 added projectDocuments option to support including external markdown pages. https://typedoc.org/example/documents/External_Markdown.html

But with this plugin, projectDocuments option is not working at all.

krisztianb commented 3 weeks ago

Hi. This sounds like something I overlooked in the last major TypeDoc update. Do you have a repository with an example?

dbohdiev commented 2 weeks ago

Facing the same issue. Here is the config I'm using:

  "$schema": "https://typedoc.org/schema.json",

  "entryPoints": [
    "src/app/directives/",
    "src/app/services/",
    "src/app/utils/",
  ],
  "entryPointStrategy": "expand",
  "projectDocuments": ["documentation/*.md"],
  "out": "./docs",

  "tsconfig": "tsconfig.app.json",
  "plugin": ["typedoc-plugin-merge-modules"]
krisztianb commented 1 week ago

Hi guys. I released version 6.0.1 which should no longer remove project documentations. 🎉 Please test the new version and report back if it is working as expected for your use cases. Thank you.