Home

Awesome

<p align="center"> <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> <p align="center"> ๐ŸŒ’ A material dark theme for TypeDoc <br> <br> <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> </p> </p> <p align="center"> <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> </p>

Table of Contents

๐Ÿ“œ About

eledoc is a delightful dark theme for TypeDoc

Goals

๐Ÿฉ Features

<p align="center"> <img src="https://raw.githubusercontent.com/pirix-gh/eledoc/master/.github/demo.gif" id="demo"> <p align="center">

๐Ÿ 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

  1. Read the tutorial
  2. Fork the project
  3. Clone your fork
  4. Create a pr/feature branch
    git checkout -b pr/CoolFeature
    
  5. Commit your changes
    git commit -m 'Added this CoolFeature'
    
  6. Run the tests
  7. Commit your changes
    git push origin pr/CoolFeature
    
  8. Open a pull request

๐Ÿ‘ Sponsoring issues

Sponsored issues have higher priority over non-critical issues.<br>

You can either request a new feature or a bug fix then fund it.

<a href="https://issuehunt.io/r/pirix-gh/eledoc"> <img src="https://raw.githubusercontent.com/pirix-gh/eledoc/master/.github/issuehunt-logo.svg?sanitize=true"> </a> <br> <br>

The money will be transparently split with an issue's assignees.

๐Ÿ”ฎ What's next

๐Ÿ™ Acknowledgements

Many, many thanks to all the contributors

๐Ÿ’Ÿ Friendly Projects