Skip to content

Basic Folder Structure

YizYah edited this page Mar 2, 2021 · 4 revisions

folder

A template is a directory with certain expected files and folders. You can add as many other files as you like.

If you are following the steps for creating templates, you should have defined $TEMPLATE as a variable for a directory.

Those are the essential ingredients to a template:

  1. standard contains a directory that forms the basis for any code base directory that will be created from your code. The standard files and folders will always be there. Every file is a handlebars file, and should contain an .hbs extension.
  2. See partials for an understanding of the partials directory.
  3. See helpers for an understanding of the helpers directory.
  4. The static directory contains any handlebars files used for generating static files.
  5. A generic.hbs handlebars file is the basis for any dynamic files generated. (NOTE: a dynamic folder is planned, thereby allowing to have multiple dynamic file templates. At present, you can use partials and conditionals to generate what you need.)
  6. The sample.ns.yml should contain an ns file that will be the initial one received by users of your template. It should ideally show what your template can do.
  7. The README.md file describes the template.
  8. The config file config.yml file tells about the various configurations.