We all use node modules in our projects, and we have to read their documentation over and over. But going on npm org and searching for a node module to read its documentation can waste a lot of time. So that's why we made MODDOC. It's a simple tool to read the node module's documentation easily.

Some Features

1. Open multiple projects at a time

2. Shows both dependencies and dev dependencies

3. Quick copy widget

4. In-app browser for external links

5. Offline access to Documentation

It's just a start, and with your help we can add more features to it and make it more awesome. The best part is that this tool is completely Open Source. So feel free to have a look, suggest features, find bugs or fix them.

sarthology / moddoc

🐶 Easy access to npm package's Documentation

Moddoc

🐶 Best way to see the Documentation of Node Modules in your Project.

Prerequisites

Before running this locally you must have these installed

• Node
• Electron

Installing

It's built in electron so the process to start this is really easy

1. npm install
2. npm install electron -g
3. npm run electron-tsc

That's it.

Features

1. Open multiple projects at a time

2. Shows both dependencies and dev dependencies

3. Quick copy widget

4. In-app browser for external links

5. Offline access to Documentation

Contributing

Feel free to contribute to this project and treat it like your own. 😊

License

MIT License

Author

Sarthak Sharma

Acknowledgments

Icons used from flaticon

View on GitHub

This is a beta release, so I thought this is the best place to discuss it. I hope you will like it. See you next time.