๐ A material dark theme for TypeDoc
๐ฎ View Demo
ยท
๐ Report Bug
ยท
๐ฉ Request Feature
ยท
๐ค Ask Questions
## ๐ 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