search

google / typedoc-neo-theme

Apache License 2.0
85 stars 22 forks source link

Unable to install and use typedoc-neo-theme #84

Open brianpilati opened 2 years ago

brianpilati commented 2 years ago

These are the steps I am taking and the errors I am receiving:

$ npm i --save-dev typedoc-neo-theme

package.json

"typedoc": "^0.22.12", "typedoc-neo-theme": "^1.1.1",

$ yarn build:theme yarn run v1.22.17 error Command "build:theme" not found.

$ yarn build:plugin yarn run v1.22.17 error Command "build:plugin" not found.

typedoc.json

{ "entryPoints": ["./app"], "entryPointStrategy": "expand", "out": "documentation", "excludePrivate": false, "excludeProtected": false, "includeVersion": true, "readme": "./README.md", "sort": ["static-first", "visibility", "alphabetical", "enum-value-ascending"], "cleanOutputDir": true, "treatWarningsAsErrors": false, "plugin": "typedoc-neo-theme", "theme": "./node_modules/typedoc-neo-theme/bin/default" }

Final command

$ ./node_modules/.bin/typedoc Error: Invalid structure in plugin typedoc-neo-theme, no load function found.

Thoughts? helps?

Fleker commented 2 years ago

Similar to #75 this theme requires typedoc v0.20.x to run. Additionally, the build commands you're using for the development of the theme and not the use in your project.