eledoc

🌒 A material dark theme for TypeDoc

🎮 View Demo · 🐞 Report Bug · 🍩 Request Feature · 🤔 Ask Questions

Table of Contents

• 📜 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

• Help the community with answers on Gitter
• Reporting bugs or requesting new features

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.

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