Skip to content

1. Configuration File

Peter Naydenov edited this page Jan 25, 2015 · 4 revisions

Framework Fields

Required fields in configuration file are not so much. Here is an example:

{
    "engine"       : "layered_themes_3devices"
  , "resolution"   : { 
	  		             "mobile" : "500" 
	  			       , "hq"     : "1000" 
	  		      }
  , "themes"      :  { 
	  		              "default" : "desk"
	  			       ,  "tablet"  : "mini"
	  			       ,  "mobile"  : "mini"
	  		      }
  , "mainKey"     : "general"
}
  • engine (required): Provides access to plugin engine or your custom engine file. Could be npm package name or link to your custom 'Layered themes' engine script.
  • resolution (required): Media query(MQ) delimiters. It's used by 'save matrix' to define MQ in result files.
  • themes (required): Connect abstract theme concept with real themes(folders).
  • mainKey (optional): Change mainKey name. Default value is 'main';

##All Fields Available Nonrequired fields depend of theme engine. As an example see full list of properties available for 3devices engine:

{
    "engine"       : "layered_themes_3devices"
  , "resolution"   : { 
	  				    "mobile" : "500" 
	  				  , "hq"     : "1000" 
	  		       }
  , "mainKey"      : "general"
  , "folders"      : [ "mob", "tab", "desk" ]
  , "themes"       : { 
	  				     "default" : "desk"
	  				    , "tablet" : "mini"
	  				    , "mobile" : "mini"
	  			   } 
  , "expand"      : {}
  , "include"     : {}
  , "extra"       : {}

}

For more information about this specific engine you can read 3devices engine documentation.

Actually you can add here what you need. Just use JSON syntax.