root README.md inclusion

[FranckFreiburger]

Is it possible to avoid the root README.md file to be included in the output directory ?

My directory structure is :

.git/
build/
src/
docs/
README.md
package.json
...

The command line :

typedoc
 --plugin typedoc-plugin-markdown
 --mode file
 --tsconfig ./build/tsconfig.json
 --inputFiles ./src/index.ts
 --out ./docs
 --hideProjectName true
 --hideBreadcrumbs true
 --namedAnchors true
 --publicPath https://github.com/FranckFreiburger/vue3-sfc-loader/docs/

Then I end up with the README.md in the docs/ directory.

[tgreyuk]

@FranckFreiburger try --readme none

[FranckFreiburger]

@tgreyuk thanks for the trick

Where can I found a complete list of typedoc-plugin-markdown command line options ?

[tgreyuk]

@FranckFreiburger So the plugin options are the ones listed in the README. However in addition you use all applicable TypeDoc arguments https://github.com/TypeStrong/typedoc#arguments

[FranckFreiburger]

My bad, I thought that README.md inclusion was directly related to typedoc-plugin-markdown. Thanks for your help.