Skip to content
elek.io
Deutsch

elek.io Core documentation

elek.io Core is in Alpha and not ready for production use. See what doesn't work yet. We'd love you to try it and tell us in GitHub Discussions opens in a new tab what you find, so we can make it better.

View as Markdown
On this page

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 for the data model, then usage.md for a runnable walkthrough. Reach for the reference docs below as needed.

Start here

  • features.md - capability overview for evaluating Core, including current limitations
  • concepts.md - the data model: Projects, Collections, Components, Entries, Values, Assets and Releases
  • usage.md - programmatic usage, the local API, the CLI and the Astro integration

Content modeling

  • fields.md - the field type reference and how Entry Values are stored
  • schema-changes.md - what happens to existing content when you edit field definitions
  • references.md - typed pointers between content and how Core keeps them intact
  • markdown-content.md - storing and rendering rich markdown content as an mdast tree
  • asset-management.md - the two-file Asset model, creating, reading and deleting Assets

Reading and shipping content

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

Platform