# zid-theme package

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

Read the GitHub page for more information:

{% embed url="<https://github.com/zidsa/zid-theme-npm>" %}
zid-theme GitHub readme
{% endembed %}

## ⚙️ Installation

Node Package Manager (NPM):

```bash
npm install -g zid-theme
```

{% hint style="info" %}
zid-theme need to be installed globally to create a symlink in your global folder
{% endhint %}

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

```bash
zid-theme help
```

## Assets - accepted extensions

```javascript
['.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 .
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://themes.zid.dev/zid-theme-package.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.