{"id":19009129,"url":"https://github.com/gamtiq/typedoc-light-theme","last_synced_at":"2025-04-22T22:46:27.487Z","repository":{"id":51495312,"uuid":"267941215","full_name":"gamtiq/typedoc-light-theme","owner":"gamtiq","description":"TypeDoc theme that adds some useful options (header links, custom style and script, ability to create files etc)","archived":false,"fork":false,"pushed_at":"2021-05-11T16:00:25.000Z","size":115,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-17T14:37:06.002Z","etag":null,"topics":["create","custom","customization","customize","documentation","extend","file","generator","plugin","script","style","theme","tool","typedoc","typedoc-theme","typescript"],"latest_commit_sha":null,"homepage":null,"language":"Handlebars","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/gamtiq.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}},"created_at":"2020-05-29T19:43:01.000Z","updated_at":"2024-05-28T22:30:06.000Z","dependencies_parsed_at":"2022-09-26T16:50:30.378Z","dependency_job_id":null,"html_url":"https://github.com/gamtiq/typedoc-light-theme","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamtiq%2Ftypedoc-light-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamtiq%2Ftypedoc-light-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamtiq%2Ftypedoc-light-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gamtiq%2Ftypedoc-light-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gamtiq","download_url":"https://codeload.github.com/gamtiq/typedoc-light-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250337910,"owners_count":21414102,"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":["create","custom","customization","customize","documentation","extend","file","generator","plugin","script","style","theme","tool","typedoc","typedoc-theme","typescript"],"created_at":"2024-11-08T19:06:44.550Z","updated_at":"2025-04-22T22:46:27.468Z","avatar_url":"https://github.com/gamtiq.png","language":"Handlebars","funding_links":[],"categories":[],"sub_categories":[],"readme":"# typedoc-light-theme \u003ca name=\"start\"\u003e\u003c/a\u003e\n\n[TypeDoc](https://typedoc.org/) theme that extends [default theme](https://typedoc.org/guides/themes/) and adds some useful options so that:\n* to include extra links in header;\n* to specify markup that is placed before project name;\n* to customize project name;\n* to change toolbar background;\n* to show \"Go top\" link;\n* to add custom CSS and JS;\n* to create some files in documentation directory;\n* and others.\n\n[Demo](https://gamtiq.github.io/wrapme/)\n\n## Usage \u003ca name=\"usage\"\u003e\u003c/a\u003e [\u0026#x2191;](#start)\n\nInstallation:\n\n    npm install typedoc-light-theme --save-dev\n\nTo apply the theme instead of the default theme add `--theme` option with path to the theme files for `typedoc` command. For example:\n\n    typedoc --out docs --readme README.md --theme ./node_modules/typedoc-light-theme/src ./src\n\nBy default the generated documentation does not differ much from the one of the default theme.\nBut you can use [TypeDoc options file](https://typedoc.org/guides/options/#options-1) to set necessary parameters in order to customize the generated documentation.\n\n    typedoc --options typedoc-conf.js --out docs --readme README.md --theme ./node_modules/typedoc-light-theme/src ./src\n\nFor example:\n```js\n// typedoc-conf.js\nmodule.exports = {\n    \"projectName\": {\n        \"link\": true,\n        \"style\": \"color: #c0f0d0;\",\n        \"beforeLinks\": \"\u0026emsp;|\u0026emsp;\"\n    },\n    \"links\": [\n        {\n            \"text\": \"GitHub repo\",\n            \"href\": \"https://github.com/gamtiq/wrapme\",\n            \"normal\": true\n            \"style\": \"font-size: 12px; color: #cdc;\",\n            \"target\": \"_top\",\n            \"id\": \"github_link\"\n        },\n    ],\n    \"style\": \".tsd-page-toolbar .header__link { color: #dd0fcc; }\",\n    \"toolbarBackground\": \"rgba(255, 197, 197, 0.5)\",\n    \"showGoTop\": 300,\n    \"createFile\": \".nojekyll\"\n};\n```\n\nAll supported options are optional and described below.\n\n#### `createFile: object | string`\n\nA file or set of files that should be created inside output directory after documentation is generated.\nYou can specify content for each file.\nSee description of first argument of [`makef.createFile`](https://github.com/gamtiq/makef#api--) for details.\n\nExample:\n```json\n\"createFile\": {\n    \".nojekyll\": \"\",\n    \"version.dat\": 237\n}\n```\n\n#### `headerStart: string`\n\nAny HTML that should be placed before project name in the header.\n\nExample:\n```json\n\"headerStart\": \"\u003cb\u003e\u0026gt;\u003c/b\u003e \"\n```\n\n#### `links: array`\n\nDescribes a set of links that should be added into the header.\nEach link should be described by object with the following fields (the only required field is `href`):\n* `class: string` - value for `class` attribute of the link; default value is `title header__link`.\n* `href: string` - value for `href` attribute.\n* `id: string` - value for `id` attribute.\n* `normal: boolean` - when set to `true`, `header__link_normal` will be added into value for `class` attribute\n    to show the link with normal font weight; default value is `false` which means that the link will be rendered\n    with bold font.\n* `style: string` - value for `style` attribute.\n* `target: string` - value for `target` attribute; default value is `_blank`.\n* `text: string` - any HTML that should be used as content of the link; by default value of `href` is used.\n\nExample:\n```json\n\"links\": [\n    {\n        \"text\": \"GitHub\",\n        \"href\": \"https://github.com/gamtiq/mixing\"\n    },\n    {\n        \"text\": \"npm\",\n        \"href\": \"https://www.npmjs.com/package/mixing\",\n        \"normal\": true\n    }\n]\n```\n\n#### `linkDivider: string`\n\nAny HTML that should be used to separate links specified by `links` option.\nDefault value is `\u0026emsp;`.\n\nExample:\n```json\n\"linkDivider\": \" | \"\n```\n\n#### `projectName: object | false`\n\nSpecifies whether and how project name should be rendered in the header.\nDefault value is `{ link: true, beforeLinks: '\u0026emsp;' }`.\nUse `false` to remove project name link from the header.\nTo customize project name element you can specify object with the following fields\n(all are optional so it is possible to use an empty object as option's value):\n* `after: string` - any HTML that should be placed after project name.\n* `before: string` - any HTML that should be placed before project name.\n* `beforeLinks: string` - any HTML that should be rendered after `after` but before links when they are specified by `links` option.\n* `class: string` - value for `class` attribute of the element that is used to display project name; default value is `title header__project`.\n* `href: string` - value for `href` attribute of the project link when `link` field is set to `true`; by default relative URL for `index.html` is used.\n* `link: boolean` - when set to `true`, `\u003ca\u003e` tag will be used as the element to display project name, otherwise `\u003cspan\u003e` will be used.\n* `name: string` - text that should be used instead of project name.\n* `style: string` - value for `style` attribute of the element that is used to display project name.\n\nExample:\n```json\n\"projectName\": {\n    \"link\": true,\n    \"before\": \"\u003cspan class=\\\"title\\\"\u003e\u0026star; \u003c/span\u003e\",\n    \"after\": \"\u003cspan class=\\\"title\\\"\u003e \u0026star;\u003c/span\u003e\"\n}\n```\n\n#### `script: string`\n\nAny JS that should be inlined into documentation pages.\nCan be used to customize behavior.\n\nExample:\n```json\n\"script\": \"console.log('message from light theme');\"\n```\n\n#### `showGoTop: number`\n\nWhether \"Go top\" link should be added in documentation pages.\nSet to `0` to exclude links.\nAny positive value specifies percentage of viewport height that should be scrolled before \"Go top\" link will be displayed.\nDefault value is `80`.\n\nExample:\n```json\n\"showGoTop\": 300\n```\n\n#### `style: string`\n\nAny CSS that should be inlined into documentation pages.\nCan be used to redefine and/or add some styles.\n\nExample:\n```json\n\"style\": \"body { font-size: 12px; } .tsd-page-toolbar .header__project { color: #00c; font-size: 1.2rem; }\"\n```\n\n#### `toolbarBackground: string`\n\nBackground style for the header.\n\nExample:\n```json\n\"toolbarBackground\": \"linear-gradient(#def, #fff)\"\n```\n\n## Related projects \u003ca name=\"related\"\u003e\u003c/a\u003e [\u0026#x2191;](#start)\n\n* [jsdoc-file](https://github.com/gamtiq/jsdoc-file) - JSDoc plugin to create files inside directory of generated documentation (e.g. `.nojekyll` etc).\n* [makef](https://github.com/gamtiq/makef) - a utility to create files inside specified directory.\n\n## License \u003ca name=\"license\"\u003e\u003c/a\u003e [\u0026#x2191;](#start)\nCopyright (c) 2020 Denis Sikuler  \nLicensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgamtiq%2Ftypedoc-light-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgamtiq%2Ftypedoc-light-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgamtiq%2Ftypedoc-light-theme/lists"}