Theme Create

Create a new Zid theme effortlessly using our starter template.

Description

The new command initializes a new Zid theme project with the specified name. It sets up the required file structure and installs dependencies, allowing you to start quickly.

Usage

Arguments

Argument	Description	Required
`<theme-name>`	The name of your new theme	Yes

Theme Structure

A newly created theme will have the following structure:

$ root
.
┃
┃─── query.json
┃─── layout.twig
┃─── header.twig
┃─── footer.twig
┃
┃─── templates (accepted extensions: [ '.twig' ])
┃    ┃─── 404.twig
┃    ┃─── home.twig
┃    ┃─── search.twig
┃    ┃─── products.twig
┃    ┃─── product.twig
┃    ┃─── categories.twig
┃    ┃─── category.twig
┃    ┃─── blogs.twig
┃    ┃─── blog.twig
┃    ┃─── faqs.twig
┃    ┃─── cart.twig
┃    ┃─── shipping-and-payments.twig
┃    ┃─── account-addresses.twig
┃    ┃─── account-orders.twig
┃    ┃─── account-profile.twig
┃
┃─── modules (accepted extensions: ['.twig'])
┃
┃─── common (accepted extensions: ['.twig'])
┃
┃─── locals (accepted extensions: ['.json'])
┃
┃─── assets

Directory Descriptions

Directory	Purpose	Accepted Extensions
`templates/`	Contains Twig template files for various pages.	`.twig`
`modules/`	Holds reusable module templates.	`.twig`
`common/`	Common template parts for repeated elements.	`.twig`
`locals/`	Localization files for supporting multiple languages.	`.json`
`assets/`	Theme assets, such as images, styles, and scripts.	`.js`, `.css`, `.jpg`, etc.

Examples

Create a new theme with default options

Post-Creation Steps

After creating your theme:

Navigate to the theme directory:

Start customizing your theme:

Edit Twig templates in the templates/ directory.

Add custom styles and scripts in the assets/ directory.

Use other Zid Theme commands:

Use commands like build and preview to test and develop your theme.

Important Notes

Permissions: Ensure you have the necessary permissions to create directories in the chosen location.

Theme Name: The theme name should be unique and follow naming conventions (e.g., lowercase, no spaces, use hyphens or underscores).

Version Control: After creation, use version control tools like Git to manage your theme development.

Learn More

For more information on theme development and deployment, refer to the Zid Theme Development Documentation.

Description#

Usage#

Arguments#

Theme Structure#

Directory Descriptions#

Examples#

Create a new theme with default options#

Post-Creation Steps#

Important Notes#

Learn More#