# elek.io Core documentation

Consumer documentation for `@elek-io/core`. These docs ship inside the published package, so a developer or AI coding agent always has version-matched references for the exact Core version in use, with no network lookup.

They cover how to use Core: the data model, the public API, the local REST API, the CLI and the Astro integration. They do not cover how to develop Core itself, that lives in the repository's `contributing/` folder and is not published.

New to elek.io Core? Read [`concepts.md`](https://elek.io/en/documentation/core/concepts) for the data model, then [`usage.md`](https://elek.io/en/documentation/core/usage) for a runnable walkthrough. Reach for the reference docs below as needed.

## Start here

- [`features.md`](https://elek.io/en/documentation/core/features) - capability overview for evaluating Core, including current limitations
- [`concepts.md`](https://elek.io/en/documentation/core/concepts) - the data model: Projects, Collections, Components, Entries, Values, Assets and Releases
- [`usage.md`](https://elek.io/en/documentation/core/usage) - programmatic usage, the local API, the CLI and the Astro integration

## Content modeling

- [`fields.md`](https://elek.io/en/documentation/core/fields) - the field type reference and how Entry Values are stored
- [`schema-changes.md`](https://elek.io/en/documentation/core/schema-changes) - what happens to existing content when you edit field definitions
- [`references.md`](https://elek.io/en/documentation/core/references) - typed pointers between content and how Core keeps them intact
- [`markdown-content.md`](https://elek.io/en/documentation/core/markdown-content) - storing and rendering rich `markdown` content as an mdast tree
- [`asset-management.md`](https://elek.io/en/documentation/core/asset-management) - the two-file Asset model, creating, reading and deleting Assets

## Reading and shipping content

- [`local-api.md`](https://elek.io/en/documentation/core/local-api) - the read-only REST API: endpoints, pagination and the OpenAPI docs
- [`api-clients.md`](https://elek.io/en/documentation/core/api-clients) - generating typed JS/TS clients and standalone TypeScript types
- [`export.md`](https://elek.io/en/documentation/core/export) - exporting Projects to plain JSON
- [`releases.md`](https://elek.io/en/documentation/core/releases) - tagged, versioned snapshots and promoting `draft` into `main`
- [`provisioning.md`](https://elek.io/en/documentation/core/provisioning) - provisioning Projects into build environments (CI/CD and local builds), whatever runs next

## Platform

- [`git-and-sync.md`](https://elek.io/en/documentation/core/git-and-sync) - the branch model, commits and synchronizing with a remote
- [`storage-layout.md`](https://elek.io/en/documentation/core/storage-layout) - where Projects and their files live on disk
- [`error-handling.md`](https://elek.io/en/documentation/core/error-handling) - `CoreError` and how to catch failures