Skip to content

sarthology/moddoc

Repository files navigation

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