Guide › Introduction

Getting started

clarusjs is a Vite plugin plus a small runtime. You need Node 22.12 or later.

Install

pnpm add clarusjs
pnpm add -D vite

Configure Vite

// vite.config.ts
import { defineConfig } from 'vite'
import clarusjs from 'clarusjs/vite'

export default defineConfig({ plugins: [clarusjs()] })

Write a page

Every .tscl file under src/pages is a route: src/pages/index.tscl is /, and src/pages/guide/intro.tscl is /guide/intro.

{{-- src/pages/index.tscl --}}
<h1>Hello</h1>
<p>This page is plain HTML.</p>

Run it

pnpm exec vite  # dev server, pages rendered on each request
pnpm exec vite build  # static site in dist/client/