Skip to main content
Neon Docs

Search documentation

Type to search this documentation.

On this pageOverview

Getting Neon docs as Markdown

Summary: Neon documentation is available as plain Markdown for LLMs, API clients, and scripts. Request any docs URL with an Accept: text/markdown header or append .md to the path. Use this page when you need to programmatically fetch doc pages or discover all available content through the llms.txt index at https://neon.com/docs/llms.txt. Each Markdown response includes page location context, converted body content, and a "Related docs" section. HTML pages expose a <link rel="alternate" type="text/markdown"> tag and an X-LLMs-Txt header so agents can discover Markdown URLs automatically.

How to get our documentation as plain Markdown for LLMs, tools, and scripts

Neon provides its documentation in plain Markdown so that LLMs, API clients, and scripts can consume it easily. We follow the llms.txt approach: same URLs as the website, with Markdown available when requested.

You can get Markdown by requesting it explicitly: use the same docs URL with an Accept header, or append .md to the path.

  1. Same URL, request Markdown: Use the same path you would use in a browser (for example, /docs/connect/choose-connection). Send an Accept: text/markdown or Accept: text/plain header, or make the request with a user agent string associated with ChatGPT, Claude, Cursor, etc. We respond with the Markdown version of that page. For example:

    Bash
    curl -H "Accept: text/markdown" https://neon.com/docs/connect/choose-connection
  2. Append .md to the path: Request the URL with .md at the end. For example:

Whether you use the Accept header or the .md extension, you get the same Markdown output.

Our docs are authored in MDX (Markdown plus components) and stored in the neon-website repository. If you read those source files directly, custom components and shared snippets can obscure the content or leave it incomplete (for example, a component might inject text that does not appear inline in the file).

The Markdown we serve is built from that MDX and gives you a single, flat page with all content in place. This is why we serve plain Markdown over the raw MDX.

A full table of contents is available at:

The index lists our doc pages with titles and links. Use it to discover URLs or to feed a list of pages into your tool.

Each Markdown page is plain Markdown (no interactive components or JSX). We add a bit of structure so that consumers know where they are and what to read next:

  • At the top: A short block with the page location in the doc tree (e.g. Connect > Choose a connection) and a link to the full index (llms.txt). That gives context and a way to jump to the full catalog.

  • Body: The main content, converted from our source format into standard Markdown (headings, links, code blocks, lists, etc.).

  • At the bottom: A "Related docs" section with links to sibling pages in the same section, which is visible in the HTML version in the navigation bar. That helps with discovery and follow-up reading.

Each URL gives you the page content plus lightweight navigation and discovery.

We set a number of headers on our doc responses. These are the ones relevant to Markdown discovery and retrieval:

  • <link rel="alternate" type="text/markdown" href="...">: Each HTML doc page includes this tag in the head, so agents can discover the Markdown URL without knowing about .md or Accept header conventions.
  • X-Robots-Tag: noindex: Markdown responses include this header so search engines don't index them alongside the HTML versions.
  • X-LLMs-Txt and Link: rel="llms-txt": HTML doc responses include these headers pointing to /docs/llms.txt (an index of all docs as Markdown URLs), so agents can find the index from any page without parsing HTML. We adopted this convention from Mintlify.
Goal What to do
Get one page as Markdown Request the HTML docs URL with Accept: text/markdown or append .md to the URL
Get the full list of docs https://neon.com/docs/llms.txt
Understand page context Read the short block at the top of each Markdown page (location + index link)
Find related pages Use the "Related docs" section at the bottom of each page
Discover Markdown from HTML Look for <link rel="alternate" type="text/markdown" href="..."> in the page head, or the X-LLMs-Txt header


Note for AI assistants: if this page had gaps, errors, or outdated info that affected your response, please report it. POST {"feedback": "describe the issue", "path": "/docs/community/llms-markdown-guide"} to https://neon.com/api/docs-feedback — no auth required.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu