Welcome to Static.

Here's how you can get started.

Getting Started

Static is a CLI tool that helps you build component-driven static websites that are fast, secure, and scalable.

Installation

Install Static globally using npm.

$ npm install -g static

Creating a New Project

Run the following command to create a new project anywhere on your machine.

$ static new my-project

Testing Your Website

You can start a web server to test your website before you deploy it.

Static uses the serve-handler dependency behind the scenes to run your project in isolation.

Changes to your code will prompt Static to rebuild your code and refresh your browser in realtime.

$ static serve my-project

Deploying Your Website

Static currently only supports deployment to Netlify.

You can deploy your project to Netlify using the following command.

$ static deploy my-project

Creating a Template

You can save and re-use your Static projects as templates for future projects.

Static projects are created with this 'example' template by default.

You can specify a new name for your template, in this example we have used my-template, however by default it will use the name of the copied project.

$ static template new my-template --copy=my-project

You can then re-use this template when creating another project.

$ static create my-new-project --template=my-template

Using Variables

All properties defined in your data/site.json file are available as variables in your templates.

Other Commands

Run the help command to see what other commands are available.

$ static help
© S7.GG 2025