Inkies Docs

Packages

Package scope, current publication status, and the Inkies publishing plan.

The Inkies packages are the source-facing interfaces for pulling and rendering published articles.

PackageScopeStatus
@inkies/sdkREST client, types, pagination, and InkiesErrorNot published to npm
@inkies/nextNext.js article rendering, metadata, sitemap, and JSON-LD helpersNot published to npm
@inkies/startTanStack Start article rendering, head metadata, sitemap XML, and JSON-LD helpersNot published to npm

Publishing to npm is planned; until then the packages are consumed from the repository workspace.

The packages are not installable from npm today. These are future commands for after publication:

pnpm add @inkies/sdk
pnpm add @inkies/sdk @inkies/next
pnpm add @inkies/sdk @inkies/start

Use the API reference for a framework-independent integration. Use the Next.js guide or TanStack Start guide for adapter APIs.