Skip to main content

Sharing Your Own Template

A template is a folder, so sharing it means giving someone a way to get that folder. This page shows how to make one that installs cleanly from a link. Every example in these docs is built that way, and each has a link you can look at.

  1. Give it an id and a version in codebaker.config.json5.
  2. Zip the template folder's contents, or push the folder to a Git repository.
  3. Leave out the .history folder. It sits next to your template files and holds your own run history and the values you typed. The plugin's own packaging of its sample templates skips it, but a plain zip or a Git commit does not, so exclude it when you zip, and add .history to your .gitignore before publishing.
  4. Share the .zip link, or the GitHub link of the folder or tag.

What a good template looks like​

  • An id in the config. The installer names the folder after it. Without one it falls back to the name, then to the file name of the archive, and tells the user it had to guess.
  • The files at the root of the zip (a single wrapping folder, as GitHub makes, is fine too), with codebaker.config.json5 in the shallowest folder. See About the archive.
  • A link to a tag (.../tree/v1.2.0) when users should get an exact, unchanging version, and a version in the config so the user sees what they have.
  • Only public files. A link that needs a sign-in cannot be installed.

Look at the Download the template (.zip) link above any example in these docs, for instance on Your First Template: that zip is exactly this, and Install in IDE next to it installs it.

Next​