{"id":15579735,"url":"https://github.com/millsp/eledoc","last_synced_at":"2025-04-24T01:40:33.875Z","repository":{"id":57222057,"uuid":"190810012","full_name":"millsp/eledoc","owner":"millsp","description":"🌒 A material dark theme for TypeDoc ","archived":false,"fork":false,"pushed_at":"2019-11-10T19:53:22.000Z","size":24381,"stargazers_count":44,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-09T05:33:55.018Z","etag":null,"topics":["theme","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/millsp.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":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2019-06-07T21:19:10.000Z","updated_at":"2024-08-01T04:53:59.000Z","dependencies_parsed_at":"2022-08-29T04:10:17.289Z","dependency_job_id":null,"html_url":"https://github.com/millsp/eledoc","commit_stats":null,"previous_names":["pirix-gh/eledoc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/millsp%2Feledoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/millsp%2Feledoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/millsp%2Feledoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/millsp%2Feledoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/millsp","download_url":"https://codeload.github.com/millsp/eledoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250545472,"owners_count":21448213,"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":["theme","typedoc","typescript"],"created_at":"2024-10-02T19:20:53.602Z","updated_at":"2025-04-24T01:40:33.816Z","avatar_url":"https://github.com/millsp.png","language":"JavaScript","funding_links":["https://issuehunt.io/r/pirix-gh/eledoc"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/pirix-gh/eledoc\"\u003e\n    \u003cimg alt=\"logo\" title=\"eledoc\" src=\"https://raw.githubusercontent.com/pirix-gh/eledoc/master/.github/logo.png\" width=\"300\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eeledoc\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    🌒 A material dark theme for TypeDoc\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003ca href=\"#demo\"\u003e🎮 View Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/pirix-gh/eledoc/issues/new?template=---bug-report.md\"\u003e🐞 Report Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/pirix-gh/eledoc/issues/new?template=---feature-request.md\"\u003e🍩 Request Feature\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/pirix-gh/eledoc/issues/new?template=---question.md\"\u003e🤔  Ask Questions\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://gitter.im/eledoc-/community?utm_source=share-link\u0026utm_medium=link\u0026utm_campaign=share-link\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/gitter/room/eledoc-/community.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/eledoc\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/eledoc.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"#\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/eledoc.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"http://makeapullrequest.com\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/PRs-welcome-brightgreen.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"#\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/l/eledoc.svg\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Table of Contents\n\n* [📜 About](#-about)\n* [🍩 Features](#-features)\n* [🏁 Getting started](#-getting-started)\n* [🧠 Good to know](#-good-to-know-)\n* [🎁 Contributing](#-contributing)\n* [👏 Sponsoring issues](#-sponsoring-issues)\n* [🔮 What's next](#-whats-next)\n* [🙏 Acknowledgements](#-acknowledgements)\n\n## 📜 About\n\n**eledoc** is a delightful dark theme for TypeDoc\n\n#### Goals\n\n* Provide a nice user experience\n* Proper layout with visual cues\n* Fix problems from usual themes\n\n## 🍩 Features\n\n* All the features from the default typedoc themes\n* Create sections with `@[tag-name]` in doc comments\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/pirix-gh/eledoc/master/.github/demo.gif\" id=\"demo\"\u003e\n\u003cp align=\"center\"\u003e\n\n## 🏁 Getting Started\n\n#### Prerequisites\n\n```sh\nnpm install typedoc --save-dev\n```\n\n#### Installation\n\n```sh\nnpm install eledoc --save-dev\n```\n\n#### Hello World\n\nWith the command line\n\n```sh\nnpx typedoc --out docs src --theme node_modules/eledoc/bin/default/\n```\n\nOr in your `package.json`\n\n```ts\n\"scripts\": {\n  \"build:docs\": \"typedoc --out docs src --theme node_modules/eledoc/bin/default/\",\n}\n```\n\n## [🧠 Good to Know ⤢](https://github.com/pirix-gh/eledoc/issues?q=label%3Aquestion+sort%3Areactions-%2B1-desc)\n\nIn this wiki, you'll find some extra resources for your learning \u0026 understanding.\n\nIt is incremental and it will be completed on demand, you can ask for this below.\n\n#### [Questions ⤢](https://github.com/pirix-gh/eledoc/issues?q=label%3Aquestion+sort%3Areactions-%2B1-desc)\n\nAre you missing something? Participate to the open-wiki by posting your\nquestions [right here](https://github.com/pirix-gh/eledoc/issues/new?template=---question.md).\n\n## 🎁 Contributing\n\nContributions are what make the open source community such an amazing place to\nlearn, inspire, and create. Any contributions you make are **greatly appreciated**.\nThere are many ways to contribute to the project:\n\n#### Community\n* [Help the community with answers on Gitter](https://gitter.im/eledoc-/community?utm_source=share-link\u0026utm_medium=link\u0026utm_campaign=share-link)\n* [Reporting bugs or requesting new features](https://github.com/pirix-gh/eledoc/issues/new/choose)\n\n#### Pull Requests\n1. [Read the tutorial](https://medium.com/free-code-camp/typescript-curry-ramda-types-f747e99744ab)\n2. Fork the project\n3. Clone your fork\n4. Create a pr/**feature** branch\n   ```sh\n   git checkout -b pr/CoolFeature\n   ```\n5. Commit your changes\n   ```sh\n   git commit -m 'Added this CoolFeature'\n   ```\n6. [Run the tests](#-running-tests)\n7. Commit your changes\n   ```sh\n   git push origin pr/CoolFeature\n   ```\n8. Open a pull request\n\n## 👏 Sponsoring issues\n\n**Sponsored issues have higher priority over non-critical issues**.\u003cbr\u003e\n\nYou can either request a new feature or a bug fix then fund it.\n\n\u003ca href=\"https://issuehunt.io/r/pirix-gh/eledoc\"\u003e\n  \u003cimg\n  src=\"https://raw.githubusercontent.com/pirix-gh/eledoc/master/.github/issuehunt-logo.svg?sanitize=true\"\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003cbr\u003e\n\n**The money will be transparently split with an issue's assignees.**\n\n## 🔮 What's next\n\n* Re-write with React\n\n## 🙏 Acknowledgements\n\nMany, many thanks to all the\n[contributors](https://github.com/pirix-gh/eledoc/graphs/contributors)\n\n## 💟 Friendly Projects\n* [`ts-toolbelt`](https://github.com/pirix-gh/ts-toolbelt) - 👷 Higher type safety for TypeScript\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmillsp%2Feledoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmillsp%2Feledoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmillsp%2Feledoc/lists"}