Scalar OpenAPI to Markdown


A Node.js package to generate LLM-friendly Markdown from OpenAPI documents.

Installation

``bash
npm install @scalar/openapi-to-markdown
`

Usage

`ts
import { createMarkdownFromOpenApi } from '@scalar/openapi-to-markdown'

const content = {
openapi: '3.1.1',
info: {
title: 'My API',
version: '1.0',
},
paths: {
// …
},
}

// Generate Markdown from an OpenAPI document
const markdown = await createMarkdownFromOpenApi(content)
`

$3

You use the package with any Node.js framework. Here is an example for Hono:

`ts
import { Hono } from 'hono'
import { createMarkdownFromOpenApi } from '@scalar/openapi-to-markdown'

// Generate Markdown from an OpenAPI document
const markdown = await createMarkdownFromOpenApi(content)

const app = new Hono()

/**
* Register a route to serve the Markdown for LLMs
*
* Q: Why /llms.txt?
* A: It's a proposal to standardise on using an /llms.txt file.
*
* @see https://llmstxt.org/
*/
app.get('/llms.txt', (c) => c.text(markdown))

serve(app)
`

$3

This is not really the purpose of the package, but maybe good to know: This package actually renders HTML at first, and
transforms the HTML to Markdown then.

So if you'd like to have a really light-weight HTML API Reference, here you are:

`ts
import { Hono } from 'hono'
import { createHtmlFromOpenApi } from '@scalar/openapi-to-markdown'

// Generate HTML from an OpenAPI document
const html = await createHtmlFromOpenApi(content)

const app = new Hono()

app.get('/', (c) =>
c.html(


serve(app)
``

Community

We are API nerds. You too? Let's chat on Discord:

License

The source code in this repository is licensed under MIT.