Content Formats

The @mdxe/hono runtime supports multiple output formats via file extensions.

Supported Formats

Extension	Content-Type	Description
`.html`	`text/html`	Rendered HTML
`.json`	`application/json`	MDXLD document
`.md`	`text/markdown`	Original MDX source
`.txt`	`text/plain`	Plain text content
`.xml`	`application/xml`	XML representation

Usage

Append extension to any URL:

curl https://example.com/docs/getting-started.json
curl https://example.com/docs/getting-started.md

Accept Header

Alternatively use Accept headers:

curl -H "Accept: application/json" https://example.com/docs/getting-started

JSON Response

{
  "id": "https://example.com/docs/getting-started",
  "type": "Docs",
  "data": {
    "title": "Getting Started",
    "description": "Learn how to use the library"
  },
  "content": "# Getting Started..."
}

Programmatic Usage

import { formatResponse } from '@mdxe/hono/format'
 
app.get('/docs/:slug', (c) => {
  const doc = loadDocument(c.req.param('slug'))
  return formatResponse(c, doc)
})

Content Formats

Content Formats

Supported Formats

Usage

Accept Header

JSON Response

Programmatic Usage

On this page