commit | 6692d5b13237e13c8a5b5007e4581a4fe8fd8e58 | [log] [tgz] |
---|---|---|
author | Raphael von der Grün <raphinesse@gmail.com> | Tue May 22 00:54:23 2018 +0200 |
committer | Shazron Abdullah <shazron@gmail.com> | Tue May 22 06:54:23 2018 +0800 |
tree | 6fa4d8ac8f357a793b302e18b8038c4b7c3a57be | |
parent | ce664924450456a6b83950cc543f05f9e90f700c [diff] |
Fix indentation (#1)
This is a reference for building and publishing Cordova Templates.
template_package ├── package.json (for your template package to be published on npm) ├── index.js └── template_src (contains template files) ├── package.json ├── config.xml └── (files and folders that make up the template)
template_src
All files outside of template_src
are used to define parameters about the template. These files are not copied over at creation, so feel free to add a README or any other files outside of template_src.
index.js
points to where the template exists. You'll see that index.js usually looks like:
var path = require('path'); module.exports = { dirname : path.join(__dirname, 'template_src') };
This package.json
holds information about the template itself like its name, version etc. All templates should contain the keyword "cordova:template"
so that the template is searchable on npm. For example:
{ "name": "cordova-example-template", "version": "1.0.0", "...": "...", "keywords": [ "cordova:template" ] }
template_src
All files inside of template_src
compose the template from which a user would desire in order to create their project. Everything in this folder is copied over to the created project.
The package.json in template_src
should be filled with information that describes the project that would be created from the template.