DEV Community

loading...
Cover image for ๐Ÿถ ModdoC: A new way to read Documentation of Node Modules
XenoX

๐Ÿถ ModdoC: A new way to read Documentation of Node Modules

sarthology profile image Sarthak Sharma ใƒป1 min read

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.

GitHub logo 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




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.

Discussion (9)

pic
Editor guide
Collapse
mahmoudafer profile image
mahmoudafer

Loved it! Keep up the good work, would love to see this in release versions

Collapse
sarthology profile image
Collapse
jeromedeleon profile image
Jerome De Leon • Edited

Not available for windows?

Collapse
sarthology profile image
Collapse
jeromedeleon profile image
Jerome De Leon

Can't download it.
The link for windows keep scrolling to the top.

Collapse
sarthology profile image
sarthology profile image
Sarthak Sharma Author

Yeah no problem ๐Ÿ˜Š