Installation

First things first, you will need at least node version 18.8.0 and above installed.

Quick Start (Recommended) #

To scaffold a new project with the official template:

  npm create coralite@latest

For more options, see the Create Coralite documentation.

Manual Installation #

Alternatively, after initialising your project, install coralite as a dev dependency:

  npm install coralite

Build script #

To prepare the development environment, we'll add the build command to the "script" property in our package.json file.

Here is an example of what your package.json file should look like

For more information about the CLI options check out the CLI reference page

  {
    "name": "my-coralite-site",
    "scripts": {
      "build": "coralite -t src/templates -p src/pages -o dist"
    },
    "dependencies": {
      "coralite": "^0.24.0"
    }
  }

Next, follow the getting started guide to discover how build your first web page with coralite!