A chrome extension to add documentation of modules into github source code, to increase comprehensibility.
Currently Supported languages
- JavaScript 'require' and 'import' syntax.
- I'd like to get more languages supported, pull requests welcome!
If you would like to contribute to this repository, below is an overview of this projects dev environment.
Download this repo
git clone https://www.github.com/rlindskog/modoc
Install NPM packages
npm install
Run in development
npm run dev
Build for production
npm run build
View in Chrome
- Open chrome://extensions/ in chrome.
- Check the 'developer mode' check box.
- Click 'Load unpacked extension'
- Open up a github page and test!