{"id":18063005,"url":"https://github.com/stagas/dokio","last_synced_at":"2025-09-03T14:36:08.116Z","repository":{"id":50540668,"uuid":"477684772","full_name":"stagas/dokio","owner":"stagas","description":"Documentation generator for TypeScript projects","archived":false,"fork":false,"pushed_at":"2022-08-21T06:36:11.000Z","size":66,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-13T06:08:18.502Z","etag":null,"topics":["api-docs","api-documentation","documentation-generator","readme-generator","typescript"],"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/stagas.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":"2022-04-04T12:10:33.000Z","updated_at":"2022-11-17T09:59:34.000Z","dependencies_parsed_at":"2022-08-12T21:40:40.279Z","dependency_job_id":null,"html_url":"https://github.com/stagas/dokio","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":"stagas/ts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stagas%2Fdokio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stagas%2Fdokio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stagas%2Fdokio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stagas%2Fdokio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stagas","download_url":"https://codeload.github.com/stagas/dokio/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247340472,"owners_count":20923266,"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":["api-docs","api-documentation","documentation-generator","readme-generator","typescript"],"created_at":"2024-10-31T05:09:07.924Z","updated_at":"2025-04-05T13:23:46.626Z","avatar_url":"https://github.com/stagas.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1\u003e\ndokio \u003ca href=\"https://npmjs.org/package/dokio\"\u003e\u003cimg src=\"https://img.shields.io/badge/npm-v1.1.0-F00.svg?colorA=000\"/\u003e\u003c/a\u003e \u003ca href=\"src\"\u003e\u003cimg src=\"https://img.shields.io/badge/loc-724-FFF.svg?colorA=000\"/\u003e\u003c/a\u003e \u003ca href=\"LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-F0B.svg?colorA=000\"/\u003e\u003c/a\u003e\n\u003c/h1\u003e\n\n\u003cp\u003e\u003c/p\u003e\n\nDocumentation generator for TypeScript projects.\n\n\u003ch4\u003e\n\u003ctable\u003e\u003ctr\u003e\u003ctd title=\"Triple click to select and copy paste\"\u003e\n\u003ccode\u003enpm i dokio -g\u003c/code\u003e\n\u003c/td\u003e\u003ctd title=\"Triple click to select and copy paste\"\u003e\n\u003ccode\u003epnpm add dokio -g\u003c/code\u003e\n\u003c/td\u003e\u003ctd title=\"Triple click to select and copy paste\"\u003e\n\u003ccode\u003eyarn global add dokio\u003c/code\u003e\n\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\n\u003c/h4\u003e\n\n## CLI\n\n\u003cp\u003e\u003c/p\u003e\n\u003cp\u003e\n\u003cimg width=\"643.4285714285714\" src=\"cli.png\" /\u003e\n\u003c/p\u003e\n\n## API\n\n\u003cp\u003e  \u003cdetails id=\"api$1\" title=\"Namespace\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#api$1\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eapi\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/index.ts#L1\"\u003esrc/api/index.ts#L1\u003c/a\u003e  \u003cul\u003e        \u003cp\u003e  \u003cdetails id=\"ExitCodes$2\" title=\"Enum\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#ExitCodes$2\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eExitCodes\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/produce.ts#L3\"\u003esrc/api/produce.ts#L3\u003c/a\u003e  \u003cul\u003e        \u003cp\u003e  \u003cdetails id=\"CompileError$6\" title=\"EnumMember\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#CompileError$6\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eCompileError\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/produce.ts#L7\"\u003esrc/api/produce.ts#L7\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003ccode\u003e3\u003c/code\u003e\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"ExceptionThrown$9\" title=\"EnumMember\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#ExceptionThrown$9\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eExceptionThrown\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/produce.ts#L10\"\u003esrc/api/produce.ts#L10\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003ccode\u003e6\u003c/code\u003e\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"NoEntryPoints$5\" title=\"EnumMember\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#NoEntryPoints$5\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eNoEntryPoints\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/produce.ts#L6\"\u003esrc/api/produce.ts#L6\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003ccode\u003e2\u003c/code\u003e\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"Ok$3\" title=\"EnumMember\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#Ok$3\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eOk\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/produce.ts#L4\"\u003esrc/api/produce.ts#L4\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003ccode\u003e0\u003c/code\u003e\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"OptionError$4\" title=\"EnumMember\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#OptionError$4\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eOptionError\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/produce.ts#L5\"\u003esrc/api/produce.ts#L5\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003ccode\u003e1\u003c/code\u003e\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"OutputError$8\" title=\"EnumMember\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#OutputError$8\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eOutputError\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/produce.ts#L9\"\u003esrc/api/produce.ts#L9\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003ccode\u003e5\u003c/code\u003e\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"ValidationError$7\" title=\"EnumMember\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#ValidationError$7\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eValidationError\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/produce.ts#L8\"\u003esrc/api/produce.ts#L8\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003ccode\u003e4\u003c/code\u003e\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e\u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"produce$10\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#produce$10\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e()\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/produce.ts#L13\"\u003esrc/api/produce.ts#L13\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e      \u003cp\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003cem\u003e()\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003e\u003cspan\u003ePromise\u003c/span\u003e\u0026lt;\u003cspan\u003eProjectReflection\u003c/span\u003e | \u003ca href=\"#ExitCodes$2\"\u003eExitCodes\u003c/a\u003e\u0026gt;\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"render$12\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#render$12\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e(doc, { expand })\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/render.tsx#L299\"\u003esrc/api/render.tsx#L299\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e    \u003cdetails id=\"doc$14\" title=\"Parameter\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#doc$14\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003edoc\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e    \u003cul\u003e\u003cp\u003e\u003cspan\u003eProjectReflection\u003c/span\u003e\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e{\u003cp\u003e  \u003cdetails id=\"expand$17\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#expand$17\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eexpand\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/api/render.tsx#L299\"\u003esrc/api/render.tsx#L299\u003c/a\u003e  \u003cul\u003e\u003cp\u003eboolean\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}  \u003cp\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003cem\u003e(doc, { expand })\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003estring\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e\u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"bin$18\" title=\"Namespace\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#bin$18\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003ebin\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/bin/index.ts#L1\"\u003esrc/bin/index.ts#L1\u003c/a\u003e  \u003cul\u003e        \u003cp\u003e  \u003cdetails id=\"Bin$19\" title=\"TypeAlias\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#Bin$19\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eBin\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/bin/produce.ts#L5\"\u003esrc/bin/produce.ts#L5\u003c/a\u003e  \u003cul\u003e\u003cp\u003e{\u003cp\u003e  \u003cdetails id=\"name$21\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#name$21\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/bin/produce.ts#L6\"\u003esrc/bin/produce.ts#L6\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"screenshot$22\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#screenshot$22\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003escreenshot\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/bin/produce.ts#L7\"\u003esrc/bin/produce.ts#L7\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"screenshotDimensions$23\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#screenshotDimensions$23\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003escreenshotDimensions\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/bin/produce.ts#L8\"\u003esrc/bin/produce.ts#L8\u003c/a\u003e  \u003cul\u003e\u003cp\u003e{\u003cp\u003e  \u003cdetails id=\"height$26\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#height$26\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eheight\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/bin/produce.ts#L10\"\u003esrc/bin/produce.ts#L10\u003c/a\u003e  \u003cul\u003e\u003cp\u003enumber\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"width$25\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#width$25\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003ewidth\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/bin/produce.ts#L9\"\u003esrc/bin/produce.ts#L9\u003c/a\u003e  \u003cul\u003e\u003cp\u003enumber\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"produce$27\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#produce$27\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e()\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/bin/produce.ts#L14\"\u003esrc/bin/produce.ts#L14\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e      \u003cp\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003cem\u003e()\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003e\u003cspan\u003ePromise\u003c/span\u003e\u0026lt;\u003cspan\u003ePartial\u003c/span\u003e\u0026lt;\u003ca href=\"#Bin$19\"\u003eBin\u003c/a\u003e\u0026gt;\u0026gt;\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"render$29\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#render$29\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e(\u003ca href=\"#Bin$19\"\u003eBin\u003c/a\u003e)\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/bin/render.tsx#L5\"\u003esrc/bin/render.tsx#L5\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e    \u003ca href=\"#Bin$19\"\u003eBin\u003c/a\u003e  \u003cp\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003cem\u003e(\u003ca href=\"#Bin$19\"\u003eBin\u003c/a\u003e)\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003estring\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e\u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"examples$32\" title=\"Namespace\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#examples$32\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eexamples\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/index.ts#L1\"\u003esrc/examples/index.ts#L1\u003c/a\u003e  \u003cul\u003e        \u003cp\u003e  \u003cdetails id=\"ExampleFile$33\" title=\"TypeAlias\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#ExampleFile$33\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eExampleFile\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L9\"\u003esrc/examples/produce.ts#L9\u003c/a\u003e  \u003cul\u003e\u003cp\u003e{\u003cp\u003e  \u003cdetails id=\"contents$44\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#contents$44\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003econtents\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L19\"\u003esrc/examples/produce.ts#L19\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"fileName$36\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#fileName$36\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003efileName\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L11\"\u003esrc/examples/produce.ts#L11\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"lang$37\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#lang$37\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003elang\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L12\"\u003esrc/examples/produce.ts#L12\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"link$43\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#link$43\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003elink\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L18\"\u003esrc/examples/produce.ts#L18\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"name$35\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#name$35\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L10\"\u003esrc/examples/produce.ts#L10\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"screenshot$38\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#screenshot$38\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003escreenshot\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L13\"\u003esrc/examples/produce.ts#L13\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"screenshotDimensions$39\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#screenshotDimensions$39\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003escreenshotDimensions\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L14\"\u003esrc/examples/produce.ts#L14\u003c/a\u003e  \u003cul\u003e\u003cp\u003e{\u003cp\u003e  \u003cdetails id=\"height$42\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#height$42\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eheight\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L16\"\u003esrc/examples/produce.ts#L16\u003c/a\u003e  \u003cul\u003e\u003cp\u003enumber\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"width$41\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#width$41\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003ewidth\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L15\"\u003esrc/examples/produce.ts#L15\u003c/a\u003e  \u003cul\u003e\u003cp\u003enumber\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"produce$45\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#produce$45\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e()\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/produce.ts#L22\"\u003esrc/examples/produce.ts#L22\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e      \u003cp\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003cem\u003e()\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003e\u003cspan\u003ePromise\u003c/span\u003e\u0026lt;\u003ca href=\"#ExampleFile$33\"\u003eExampleFile\u003c/a\u003e  []\u0026gt;\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"render$47\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#render$47\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e(examples)\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/examples/render.tsx#L79\"\u003esrc/examples/render.tsx#L79\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e    \u003cdetails id=\"examples$49\" title=\"Parameter\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#examples$49\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eexamples\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e    \u003cul\u003e\u003cp\u003e\u003ca href=\"#ExampleFile$33\"\u003eExampleFile\u003c/a\u003e  []\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e  \u003cp\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003cem\u003e(examples)\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003estring\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e\u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"footer$50\" title=\"Namespace\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#footer$50\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003efooter\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/footer/index.ts#L1\"\u003esrc/footer/index.ts#L1\u003c/a\u003e  \u003cul\u003e        \u003cp\u003e  \u003cdetails id=\"Footer$51\" title=\"TypeAlias\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#Footer$51\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eFooter\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/footer/produce.ts#L5\"\u003esrc/footer/produce.ts#L5\u003c/a\u003e  \u003cul\u003e\u003cp\u003e{\u003cp\u003e  \u003cdetails id=\"deps$53\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#deps$53\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003edeps\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/footer/produce.ts#L6\"\u003esrc/footer/produce.ts#L6\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003cspan\u003enormalize.Package\u003c/span\u003e  []\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"pkg$54\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#pkg$54\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003epkg\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/footer/produce.ts#L7\"\u003esrc/footer/produce.ts#L7\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003cspan\u003enormalize.Package\u003c/span\u003e \u0026amp; {\u003cp\u003e  \u003cdetails id=\"short$56\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#short$56\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eshort\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/footer/produce.ts#L7\"\u003esrc/footer/produce.ts#L7\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"produce$57\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#produce$57\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e()\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/footer/produce.ts#L10\"\u003esrc/footer/produce.ts#L10\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e      \u003cp\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003cem\u003e()\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003e\u003cspan\u003ePromise\u003c/span\u003e\u0026lt;{\u003cp\u003e  \u003cdetails id=\"deps$60\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#deps$60\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003edeps\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/footer/produce.ts#L23\"\u003esrc/footer/produce.ts#L23\u003c/a\u003e  \u003cul\u003e\u003cp\u003eany  []\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"pkg$61\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#pkg$61\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003epkg\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/footer/produce.ts#L23\"\u003esrc/footer/produce.ts#L23\u003c/a\u003e  \u003cul\u003e\u003cp\u003eany\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}\u0026gt;\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"render$62\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#render$62\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e(\u003ca href=\"#Footer$51\"\u003eFooter\u003c/a\u003e)\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/footer/render.tsx#L18\"\u003esrc/footer/render.tsx#L18\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e    \u003ca href=\"#Footer$51\"\u003eFooter\u003c/a\u003e  \u003cp\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003cem\u003e(\u003ca href=\"#Footer$51\"\u003eFooter\u003c/a\u003e)\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003estring\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e\u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"header$65\" title=\"Namespace\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#header$65\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eheader\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/header/index.ts#L1\"\u003esrc/header/index.ts#L1\u003c/a\u003e  \u003cul\u003e        \u003cp\u003e  \u003cdetails id=\"Header$66\" title=\"TypeAlias\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#Header$66\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eHeader\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/header/produce.ts#L7\"\u003esrc/header/produce.ts#L7\u003c/a\u003e  \u003cul\u003e\u003cp\u003e{\u003cp\u003e  \u003cdetails id=\"brotli$68\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#brotli$68\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003ebrotli\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/header/produce.ts#L8\"\u003esrc/header/produce.ts#L8\u003c/a\u003e  \u003cul\u003e\u003cp\u003enumber\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"loc$70\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#loc$70\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eloc\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/header/produce.ts#L10\"\u003esrc/header/produce.ts#L10\u003c/a\u003e  \u003cul\u003e\u003cp\u003eany\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"pkg$69\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#pkg$69\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003epkg\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/header/produce.ts#L9\"\u003esrc/header/produce.ts#L9\u003c/a\u003e  \u003cul\u003e\u003cp\u003e\u003cspan\u003enormalize.Package\u003c/span\u003e\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"produce$71\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#produce$71\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e()\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/header/produce.ts#L13\"\u003esrc/header/produce.ts#L13\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e      \u003cp\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003cem\u003e()\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003e\u003cspan\u003ePromise\u003c/span\u003e\u0026lt;\u003ca href=\"#Header$66\"\u003eHeader\u003c/a\u003e\u0026gt;\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"render$73\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#render$73\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e(\u003ca href=\"#Header$66\"\u003eHeader\u003c/a\u003e)\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/header/render.tsx#L6\"\u003esrc/header/render.tsx#L6\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e    \u003ca href=\"#Header$66\"\u003eHeader\u003c/a\u003e  \u003cp\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003cem\u003e(\u003ca href=\"#Header$66\"\u003eHeader\u003c/a\u003e)\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003estring\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e\u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"intro$76\" title=\"Namespace\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#intro$76\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eintro\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/intro/index.ts#L1\"\u003esrc/intro/index.ts#L1\u003c/a\u003e  \u003cul\u003e        \u003cp\u003e  \u003cdetails id=\"Intro$77\" title=\"TypeAlias\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#Intro$77\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eIntro\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/intro/produce.ts#L4\"\u003esrc/intro/produce.ts#L4\u003c/a\u003e  \u003cul\u003e\u003cp\u003e{\u003cp\u003e  \u003cdetails id=\"intro$79\" title=\"Property\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#intro$79\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eintro\u003c/strong\u003e\u003c/code\u003e    \u003c/summary\u003e  \u003ca href=\"src/intro/produce.ts#L5\"\u003esrc/intro/produce.ts#L5\u003c/a\u003e  \u003cul\u003e\u003cp\u003estring\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e}\u003c/p\u003e        \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"produce$80\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#produce$80\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e()\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/intro/produce.ts#L8\"\u003esrc/intro/produce.ts#L8\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e      \u003cp\u003e\u003cstrong\u003eproduce\u003c/strong\u003e\u003cem\u003e()\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003e\u003cspan\u003ePromise\u003c/span\u003e\u0026lt;\u003ca href=\"#Intro$77\"\u003eIntro\u003c/a\u003e\u0026gt;\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003cdetails id=\"render$82\" title=\"Function\" \u003e\u003csummary\u003e\u003cspan\u003e\u003ca href=\"#render$82\"\u003e#\u003c/a\u003e\u003c/span\u003e  \u003ccode\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003c/code\u003e\u003cem\u003e(\u003ca href=\"#Intro$77\"\u003eIntro\u003c/a\u003e)\u003c/em\u003e    \u003c/summary\u003e  \u003ca href=\"src/intro/render.ts#L3\"\u003esrc/intro/render.ts#L3\u003c/a\u003e  \u003cul\u003e    \u003cp\u003e    \u003ca href=\"#Intro$77\"\u003eIntro\u003c/a\u003e  \u003cp\u003e\u003cstrong\u003erender\u003c/strong\u003e\u003cem\u003e(\u003ca href=\"#Intro$77\"\u003eIntro\u003c/a\u003e)\u003c/em\u003e  \u0026nbsp;=\u0026gt;  \u003cul\u003estring\u003c/ul\u003e\u003c/p\u003e\u003c/p\u003e    \u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e\u003c/ul\u003e\u003c/details\u003e\u003c/p\u003e\n\n## Credits\n\n- [brotli-size](https://npmjs.org/package/brotli-size) by [Erwin Mombay](https://github.com/erwinmombay) \u0026ndash; Get the brotli compressed size of a string or buffer\n- [decarg](https://npmjs.org/package/decarg) by [stagas](https://github.com/stagas) \u0026ndash; decorator based cli arguments parser\n- [get-video-width-height](https://npmjs.org/package/get-video-width-height) by [clearisoft](https://github.com/clearisoft) \u0026ndash; Get the width and height of a video\n- [html-jsx](https://npmjs.org/package/html-jsx) by [stagas](https://github.com/stagas) \u0026ndash; Extensible jsx type definitions for standard html interfaces.\n- [image-size](https://npmjs.org/package/image-size) by [netroy](http://netroy.in/) \u0026ndash; get dimensions of any image file\n- [markdown-it](https://npmjs.org/package/markdown-it) by [markdown-it](https://github.com/markdown-it) \u0026ndash; Markdown-it - modern pluggable markdown parser.\n- [normalize-package-data](https://npmjs.org/package/normalize-package-data) by [GitHub Inc.](https://github.com/npm) \u0026ndash; Normalizes data that can be found in package.json files.\n- [typedoc](https://npmjs.org/package/typedoc) by [TypeStrong](https://github.com/TypeStrong) \u0026ndash; Create api documentation for TypeScript projects.\n\n## Contributing\n\n[Fork](https://github.com/stagas/dokio/fork) or [edit](https://github.dev/stagas/dokio) and submit a PR.\n\nAll contributions are welcome!\n\n## License\n\n\u003ca href=\"LICENSE\"\u003eMIT\u003c/a\u003e \u0026copy; 2022 [stagas](https://github.com/stagas)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstagas%2Fdokio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstagas%2Fdokio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstagas%2Fdokio/lists"}