Awesome

<a href="https://github.com/pirix-gh/eledoc"> <img alt="logo" title="eledoc" src="https://raw.githubusercontent.com/pirix-gh/eledoc/master/.github/logo.png" width="300"> </a> <h3 align="center">eledoc</h3> 🌒 A material dark theme for TypeDoc <a href="#demo">🎮 View Demo</a> · <a href="https://github.com/pirix-gh/eledoc/issues/new?template=---bug-report.md">🐞 Report Bug</a> · <a href="https://github.com/pirix-gh/eledoc/issues/new?template=---feature-request.md">🍩 Request Feature</a> · <a href="https://github.com/pirix-gh/eledoc/issues/new?template=---question.md">🤔 Ask Questions</a> <a href="https://gitter.im/eledoc-/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link" target="_blank"> <img src="https://img.shields.io/gitter/room/eledoc-/community.svg"> </a> <a href="https://www.npmjs.com/package/eledoc" target="_blank"> <img src="https://img.shields.io/npm/v/eledoc.svg"> </a> <a href="#"> <img src="https://img.shields.io/npm/dm/eledoc.svg"> </a> <a href="http://makeapullrequest.com" target="_blank"> <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg"> </a> <a href="#"> <img src="https://img.shields.io/npm/l/eledoc.svg"> </a>

📜 About
🍩 Features
🏁 Getting started
🧠 Good to know
🎁 Contributing
👏 Sponsoring issues
🔮 What's next
🙏 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

npm install typedoc --save-dev

Installation

npm install eledoc --save-dev

Hello World

With the command line

npx typedoc --out docs src --theme node_modules/eledoc/bin/default/

Or in your package.json

"scripts": {
  "build:docs": "typedoc --out docs src --theme node_modules/eledoc/bin/default/",
}

🧠 Good to Know ⤢

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 ⤢

Are you missing something? Participate to the open-wiki by posting your questions right here.

🎁 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

Pull Requests

Read the tutorial
Fork the project
Clone your fork
Create a pr/feature branch
```
git checkout -b pr/CoolFeature
```
Commit your changes
```
git commit -m 'Added this CoolFeature'
```
Run the tests
Commit your changes
```
git push origin pr/CoolFeature
```
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

💟 Friendly Projects

ts-toolbelt - 👷 Higher type safety for TypeScript