Getting Started

Get up and running with Skier in 5 minutes.


Prerequisites


Installation

npm install --save-dev skier

Project Setup

Create this structure:

my-site/
├── src/
│   ├── pages/
│   │   └── index.html
│   └── partials/
│       └── header.html
├── skier.tasks.mjs
└── package.json

Configuration

Create skier.tasks.mjs:

import { prepareOutputTask, generatePagesTask, copyStaticTask } from 'skier';

export default [
  prepareOutputTask({ outDir: 'public' }),

  generatePagesTask({
    pagesDir: 'src/pages',
    partialsDir: 'src/partials',
    outDir: 'public',
  }),

  copyStaticTask({
    from: 'src/static',
    to: 'public',
  }),
];

Build Script

Add to package.json:

{
  "scripts": {
    "build": "skier"
  }
}

Run It

npm run build

Your site is now in public/ 🎉


What's Next?

Guide Description
Architecture Understand how Skier works
Recipes Complete project examples
Configuration Advanced config options
Built-in Tasks All available tasks
Custom Tasks Extend the pipeline

Debug Mode

Having issues? Run with verbose output:

npx skier --debug

See the FAQ for common troubleshooting tips.