You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

typedoc-plugin-include-example

Package Overview
Dependencies
1
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

typedoc-plugin-include-example

Typedoc plugin to include files as example


Version published
Maintainers
1
Created

Readme

Source

The typedoc-plugin-include-example plugin allows TypeDoc users to include code examples from external files directly into their documentation.

Installation

npm install typedoc-plugin-include-example --save-dev

Usage

  1. In your TypeScript comments, add the @includeExample directive followed by the path of the file you wish to include:
/**
 * This is a sample function.
 *
 * @includeExample path/to/your/example.ts
 */
function myFunction() {
  // ...
}

@includeExample can also take in line numbers to include a specific range of lines from the file:

/**
 * This is a sample function of how to include lines 1-5 and 10 from `path/to/your/example.ts`
 *
 * @includeExample path/to/your/example.ts:1-5,10
 */
function myFunction() {
  // ...
}
  1. When generating documentation with TypeDoc, make sure to include the plugin:
typedoc --plugin typedoc-plugin-include-example

License

MIT

Keywords

FAQs

Package last updated on 09 Feb 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc