Guides Overview
Welcome to the ContentKit guides. This section walks you through installing, configuring and integrating ContentKit in your TypeScript / Next.js projects, then understanding the emitted artifacts.
ContentKit is early and under active development. APIs may change; pin versions and review release notes when upgrading.
Quick Start (TL;DR)
- Install:
pnpm add -D contentkit - Init config:
npx contentkit init - Add markdown in your
content/directory - Build:
npx contentkit build - Import data:
import { allPosts } from 'dot-contentkit/generated'
Jump into the detailed guides below for deeper explanations and options.
Core Guides
- Installation – Add the package & scaffold a config.
- Configuration – Define document types, fields & computed fields.
- CLI – Commands (
init,validate,build) and scripting tips. - Build Output – Folder layout, imports & types.
- Common Errors – Troubleshooting and resolving common issues.
- Upgrade Guide v1.0 – Migrating from v0.x to v1.0.
Concepts At a Glance
| Concept | What It Is | Where To Read |
|---|---|---|
| Document Type | Schema for a group of markdown files | Configuration |
| Frontmatter | Source metadata (YAML / TOML / JSON) | Configuration / Output |
| Computed Field | Derived value (slug, reading time, etc.) | Configuration |
| Generated Package | dot-contentkit virtual import exposing data & types | Build Output |
Roadmap (High Level)
Planned / in exploration:
- Incremental (per‑file) builds
- Richer MD/MDX processing pipeline (plugins / remark / rehype opt‑in)
- Watch mode outside Next.js
- Optional image/asset metadata extraction
- Improved DX around custom computed field type inference
Feedback / Issues
If something is unclear or broken, open an issue or PR. Early user feedback heavily shapes priorities.
Happy building!