sqHTML

Base to start projects in HTML, simply and quickly.

Requirements

• Node.js 22 or higher.
• npm.

Installation

1. Open a terminal at the root of your project.

2. Optional (empty project): initialize npm metadata.

   npm init

3. Install the package:

   npm i sqhtml

4. Initialize the template explicitly:

   npx sqhtml init

   The init command copies files/ without overwriting existing project files, runs SISASS 2.0.2 in SQHTML mode, and renames the copied gitignore to .gitignore. If .gitignore already exists, it is preserved and no duplicate gitignore file is kept.

   The SISASS command executed by the initializer is:

   npm explore sisass -- npm run init -- --dep sqhtml

CLI options

Initialize a different project path:

npx sqhtml init --path ./example

Overwrite template-managed files while preserving an existing .gitignore:

npx sqhtml init --force

Show help and version:

npx sqhtml --help
npx sqhtml init --help
npx sqhtml --version

Skipping sisass init

Set the environment variable if you need to bypass SISASS initialization during CI or custom workflows. The template is still copied, but assets/scss/core/ is not generated by the initializer:

SKIP_SISASS_INIT=1 npx sqhtml init

Server

To run the site if you don't have a configured localhost, run the following command:

nodemon --ext html,js,css,scss ./config/serve.js

In another terminal, run the gulp task with the -browser parameter as follows:

gulp -browser

If you want the browser to refresh when you make changes, you can run the gulp command with the following parameter

gulp -browser -sync