Installation

Install with your preferred package manager:

npm

$ npm install -D contentkit

pnpm

$ pnpm add -D contentkit

yarn

$ yarn add -D contentkit

bun

$ bun add -D contentkit

Initialize a config:

npx

npx contentkit init

pnpm

pnpm exec contentkit init

yarn

yarn contentkit init

bunx

bunx contentkit init

This creates contentkit.config.ts (or .js) based on environment.

Add a sample document:

Unix

mkdir -p content
printf "---\ntitle: Hello World\ndate: 2025-01-01\ntags: [intro]\n---\n\nMy first post." > content/hello-world.md

Windows Powershell

New-Item -ItemType Directory -Force -Path content | Out-Null
@"
---
title: Hello World
date: 2025-01-01
tags: [intro]
---

My first post.
"@ | Set-Content content/hello-world.md

Build:

npx

npx contentkit build

pnpm

pnpm exec contentkit build

yarn

yarn contentkit build

bunx

bunx contentkit build

Generated artifacts live in .contentkit/generated and a virtual package dot-contentkit is written. Now we will add the dot-contentkit package to our project.

First, open your tsconfig.json (or jsconfig.json) file and add the following path mapping:

tsconfig.json

{
  "compilerOptions": {
    "paths": {
      "dot-contentkit": [".contentkit/generated"],
    },
  },
}

jsconfig.json

{
  "compilerOptions": {
    "paths": {
      "dot-contentkit": [".contentkit/generated"],
    },
  },
}