Skrip
collections/docs/introduction

Introduction

section: Getting Started

Skrip is a headless CMS engine for file-based markdown content. It reads a directory of markdown files, parses their frontmatter into structured data, and exposes everything through a clean JSON API.

Installation

Install the package using your preferred package manager:

npm install skriplet

Requires Node.js 18 or later.

Core Concepts

Collections are directories inside your content/ folder. Each directory is a collection, and each .md file inside it is a content item.

Items are individual markdown files. The filename (without .md) becomes the item's slug. The YAML frontmatter becomes the item's data.

The API exposes collections and items as JSON. There's no authentication, no write API — Skrip is read-only by design.

Philosophy

Skrip is built around three ideas:

  1. Files are the database. No external service to set up or maintain.
  2. Frontmatter is the schema. Your data shape is defined by your content, not a config file.
  3. The API is a thin wrapper. Skrip adds structure on top of files — nothing more.

When to Use Skrip

Skrip is a great fit for:

  • Blogs and personal sites
  • Documentation sites
  • Marketing pages with structured content
  • Prototypes that need real content quickly

It's not designed for content that needs real-time writes, user-generated content, or complex relational data.

Next Steps

Head to the Collections guide to learn how to structure your content.

Frontmatter

{
  "title": "Introduction",
  "section": "Getting Started",
  "order": 1,
  "description": "What Skrip is, what it's for, and how it works."
}

API endpoint

GET /api/collections/docs/introduction