Github as a source and documentation repository

Putting your Plugin on Github

Your plugins are submitted to the Plugins Library to make them accessible to Zen Cart users, but you may wish to consider taking an additional steps, and put your plugin under source control on

There are a number of advantages to doing this:

  • Other developers can help you by submitting PRs and fixes.
  • You can use your Github repo as evidence for your skills when talking to hiring managers and clients.
  • Github provides a per-repo Wiki that can be used for the creation of documentation. Creating your documentation this way means it’s easily sharable among collaborators and users.

Examples of best-in-class Github repos that feature documentation are:

Clicking the “Wiki” link at the top of any of these repos will show you examples of plugin documentation.

Still have questions? Use the Search box in the upper right, or try the full list of FAQs. If you can't find it there, head over to the Zen Cart support forum and ask there in the appropriate subforum. In your post, please include your Zen Cart and PHP versions, and a link to your site.

Is there an error or omission on this page? Please post to General Questions on the support forum. Or, if you'd like to open a pull request, just review the guidelines and get started. You can even PR right here.
Last modified May 22, 2024 by Scott Wilson (3203178).