search

ferdodo / typedoc-plugin-include-example

Typedoc plugin to include files as example
MIT License
4 stars 3 forks source link
example plugin typedoc typedoc-plugin

readme

Npm package npm GitHub Bundle size npm npm

Include examples in your documentations.

$ npm install --save-dev typedoc-plugin-include-example
$ npx typedoc --plugin typedoc-plugin-include-example
/**
 * @includeExample path/to/your/example.ts:1-5,10
 */
function myFunction() {
    // ...
}