coralite

Coralite

coralite is a static site generator library built around the emerging HTML modules proposal.

• Getting started
  • Basic templating
• Reference
  • Coralite CLI
  • Coralite

Installation

Before using the Coralite CLI, ensure that it's installed on your system. You can install it globally using npm:

npm install -g coralite
# or
yarn global add coralite
# or
pnpm add -g coralite

You can also install coralite as a development dependency:

npm install --save-dev coralite
# or
yarn add -D coralite
# or
pnpm add -D coralite

Basic Syntax

Coralite is executed using the following command:

coralite [options]

Replace [options] with the desired flags and arguments.

Required Options

To generate a website using Coralite, you must provide three essential options:

• -t or --templates: The path to your templates directory containing reusable UI elements (e.g., -c ./src/templates).
• -p or --pages: The path to your pages directory where static HTML files reside (e.g., -p ./src/pages).
• --output or -o: The output directory for the generated site (e.g., --output ./dist).

Here's an example of how these options might look:

coralite --templates ./path/to/templates --pages ./path/to/pages --output ./dist

Optional Options

-d or --dry-run

Run the CLI in dry-run mode to preview the actions that would be performed without actually generating the website. This is useful for debugging or when you want to check potential issues before committing changes:

coralite --templates ./path/to/templates --pages ./path/to/pages --output ./dist --dry-run

Troubleshooting

Coralite uses ECMAScript Modules which requires to run Node.js with the --experimental-vm-modules option enabled.

node --experimental-vm-modules node_modules/coralite/bin/coralite.js [options]

or using NODE_OPTIONS

NODE_OPTIONS=--experimental-vm-modules coralite [options]