terr / devdocs-electron

A macOS app built using Electron for the DevDocs API Documentation Browser website.

devdocs-electron

devdocs-electron is a macOS app built using Electron for the DevDocs API Documentation Browser website. It doesn't do much more than wrap the DevDocs website, but frankly, that's the point.

• Download the latest release
• Report an Issue

Installation Notes

1. Download the latest release (either .zip or .dmg will do).
2. Unzip the .zip file or mount the .dmg downloaded file.
3. Drag the DevDocs app to /Applications.
4. Open up /Applications, right-click on the DevDos app, and click "Open."
5. Accept the prompt and you're good to go!

The prompt is a side effect of devdocs-electron not being a "signed" macOS app. Signing apps requires an expensive Apple Developer account.

Contributing

If you'd like to help improve devdocs-electron, give a look through this project's CONTRIBUTING.md.

Acknowledgments

devdocs-electron wouldn't be possible without the hard work of Thibaut Courouble and DevDocs' many contributors. It is not an official DevDocs project and is neither affiliated with nor endorsed by the DevDocs team.

Interface icons and styling provided by Photon. Application icon was created using DevDocs Fluid Icon.

devdocs-electron is written and maintained by Jason Garber.

License

devdocs-electron is freely available under the MIT License. Use it, learn from it, fork it, improve it, change it, tailor it to your needs.