Getting Started with Skele

Welcome to Skele! This guide will help you get started with your new web project using Skele.

What's Inside?

This guide covers the foundations of working with Skele:

1. Install

Set up Skele on your system.

2. Run

Get your first project running locally.

3. Use

Develop your first page.

1. Installing Skele

To get started with Skele, fork the Skele repository and clone it to your computer. Ensure that Node.js and npm are installed on your system, then run npm install to install Skele's dependencies.

2. Running Skele

Skele consists of two 11ty sites:

1. The Site (/site/): The actual site which uses the components.
2. The Skele Component Library (/skele/): The documentation of the components and instructions for their use.

The package.json file at the root of the project includes scripts to build both the sites and their assets. To get started quickly, simply run npm start. This command builds the assets and both sites, then serves:

• The Site at localhost:8080.
• The Skele Component Library at localhost:8081.

3. Using Skele

Components in Skele are defined using a YAML structure. You can build a page by looping and nesting components within the front matter of a page or data file.

For a closer look at how it works, check out the source code for this page.