{"id":28002356,"url":"https://github.com/drarig29/typedoc-plugin-extras","last_synced_at":"2025-05-09T00:17:49.855Z","repository":{"id":45346873,"uuid":"262678849","full_name":"Drarig29/typedoc-plugin-extras","owner":"Drarig29","description":"A plugin for TypeDoc which adds extras to the generated documentation","archived":false,"fork":false,"pushed_at":"2025-01-07T17:28:57.000Z","size":311,"stargazers_count":13,"open_issues_count":1,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-09T00:17:39.395Z","etag":null,"topics":["hacktoberfest","typedoc","typedoc-plugin"],"latest_commit_sha":null,"homepage":"https://drarig29.github.io/typedoc-plugin-extras/","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/Drarig29.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2020-05-09T23:44:20.000Z","updated_at":"2025-01-07T17:28:39.000Z","dependencies_parsed_at":"2024-06-18T18:39:42.398Z","dependency_job_id":"cdd7db76-e595-409f-8a2e-12862ff4cac1","html_url":"https://github.com/Drarig29/typedoc-plugin-extras","commit_stats":{"total_commits":105,"total_committers":6,"mean_commits":17.5,"dds":"0.10476190476190472","last_synced_commit":"c1d32d315547ac89e7958c9b0e7c7a6cd57208a7"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Drarig29%2Ftypedoc-plugin-extras","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Drarig29%2Ftypedoc-plugin-extras/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Drarig29%2Ftypedoc-plugin-extras/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Drarig29%2Ftypedoc-plugin-extras/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Drarig29","download_url":"https://codeload.github.com/Drarig29/typedoc-plugin-extras/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253166496,"owners_count":21864482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["hacktoberfest","typedoc","typedoc-plugin"],"created_at":"2025-05-09T00:17:49.185Z","updated_at":"2025-05-09T00:17:49.833Z","avatar_url":"https://github.com/Drarig29.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typedoc-plugin-extras\n\n[![npm](https://img.shields.io/npm/v/typedoc-plugin-extras.svg)](https://www.npmjs.com/package/typedoc-plugin-extras)\n\n**This plugin only works for HTML documentation.**\n\nA [TypeDoc](https://github.com/TypeStrong/typedoc) plugin to add extras to the output documentation.\n\nIt allows you to:\n\n- Add the date/time of generation after \"Generated using TypeDoc\" in the footer. (cf. the [example](#example) below)\n- Set a custom top-most title name (without changing the package name, like `--name` would do).\n  - For example, you could have `--customTitle \"Go back\" --titleLink \u003curl-of-your-parent-documentation\u003e`\n- And more... (cf. the list of [arguments](#arguments) below)\n\n**No date/time will be added if `--hideGenerator` is set (because the footer wouldn't exist).**\n\nAll extras are disabled by default: they are opt-in.\n\nFeel free to ask for another extra or to make a PR 😉\n\n\u003e [!IMPORTANT]  \n\u003e TypeDoc [now natively supports specifying a favicon](https://typedoc.org/documents/Options.Output.html#favicon). Consequently, the `--favicon` option in this plugin has been removed to prevent conflicts.\n\n## Example\n\n![example](./public/example.png)\n\nYou also can view an example documentation using the plugin here:\n\nhttps://drarig29.github.io/typedoc-plugin-extras/\n\n## Installation\n\n```bash\nnpm install --save-dev typedoc-plugin-extras\n```\n\n## Usage\n\n```bash\n$ npx typedoc --plugin typedoc-plugin-extras [args]\n```\n\n## Arguments\n\nThe following arguments can be used in addition to the default [TypeDoc arguments](https://github.com/TypeStrong/typedoc#arguments).\n\n- `--customTitle`\u003cbr\u003e\n  Specify a custom title, for the top-most title only.\u003cbr\u003e\n  Example: `foo`\n\n- `--customDescription`\u003cbr\u003e\n  Specify a custom `\u003cmeta name=\"description\"` property.\u003cbr\u003e\n  Example: `An example description`\n\n- `--footerTypedocVersion`\u003cbr\u003e\n  Appends the TypeDoc version in the footer.\u003cbr\u003e\n  Default: `false`\n\n- `--footerLastModified`\u003cbr\u003e\n  Appends a \"Last Modified\" text in the footer (e.g. \"Last modified 6 min. ago\").\u003cbr\u003e\n  Default: `false`\u003cbr\u003e\n  **Note:** If specified, the `--footerDate` and `--footerTime` options are ignored.\n\n- `--footerDate` (deprecated)\u003cbr\u003e\n  Appends the date of generation in the footer (e.g. \"Jul 29, 2022\").\u003cbr\u003e\n  Default: `false`\u003cbr\u003e\n  **Note:** If combined with `--footerTime`, it will append \"Jul 29, 2022, 3:44:42 PM GMT+2\".\n\n- `--footerTime` (deprecated)\u003cbr\u003e\n  Appends the time of generation in the footer (e.g. \"3:44:42 PM GMT+2\").\u003cbr\u003e\n  Default: `false`\u003cbr\u003e\n  **Note:** If combined with `--footerDate`, it will append \"Jul 29, 2022, 3:44:42 PM GMT+2\".\n\n## Testing\n\nTo test this plugin, you can generate TypeDoc documentation for this plugin.\n\nTo do so, you'll first need to build it:\n\n```bash\nnpm run build\n```\n\nThen, you can generate the documentation with the plugin (from source):\n\n```bash\nnpm test\n```\n\n## License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrarig29%2Ftypedoc-plugin-extras","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrarig29%2Ftypedoc-plugin-extras","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrarig29%2Ftypedoc-plugin-extras/lists"}