typedoc-plugin-include-example
Advanced tools
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() {
// ...
}
FAQs
Typedoc plugin to include files as example
The npm package typedoc-plugin-include-example receives a total of 811 weekly downloads. As such, typedoc-plugin-include-example popularity was classified as not popular.
We found that typedoc-plugin-include-example demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
npm now supports Trusted Publishing with OIDC, enabling secure package publishing directly from CI/CD workflows without relying on long-lived tokens.
Research
/Security News
A RubyGems malware campaign used 60 malicious packages posing as automation tools to steal credentials from social media and marketing tool users.
Security News
The CNA Scorecard ranks CVE issuers by data completeness, revealing major gaps in patch info and software identifiers across thousands of vulnerabilities.