= @ink-feather-org/typedoc-plugin-asciidoctor

This plugin adds README.adoc support to typedoc.
To use this plugin specify the `readme` option for typedoc.

== tsconfig.json

[source, json]
----
{
  "typedocOptions": {
    "entryPoints": ["src/index.ts"],
    "out": "docs",
    "readme": "README.adoc",
    "excludePrivate": true,
    "plugin": [ "@ink-feather-org/typedoc-plugin-asciidoctor" ]
  }
}
----

== Known issues

Typedoc runs the output of asciidoc through a markdown renderer.
Unfortunately there is nothing a plugin can do about that.
This sometimes causes rendering issues.