Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/docs/api/filtering.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Filtering"
description: "Learn how to filter posts by categories, tags, and search queries."
description: "Filter Marble API posts using categories, tags, featured status, and search query parameters, combined with AND logic for precise results."
---

Marble API provides powerful filtering options to retrieve exactly the content you need. Filters are applied using query parameters and can be combined for precise content selection.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/api/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Marble API Reference"
sidebarTitle: "Introduction"
description: "Overview of the Marble REST APIbase URL, authentication, and response format."
description: "Reference overview of the Marble REST API: base URL, JSON response format, API key authentication, error handling, and standard HTTP conventions."
---

The Marble API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and verbs.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/api/pagination.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Pagination"
description: "Learn how to use pagination in the Marble API."
description: "Use offset-based pagination on Marble API list endpoints with limit and page query parameters, plus pagination metadata returned in every response."
---

Marble API uses offset-based pagination for endpoints that return multiple items. Pagination metadata is included in every response to help you navigate through large datasets efficiently.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/api/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "API Authentication"
sidebarTitle: "Quickstart"
description: "Get an API key and make your first authenticated request to the Marble API."
description: "Create a Marble API key in your dashboard, authenticate using the Authorization header, and make your first authenticated request with curl."
---

## Quick Start
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/api/rate-limits.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Rate Limits"
description: "Understand how Marble API rate limiting works and what quotas apply to your requests."
description: "Marble API rate limits per API key, response headers, 429 handling, and retry guidance to keep your integration within request quotas."
---

Marble applies rate limits to protect the stability of the API for all users. This page explains the limits, how they are calculated, and how to design your integration to handle them gracefully.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/api/types.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "TypeScript Types"
description: "TypeScript type definitions for Marble API responses."
description: "TypeScript type definitions for Marble API responses, including Post, Category, Tag, Author, and Pagination, importable from the @usemarble/sdk package."
---

<Tip>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/concepts/content-model.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Content Model"
description: "How Marble structures content posts, authors, categories, and tagsand how each maps to the API."
description: "Understand Marble's content model: how posts, authors, categories, tags, and custom fields relate to one another and map to API responses."
---

Marble's content model is intentionally small. Everything centers on the **post**, which is connected to **authors**, a **category**, **tags**, and optional **custom fields**. Understanding how these relate makes it straightforward to query and render content from your frontend.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/concepts/headless-cms.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "What Is a Headless CMS?"
sidebarTitle: "Headless CMS"
description: "What a headless CMS is, how it differs from traditional platforms, and where Marble fits."
description: "What a headless CMS is, how it differs from traditional platforms like WordPress, the benefits of going headless, and where Marble fits in."
---

A **headless CMS** is a content management system that stores and organizes your content, then delivers it over an API — without dictating how or where that content is displayed. The "head" (the frontend that visitors see) is decoupled from the "body" (the place you write and manage content).
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/concepts/workspaces.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Workspaces & Teams"
sidebarTitle: "Workspaces & Teams"
description: "How Marble organizes content into workspaces and manages team members and roles."
description: "How Marble uses workspaces to isolate content, media, and API keys per project, plus how to invite teammates and assign roles for collaboration."
---

A **workspace** is the top-level container for everything in Marble. Each workspace holds its own posts, media, authors, categories, tags, custom fields, API keys, and team members — fully isolated from every other workspace.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/features/custom-fields.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Custom Fields
description: Extend your post schema with workspace-specific metadata and consume it directly from the API.
description: "Add typed custom fields — text, number, boolean, and date — to your Marble posts and consume the values directly from the API response."
---

Custom fields let you add your own metadata to every post in a workspace. Instead of forcing everything into tags or description, you can model structured values like release dates, reading levels, priorities, product names, or any internal metadata your team needs.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/features/editor.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Marble's Editor"
sidebarTitle: "Editor"
description: "A clean, distraction-free editor with rich formatting, media embeds, and AI-powered writing insights."
description: "Marble's distraction-free Notion-like editor: rich formatting, headings, lists, code, image and video embeds, and AI-powered writing insights."
---

Marble's editor is designed to get out of your way. A clean, Notion-like writing experience with no clutter — just you and your content. All metadata and settings live in a collapsible sidebar so you can focus when you need to.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/features/import.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Importing Content"
sidebarTitle: "Import"
description: "Migrate existing content into Marble, with support for Markdown and MDX syntax."
description: "Migrate existing Markdown and MDX content into Marble: which syntax is preserved on import, how MDX components are handled, and migration tips."
---

You can bring your existing `.md` and `.mdx` files into Marble. During import, Marble preserves the most commonly used Markdown and MDX syntax so you do not have to rewrite your content.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/features/media.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Media & Image Hosting"
sidebarTitle: "Media"
description: "Upload, manage, and serve images and video from Marble's built-in CDN."
description: "Upload, manage, and serve images, video, audio, and document files from Marble's built-in object storage and CDN at cdn.marblecms.com."
---

Marble handles your media so you can focus on writing. Upload files to your
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/integrations/astro.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Astro Integration"
sidebarTitle: "Astro"
description: "Add a headless CMS to your Astro site using Content Collections and full type safety."
description: "Connect Marble to your Astro site with the SDK and a Content Loader for Content Collections, with full type safety and a starter blog template."
---

To integrate Marble in your Astro application, you first need an Astro site. If you don't have one, you can check out the [Astro documentation](https://docs.astro.build/en/tutorial/0-introduction/) to get started, or use our [Astro blog template](https://github.com/usemarble/astro-example) for a ready-to-go solution.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/integrations/framer.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Framer Integration"
sidebarTitle: "Framer"
description: "Sync Marble content to Framer CMS with the Marble plugin."
description: "Sync Marble posts, categories, tags, authors, and media into Framer CMS using the no-code Marble plugin from the Framer Marketplace."
---

The Marble plugin syncs content from your Marble workspace into Framer CMS collections. No code required—you install the plugin from the Framer Marketplace, connect your workspace, and import with one click.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/integrations/nextjs.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Next.js Integration"
sidebarTitle: "Next.js"
description: "Add a headless CMS to your Next.js app — fetch, render, and revalidate Marble content."
description: "Build a Next.js blog with Marble: install the SDK, configure environment variables, fetch and render posts, and revalidate content with webhooks."
---

Getting your content to your Next.js site is as simple as using the Marble SDK. This guide will walk you through setting up a blog with Marble and Next.js.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/integrations/tanstack.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "TanStack Start Integration"
sidebarTitle: "TanStack Start"
description: "Add a headless CMS to your TanStack Start app with full type safety."
description: "Add Marble as a headless CMS to your TanStack Start app: install the SDK, set up environment variables, and fetch typed posts with full type safety."
---

Getting your content to your TanStack Start site is as simple as using the Marble SDK. This guide will walk you through setting up a blog with Marble and TanStack Start.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "What is Marble"
sidebarTitle: "Introduction"
description: "Marble is a simple, open-source headless CMS with a clean editor and a flexible REST API."
description: "Marble is a simple, open-source headless CMS for writers and developers, with a clean editor, team workspaces, and a flexible REST API."
---

**Marble is a simple, headless CMS built for writers and developers.** It helps you manage and publish content without the complexity of traditional CMS platforms.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Set Up Your Workspace"
sidebarTitle: "Quickstart"
description: "Create your account, set up a workspace, and publish your first post."
description: "Step-by-step guide to creating a Marble account, setting up your first workspace, inviting teammates, and publishing your first post."
---

<Steps>
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/recipes/code-highlighting.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Syntax Highlighting"
description: "Add syntax highlighting to code blocks in your posts"
description: "Add beautiful syntax highlighting to code blocks in Marble posts using Shiki to transform HTML content with light and dark code themes."
---

Your posts might include code blocks that you want to style with syntax highlighting. This recipe shows how to use [Shiki](https://shiki.style) to transform your Marble content with beautiful code highlighting.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/recipes/reading-time.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Reading Time"
description: "How to display reading time for posts."
description: "Calculate and display estimated reading time for Marble posts on your frontend with a simple TypeScript word-count function based on words per minute."
---

Some blogs like to show an estimated reading time for each post. Marble provides these estimates inside the editor interface, but you can also display them on the frontend of your site.
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/tools/mcp.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Marble MCP Server"
sidebarTitle: "MCP Server"
description: "Connect Claude, Cursor, and other MCP clients to your Marble workspace to manage content with AI."
description: "Connect Claude, Cursor, and other MCP clients to Marble's Model Context Protocol server to read, create, update, and manage workspace content with AI."
---

Use Marble's Model Context Protocol server to let AI agents read and manage
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/tools/sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Marble TypeScript SDK"
sidebarTitle: "TypeScript SDK"
description: "The official Marble TypeScript SDK fully typed, framework-agnostic access to your content."
description: "Use the official @usemarble/sdk TypeScript SDK for fully typed, framework-agnostic access to the Marble API, with retries and pagination helpers."
---

Developer-friendly & type-safe TypeScript SDK for the Marble API. Built with automatic retries, pagination helpers, and full TypeScript support.
Expand Down
Loading