{"id":18792078,"url":"https://github.com/tgreyuk/typedoc-plugin-inline-sources","last_synced_at":"2026-03-11T10:32:30.599Z","repository":{"id":57383491,"uuid":"372325199","full_name":"tgreyuk/typedoc-plugin-inline-sources","owner":"tgreyuk","description":"A plugin for TypeDoc that inlines source code into documentation.","archived":false,"fork":false,"pushed_at":"2025-05-11T21:31:35.000Z","size":733,"stargazers_count":7,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-27T12:04:17.746Z","etag":null,"topics":["code","source","typedoc"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tgreyuk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-05-30T22:13:58.000Z","updated_at":"2025-05-11T21:31:09.000Z","dependencies_parsed_at":"2024-11-07T21:18:38.270Z","dependency_job_id":"ce6e9bc4-84b9-48d3-8cb5-524974aff764","html_url":"https://github.com/tgreyuk/typedoc-plugin-inline-sources","commit_stats":{"total_commits":21,"total_committers":2,"mean_commits":10.5,"dds":0.4285714285714286,"last_synced_commit":"b60f08a48ad993d5e55dc70baef9cf465c7517e0"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/tgreyuk/typedoc-plugin-inline-sources","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgreyuk%2Ftypedoc-plugin-inline-sources","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgreyuk%2Ftypedoc-plugin-inline-sources/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgreyuk%2Ftypedoc-plugin-inline-sources/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgreyuk%2Ftypedoc-plugin-inline-sources/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tgreyuk","download_url":"https://codeload.github.com/tgreyuk/typedoc-plugin-inline-sources/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgreyuk%2Ftypedoc-plugin-inline-sources/sbom","scorecard":{"id":876172,"data":{"date":"2025-08-11","repo":{"name":"github.com/tgreyuk/typedoc-plugin-inline-sources","commit":"221efa2e35e37a57584f6b599ea06506a5b7800b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.8,"checks":[{"name":"Code-Review","score":1,"reason":"Found 2/20 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/release-please.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":2,"reason":"dependency not pinned by hash detected -- score normalized to 2","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/tgreyuk/typedoc-plugin-inline-sources/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/tgreyuk/typedoc-plugin-inline-sources/ci.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/tgreyuk/typedoc-plugin-inline-sources/release-please.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/tgreyuk/typedoc-plugin-inline-sources/release-please.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-please.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/tgreyuk/typedoc-plugin-inline-sources/release-please.yml/main?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:19","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   1 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release-please.yml:7"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 12 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-xffm-g5w8-qvg7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T06:05:03.355Z","repository_id":57383491,"created_at":"2025-08-24T06:05:03.355Z","updated_at":"2025-08-24T06:05:03.355Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30378086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-11T06:09:32.197Z","status":"ssl_error","status_checked_at":"2026-03-11T06:09:17.086Z","response_time":84,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code","source","typedoc"],"created_at":"2024-11-07T21:18:16.728Z","updated_at":"2026-03-11T10:32:30.582Z","avatar_url":"https://github.com/tgreyuk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typedoc-plugin-inline-sources\n\nA plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that inlines source code into documentation.\n\n[![npm](https://img.shields.io/npm/v/typedoc-plugin-inline-sources.svg)](https://www.npmjs.com/package/typedoc-plugin-inline-sources) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-inline-sources/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/tgreyuk/typedoc-plugin-inline-sources/actions/workflows/ci.yml)\n\n## Contents\n\n- [Overview](#overview)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Documentation](#documentation)\n  - [`@source` Tag](#source-tag)\n  - [Displaying an alternative title](#displaying-an-alternative-title)\n  - [Handling \"unknown block tag\" warning](#handling-unknown-block-tag-warning)\n- [License](#license)\n\n## Overview\n\nBy default, when you generate documentation using TypeDoc, it includes a \"Defined in\" section at the bottom of each symbol, linking to the relevant line in the source file.\n\nThis plugin can be used if you additionally require the symbols source code to be included in the generated documentation.\n\n## Installation\n\n```bash\nnpm install --save-dev typedoc-plugin-inline-sources\n```\n\n## Usage\n\nSimply add the plugin to your `typedoc.json` or equivalent config file.\n\n```json\n{\n  \"plugin\": [\"typedoc-plugin-inline-sources\"]\n}\n```\n\n## Documentation\n\n### `@source` Tag\n\nThe **`@source`** tag is a custom documentation tag used to include the source code directly within the generated output documentation. This is particularly useful where you not only want to describe the functionality of a symbol but also display the actual code for reference.\n\nHere’s an example of a function with the @source tag included:\n\n#### Typescript\n\n```ts\n/**\n * Logs a greeting message to the console.\n *\n * @source Optional source comments\n */\nexport function greet(): void {\n  console.log('Hello, welcome to TypeScript!');\n}\n```\n\n#### Output\n\n\u003cimg src=\"images/example-1.png\" style=\"max-width:700px\"\u003e\n\n### Displaying an alternative title\n\nBlock tags are output as \"title case\" headings in the final output. If you would like an alternative heading to \"Source\" you can replace locale entry for the tag:\n\n```json\n\"locales\": {\n    \"en\": {\n      \"tag_source\": \"My Source Code\"\n    }\n  }\n```\n\n### Handling \"unknown block tag\" warning\n\nWhen using the tag, TypeDoc (since 0.26) will generate the following warning:\n\n```shell\n[warning] Encountered an unknown block tag @source\n```\n\nTo suppress this warning you have two options.\n\n#### 1. Using the `--blockTags` TypeDoc option:\n\nYou can extend the tag defaults by using a JavaScript configuration file:\n\n```ts\nimport { OptionDefaults } from 'typedoc';\n\nconst config = {\n  blockTags: [...OptionDefaults.blockTags, '@source'],\n};\n```\n\nSee https://typedoc.org/options/comments/#blocktags.\n\n#### 2. Adding a `tsdoc.json` file:\n\nYou add a `tsdoc.json` file next to your `tsconfig.json` file and include the `@source` tag name.\n\n```json\n{\n  \"$schema\": \"https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json\",\n  \"extends\": [\"typedoc/tsdoc.json\"],\n  \"tagDefinitions\": [\n    {\n      \"tagName\": \"@source\",\n      \"syntaxKind\": \"block\"\n    }\n  ]\n}\n```\n\nSee https://typedoc.org/options/configuration/#tsconfig.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftgreyuk%2Ftypedoc-plugin-inline-sources","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftgreyuk%2Ftypedoc-plugin-inline-sources","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftgreyuk%2Ftypedoc-plugin-inline-sources/lists"}