Zid Themes Docs
  • Getting started
  • Twig reference
  • Theme file structure
  • zid-theme package
  • Theme Templates and Data
    • layout.twig
  • Store language and currency
  • Home template modules
  • Product template
  • Cart template
  • Settings Schema
    • text
    • number
    • textarea
    • select
    • radios
    • checkbox
    • checkboxes
    • range
    • color
    • image
    • product
    • category
    • category products
    • list
    • fieldset
  • Data reference
    • locals
    • store
    • cart
    • product
    • products list
    • category
    • categories list
    • session
    • customer
    • faqs
    • blogs
    • blog
    • page
    • main menu
    • request
    • orders
    • addresses
    • store payment methods
    • store shipping methods
    • store banks
    • asset_url
    • header_meta_tags
  • Zid-api Library
    • Product
    • Category
    • Cart
    • Blog
    • Customer
    • Settings
  • Upload themes and more
Powered by GitBook
On this page
  • ⚙️ Installation
  • Assets - accepted extensions
  • ⚡️ Build command

Was this helpful?

zid-theme package

PreviousTheme file structureNextTheme Templates and Data

Last updated 3 years ago

Was this helpful?

zid-theme is cross-platform CLI that developers can use to validate and build their theme

Read the GitHub page for more information:

⚙️ Installation

Node Package Manager (NPM):

npm install -g zid-theme

zid-theme need to be installed globally to create a symlink in your global folder

Once you install the package run help to see all avaliable commands:

zid-theme help

Assets - accepted extensions

['.js','.ts','.css','.scss','.map','.png','.jpg','.jpeg','.gif','.svg','.woff','.woff2','.otf','.ttf','.eot']

⚡️ Build command

Running the build command only without arguments, will assume the current path is where the theme exist, and the theme zip will be named after the root directory name

zid-theme build

The following command takes two arguments --path and --name

To set the path of the theme (default .):

zid-theme build --path ./theme_path

To set the name of the theme (root folder name):

zid-theme build --name best-theme-ever

Full command:

zid-theme build --name best-theme-ever --path .
GitHub - zidsa/zid-theme-npm: NPM package to process theme folderGitHub
zid-theme GitHub readme
Logo