Getting Started

Basic Project Structure

Acetate sites have 3 common components need to get started:

  1. A folder containing HTML and Markdown pages. This is generally called src.
  2. A acetate.config.js file that defines basic project configuration.

Quick Start

$ npm install -g acetate-cli

Clone the Acetate sample project and cd into it:

$ git clone https://github.com/patrickarlt/acetate-sample.git && cd ./acetate-sample

Intall the dependencies with NPM:

$ npm install

Run the built-in development server:

$ acetate server

What's Next?

Take a look at Understanding Acetate for a more in depth look at how Acetate works. Then you are ready to start building your project or dive into some of the sample sites.

Starter Projects

Examples


Edit this Page on GitHub