eledoc
๐ A material dark theme for TypeDoc
Explore the docs ยป
๐ฎ View Demo
ยท
๐ Report Bug
ยท
๐ฉ Request Feature
ยท
๐ค Ask Questions
Table of Contents
๐ 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
๐ Getting Started
Installation
npm install eledoc --save
Hello World
npx typedoc --out docs src --theme node_modules/eledoc/bin/default/
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.
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:
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
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
๐ Acknowledgements
Many, many thanks to all the
contributors
๐ Friendly Projects