typedoc-plugin-inline-sources
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

typedoc-plugin-inline-sources

A plugin for TypeDoc that inlines source code into documentation.

npm Build Status

What it does?

The plugin retrieves the source from the ts compiler and injects within fenced code blocks.

Installation

npm install --save-dev typedoc typedoc-plugin-inline-sources

Usage

Simply use the @source annotation in your comments. This will create a tag with the inlined source code.

Code

/**
 * Comments for variable
 *
 * @source source tag comment?
 */
export const message = "Hello World!";

Output

image

Readme

Keywords

Package Sidebar

Install

npm i typedoc-plugin-inline-sources

Weekly Downloads

621

Version

1.0.2

License

MIT

Unpacked Size

6.52 kB

Total Files

5

Last publish

Collaborators

  • tgreyuk