Byline CMS
  • Home
  • Docs
  • About
Byline CMS
View on GitHub
  • Getting Started
    • Overview
    • CLI
    • Development environment and example application
    • Configuration
    • Upgrading from 3.21 to 4.x
    • Upgrading from 4.11 to 4.12
  • Why Byline
    • Overview
    • Mission & Vision
    • Content Management in the Time of AI
  • Key Architectural Decisions
    • Overview
    • Core Document Storage
    • Core Composition
    • Transactions
    • Path Grammar
    • Deployment Topologies
  • Collections
    • Overview
    • Fields
    • Blocks
    • Relationships
    • Document Trees
    • Document Paths
    • File / Media Uploads
    • Rich Text Editor
    • Collection Versioning
  • Reading & Delivery
    • Overview
    • Search & Document Extraction
    • Client SDK (@byline/client)
    • Routing & API
    • Transports
    • Markdown Export
    • MCP Server
    • Caching
  • Search
    • Overview
    • Configure search
    • Indexing and reindexing
    • Search API
    • Search provider contract
    • Portable multilingual search analysis
    • PostgreSQL and MySQL search providers
    • Attachment extraction for search
  • Auth & Security
    • Overview
    • Authentication & Authorization
    • Auditability
  • Internationalization (i18n)
    • Overview
    • The host i18n system
    • Admin interface translations
    • Content locales
    • Administering content locales
  • Admin UI
    • Overview
    • UI Kit (@byline/ui)
    • Admin-config registration
  • API Reference
    • Overview
    • Configuration API
    • Collections API
    • Fields API
    • Client SDK API
  • Testing
  • Home

Reading & Delivery

Companions:

  • Collections — the schemas that determine what the delivery surfaces read and serialize.
  • Client SDK — the primary in-process read and write API.
  • Client SDK API — every public client and collection-handle method with its options and return shape.

Modeling content is only half the job; the other half is getting it out to the things that read it — browsers, other services, and increasingly language models and agents. This section covers every way content leaves Byline and how to serve it efficiently.

  • Client SDK — @byline/client, the typed, DSL-style API for querying and writing documents from outside the admin UI.
  • Routing & API — the current transport surface (TanStack Start server functions) and the boundary where a stable HTTP API becomes worthwhile.
  • Transports (planned) — how Byline intends to layer framework-agnostic logic under host-specific bindings so the same operations can be exposed over different transports.
  • Markdown Export — one-way Lexical-to-markdown rendering, the .md URL surface, and llms.txt for agent consumers.
  • MCP Server (planned) — exposing Byline content to AI agents over the Model Context Protocol.
  • Caching — CDN edge caching, invalidation strategies, and the optional in-memory data cache.
  • Search — ranked collection and zone search, portable multilingual analysis, and built-in PostgreSQL and MySQL providers now have a dedicated section.
PreviousCollection Versioning
NextSearch & Document Extraction
Byline CMS

Building the future of content management, one commit at a time.

Project

  • Documentation
  • Roadmap
  • Contributing
  • Releases

Community

  • GitHub Discussions
  • Blog
  • Newsletter

Legal

  • Privacy Policy
  • Terms of Use
  • Cookies

© 2026 Infonomic Company Limited and contributors. Open source and built with ❤️ by the community.