https://github.com/ink-feather-org/typedoc-plugin-asciidoctor

Adds README.adoc support to typedoc.
https://github.com/ink-feather-org/typedoc-plugin-asciidoctor

asciidoctor typedoc-plugin typedocplugin typescript

Last synced: about 1 month ago
JSON representation

Adds README.adoc support to typedoc.

• Host: GitHub
• URL: https://github.com/ink-feather-org/typedoc-plugin-asciidoctor
• Owner: ink-feather-org
• License: gpl-3.0
• Created: 2022-04-07T08:40:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-06T12:39:06.000Z (over 2 years ago)
• Last Synced: 2024-08-10T09:14:37.636Z (5 months ago)
• Topics: asciidoctor, typedoc-plugin, typedocplugin, typescript
• Language: TypeScript
• Homepage:
• Size: 112 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= @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.

== What this plugin does:

Take a 'README.adoc' and render it to 'html' before sending it off to typedoc which then passes it to the output generator.

== What this plugin does NOT do:

Add support for typedoc to generate '.adoc' output.

== In other words

This plugin does NOT enable you to use ascii-doc in the javadoc comments ONLY in the README.

It also does NOT generate '.adoc' output. It only integrates an existing 'README.adoc' into the typedoc output.

== Try the example

Steps:

. Clone the repo

. cd into example

. pnpm i

. pnpm run docs

. Verify that the typedoc generated correctly

Only try to integrate my plugin into your project after you have verified that the example works.

== Contributing

Pull requests that add ascii-doc output functionality are welcome (https://github.com/ink-feather-org/typedoc-plugin-asciidoctor/issues/1[Issue]).