Table of Contents
- 📜 About
- 🍩 Features
- 🏁 Getting started
- 🧠 Good to know
- 🎁 Contributing
- 👏 Sponsoring issues
- 🔮 What's next
- 🙏 Acknowledgements
eledoc is a delightful dark theme for TypeDoc
- Provide a nice user experience
- Proper layout with visual cues
- Fix problems from usual themes
- All the features from the default typedoc themes
- Create sections with
@[tag-name]in doc comments
🏁 Getting Started
npm install typedoc --save-dev
npm install eledoc --save-dev
With the command line
npx typedoc --out docs src --theme node_modules/eledoc/bin/default/
Or in your
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.
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:
- Read the tutorial
- Fork the project
- Clone your fork
- Create a pr/feature branchgit checkout -b pr/CoolFeature
- Commit your changesgit commit -m 'Added this CoolFeature'
- Run the tests
- Commit your changesgit 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
Many, many thanks to all the contributors
💟 Friendly Projects
ts-toolbelt- 👷 Higher type safety for TypeScript