{"id":24505739,"url":"https://github.com/ioncakephper/typedocinc","last_synced_at":"2026-05-22T14:17:13.006Z","repository":{"id":57383516,"uuid":"301081177","full_name":"ioncakephper/typedocinc","owner":"ioncakephper","description":"Include files in documentation generated with typedoc.","archived":false,"fork":false,"pushed_at":"2020-10-23T17:25:53.000Z","size":2605,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-22T17:07:46.487Z","etag":null,"topics":["documentation","documentation-tool","typedoc","typescript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/ioncakephper.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}},"created_at":"2020-10-04T08:47:24.000Z","updated_at":"2020-10-23T17:25:55.000Z","dependencies_parsed_at":"2022-09-18T12:03:03.175Z","dependency_job_id":null,"html_url":"https://github.com/ioncakephper/typedocinc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioncakephper%2Ftypedocinc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioncakephper%2Ftypedocinc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioncakephper%2Ftypedocinc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioncakephper%2Ftypedocinc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ioncakephper","download_url":"https://codeload.github.com/ioncakephper/typedocinc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243707298,"owners_count":20334614,"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":["documentation","documentation-tool","typedoc","typescript"],"created_at":"2025-01-21T23:31:27.774Z","updated_at":"2026-05-22T14:17:07.971Z","avatar_url":"https://github.com/ioncakephper.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typedocinc\n\nInsert files content in documentation pages generated with `typedoc`.\n\nWith this tool, API documentation writers will insert their own content before and after the original content of a typedoc-generated documentation. For every `.html` file in the original documentation, the tool creates the `\u003cbasename\u003e_before.md` and `\u003cbasename\u003e_after.md` files. Next, the documentation writer adds content in these files. Finally, the tool merges the original documentation and the `before` and `after` files, and saves the new documentation.\n\n## Install\n\nInstall `typedocinc` as `global`:\n\n```bash\nnpm i typedocinc -g\n```\n\nCheck it works:\n\n```bash\ntypedocinc -h\n```\n\n```txt\nUsage: typedocin [options] [command]\n\nIncludes files in documentation generated with typedoc\n\nOptions:\n  -V, --version                output the version number\n  -v, --verbose                show detail messages during execution. (default: false)\n  -h, --help                   display help for command\n\nCommands:\n  prepare|p [options] \u003cpath\u003e   prepare original documentation in \u003cpath\u003e by creating its before and after files\n  build|b [options] \u003cpath\u003e     enhance original documentation in \u003cpath\u003e by mergind before and after files in the original documentation.    \n  generate|g [options] \u003cpath\u003e  prepare before and after files, enhance original documentation in \u003cpath\u003e by mergind before and after files   \n                               in the original documentation.\n  help [command]               display help for command\n```\n\n## Usage\n\n**Get basic help information**\n\n```bash\n// short option name\ntypedocinc -h\n\n// or the long option name\ntypedocinc --help\n\n// or the help command\ntypedocinc help [command]\n```\n\n**Get help for `prepare | p` command**\n\n```bash\ntypedocinc help prepare\n```\n\n```txt\nUsage: typedocin prepare|p [options] \u003cpath\u003e\n\nprepare original documentation in \u003cpath\u003e by creating its before and after files\n\nOptions:\n  -i, --includes \u003cpath\u003e         Path where before and after files will be created.\n  -c, --clear                   Override before and after files (default: false)\n  -d, --defaultIncludes \u003cpath\u003e  Path to file with default content for includes files\n  -b, --beforeIncludes \u003cpath\u003e   Path to file with default before content for includes files\n  -a, --afterIncludes \u003cpath\u003e    Path to file with default after content for includes files\n  -h, --help                    display help for command\n```\n\n**Get help for `build | b` command**\n\n```bash\ntypedocinc help build\n```\n\n```txt\nUsage: typedocin build|b [options] \u003cpath\u003e\n\nenhance original documentation in \u003cpath\u003e by mergind before and after files in the original documentation.\n\nOptions:\n  -i, --includes \u003cpath\u003e  Path where before and after files already exist.\n  -t, --target \u003cpath\u003e    Path where enhanced documentation is saved into.\n  -h, --help             display help for command\n```\n\n**Get help for `generate | g` command**\n\n```bash\ntypedocinc help generate\n```\n\n```txt\nUsage: typedocin generate|g [options] \u003cpath\u003e\n\n\nprepare before and after files, enhance original documentation in \u003cpath\u003e by mergind before and after files in the original documentation.   \n\nOptions:\n  -i, --includes \u003cpath\u003e         Path where before and after files already exist.\n  -t, --target \u003cpath\u003e           Path where enhanced documentation is saved into.\n  -c, --clear                   Override before and after files (default: false)\n  -d, --defaultIncludes \u003cpath\u003e  Path to file with default content for includes files\n  -b, --beforeIncludes \u003cpath\u003e   Path to file with default before content for includes files\n  -a, --afterIncludes \u003cpath\u003e    Path to file with default after content for includes files\n  -h, --help                    display help for command\n```\n\n## Functions\n\n\u003cdl\u003e\n\u003cdt\u003e\u003ca href=\"#createIncludes\"\u003ecreateIncludes(source, includes, options)\u003c/a\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eCreate includes files for an original typedoc documentation.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#buildIncludes\"\u003ebuildIncludes(source, includes, destination, options)\u003c/a\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eMerge includes files into original documentation.\u003c/p\u003e\n\u003cp\u003eCreates a copy of the source documentation containing the includes\nfile for each source file as indicated in the specified folder.\nSaves resulting documentation in provided folder.\u003c/p\u003e\n\u003c/dd\u003e\n\u003cdt\u003e\u003ca href=\"#getDefaultIncludesContent\"\u003egetDefaultIncludesContent(options)\u003c/a\u003e ⇒ \u003ccode\u003estring\u003c/code\u003e | \u003ccode\u003eundefined\u003c/code\u003e\u003c/dt\u003e\n\u003cdd\u003e\u003cp\u003eLoad default includes files as specified in provided keys.\u003c/p\u003e\n\u003c/dd\u003e\n\u003c/dl\u003e\n\n\u003ca name=\"createIncludes\"\u003e\u003c/a\u003e\n\n## createIncludes(source, includes, options)\nCreate includes files for an original typedoc documentation.\n\n**Kind**: global function  \n\n| Param    | Type                | Description                                                                           |\n| -------- | ------------------- | ------------------------------------------------------------------------------------- |\n| source   | \u003ccode\u003estring\u003c/code\u003e | Path of source (original) documentation.                                              |\n| includes | \u003ccode\u003estring\u003c/code\u003e | Path to includes folder. Create before and after includes files for each source file. |\n| options  | \u003ccode\u003eobject\u003c/code\u003e | Object with key-value pairs                                                           |\n\n\u003ca name=\"buildIncludes\"\u003e\u003c/a\u003e\n\n## buildIncludes(source, includes, destination, options)\nMerge includes files into original documentation.\n\nCreates a copy of the source documentation containing the includes\nfile for each source file as indicated in the specified folder.\nSaves resulting documentation in provided folder.\n\n**Kind**: global function  \n\n| Param       | Type                | Description                                                        |\n| ----------- | ------------------- | ------------------------------------------------------------------ |\n| source      | \u003ccode\u003estring\u003c/code\u003e | Path to source documentation.                                      |\n| includes    | \u003ccode\u003estring\u003c/code\u003e | Path to folder with includes files.                                |\n| destination | \u003ccode\u003estring\u003c/code\u003e | Path to resulting documentation, with original and includes files. |\n| options     | \u003ccode\u003eobject\u003c/code\u003e | Object with options for building files.                            |\n\n\u003ca name=\"getDefaultIncludesContent\"\u003e\u003c/a\u003e\n\n## getDefaultIncludesContent(options) ⇒ \u003ccode\u003estring\u003c/code\u003e \\| \u003ccode\u003eundefined\u003c/code\u003e\nLoad default includes files as specified in provided keys.\n\n**Kind**: global function  \n**Returns**: \u003ccode\u003estring\u003c/code\u003e \\| \u003ccode\u003eundefined\u003c/code\u003e - If file exists, the content of the file, or `undefined` otherwise.  \n\n| Param   | Type                | Description                                                                                                       |\n| ------- | ------------------- | ----------------------------------------------------------------------------------------------------------------- |\n| options | \u003ccode\u003eobject\u003c/code\u003e | Object whose keys are role for files and values are filenames {'beforeIncludes: 'path/to/file/to/include/before'} |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fioncakephper%2Ftypedocinc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fioncakephper%2Ftypedocinc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fioncakephper%2Ftypedocinc/lists"}