How to Use the Docs

Get the most out of the Vendure documentation with powerful search, AI-ready endpoints, and ways to help improve the docs.

Powerful Search

Find what you need quickly with our hybrid search system that combines semantic understanding with keyword matching. Use Cmd/Ctrl + K to open search from anywhere.

Cmd+Kto open search

AI & Coding Agent Ready

Integrate our documentation directly into your AI workflows. Access markdown versions of any doc page or use the llms.txt endpoint for full context.

# Fetch docs as markdowncurl -H "Accept: text/markdown" \  docs.vendure.io/current/core/...# Get AI context filecurl docs.vendure.io/llms.txt

Copy the URL or click "View as markdown" on any doc page.

Help Us Improve

Found a bug or have a suggestion? Use the bug report button in the bottom-right corner of any page, or share feedback via the footer. Join our Discord community to connect with other developers.

Discord·GitHub·Community

Coming Soon

We're working on exciting new features to make the docs even more helpful. Stay tuned for AI-powered explanations and an interactive chat assistant.

Explain with AI - Get AI explanations for any code block
AI Chat Assistant - Ask questions and get instant answers

Connect Your AI Tools

Use our MCP server to give your AI coding assistant direct access to the Vendure documentation. Pick your editor below to get started.

Run this command in your terminal:

claude mcp add vendure-docs --transport http https://docs.vendure.io/mcp

Or add the following to .mcp.json in your project root:

.mcp.json

{  "mcpServers": {    "vendure-docs": {      "url": "https://docs.vendure.io/mcp"    }  }}

Available tools

search_docs — search across all documentation
get_doc_page — retrieve full markdown content of any page