https://github.com/millsp/eledoc
🌒 A material dark theme for TypeDoc
https://github.com/millsp/eledoc
theme typedoc typescript
Last synced: about 1 year ago
JSON representation
🌒 A material dark theme for TypeDoc
- Host: GitHub
- URL: https://github.com/millsp/eledoc
- Owner: millsp
- License: apache-2.0
- Created: 2019-06-07T21:19:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-10T19:53:22.000Z (over 6 years ago)
- Last Synced: 2025-04-09T05:33:55.018Z (about 1 year ago)
- Topics: theme, typedoc, typescript
- Language: JavaScript
- Homepage:
- Size: 23.3 MB
- Stars: 44
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
eledoc
🌒 A material dark theme for TypeDoc
🎮 View Demo
·
🐞 Report Bug
·
🍩 Request Feature
·
🤔 Ask Questions
## Table of Contents
* [📜 About](#-about)
* [🍩 Features](#-features)
* [🏁 Getting started](#-getting-started)
* [🧠 Good to know](#-good-to-know-)
* [🎁 Contributing](#-contributing)
* [👏 Sponsoring issues](#-sponsoring-issues)
* [🔮 What's next](#-whats-next)
* [🙏 Acknowledgements](#-acknowledgements)
## 📜 About
**eledoc** is a delightful dark theme for TypeDoc
#### Goals
* Provide a nice user experience
* Proper layout with visual cues
* Fix problems from usual themes
## 🍩 Features
* All the features from the default typedoc themes
* Create sections with `@[tag-name]` in doc comments
## 🏁 Getting Started
#### Prerequisites
```sh
npm install typedoc --save-dev
```
#### Installation
```sh
npm install eledoc --save-dev
```
#### Hello World
With the command line
```sh
npx typedoc --out docs src --theme node_modules/eledoc/bin/default/
```
Or in your `package.json`
```ts
"scripts": {
"build:docs": "typedoc --out docs src --theme node_modules/eledoc/bin/default/",
}
```
## [🧠 Good to Know ⤢](https://github.com/pirix-gh/eledoc/issues?q=label%3Aquestion+sort%3Areactions-%2B1-desc)
In this wiki, you'll find some extra resources for your learning & understanding.
It is incremental and it will be completed on demand, you can ask for this below.
#### [Questions ⤢](https://github.com/pirix-gh/eledoc/issues?q=label%3Aquestion+sort%3Areactions-%2B1-desc)
Are you missing something? Participate to the open-wiki by posting your
questions [right here](https://github.com/pirix-gh/eledoc/issues/new?template=---question.md).
## 🎁 Contributing
Contributions are what make the open source community such an amazing place to
learn, inspire, and create. Any contributions you make are **greatly appreciated**.
There are many ways to contribute to the project:
#### Community
* [Help the community with answers on Gitter](https://gitter.im/eledoc-/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
* [Reporting bugs or requesting new features](https://github.com/pirix-gh/eledoc/issues/new/choose)
#### Pull Requests
1. [Read the tutorial](https://medium.com/free-code-camp/typescript-curry-ramda-types-f747e99744ab)
2. Fork the project
3. Clone your fork
4. Create a pr/**feature** branch
```sh
git checkout -b pr/CoolFeature
```
5. Commit your changes
```sh
git commit -m 'Added this CoolFeature'
```
6. [Run the tests](#-running-tests)
7. Commit your changes
```sh
git push origin pr/CoolFeature
```
8. Open a pull request
## 👏 Sponsoring issues
**Sponsored issues have higher priority over non-critical issues**.
You can either request a new feature or a bug fix then fund it.
**The money will be transparently split with an issue's assignees.**
## 🔮 What's next
* Re-write with React
## 🙏 Acknowledgements
Many, many thanks to all the
[contributors](https://github.com/pirix-gh/eledoc/graphs/contributors)
## 💟 Friendly Projects
* [`ts-toolbelt`](https://github.com/pirix-gh/ts-toolbelt) - 👷 Higher type safety for TypeScript