Hugo theme not working due to unknown options

ManuelRauber commented 1 year ago

npx typedoc
[info] Loaded plugin typedoc-hugo-theme
TypeDoc exiting with unexpected error:
Error: Unknown option 'allReflectionsHaveOwnDocument', you may have meant:
        cname
        excludeNotDocumented
        theme
        name
        readme
        requiredToBeDocumented
        options
        out
    at Options.getValue 
    at HugoTheme.getOption 
    at new MarkdownTheme 
    at new HugoTheme 
    at Renderer.prepareTheme 
    at Renderer.render 
    at async Application.generateDocs 
    at async run

packages:

    "typedoc": "~0.24.7",
    "typedoc-hugo-theme": "~1.0.0",
    "typedoc-plugin-markdown": "~3.15.3",

typedoc.json:

{
  "$schema": "https://typedoc.org/schema.json",
  "entryPoints": ["./projects/api-client/src/index.ts"],
  "tsconfig": "projects/api-client/tsconfig.docs.json",
  "name": "API Docs",
  "plugin": [
    "typedoc-hugo-theme"
  ],
  "theme": "hugo"
}

Any idea what's going wrong here?

tgreyuk commented 1 year ago

To be honest i havent looked at the hugo plugin for a while so it probably needs some work (something for the list). However you will also need to defined the markdown plugin too:

"plugin": [
    "typedoc-plugin-markdown",
    "typedoc-hugo-theme"
  ],

ManuelRauber commented 1 year ago

🤦 That did the trick!

Output looks ok'ish for now. :) I will check it more and come back with there are issues with it.

Thanks @tgreyuk

typedoc2md / typedoc-plugin-markdown

Hugo theme not working due to unknown options #431