Guides
AI Assistant Integration
Use the bundled Maglev documentation export with IDE AI features to work faster.
Maglev provides a combined markdown file (full_site.md) containing all documentation pages. The file is meant for local AI tools (including assistants in modern IDEs) so you get answers grounded in the Maglev docs while building sections.
This guide explains how to set up and use the full_site.md file in Cursor (the first IDE we cover). Instructions for other IDEs will be added soon.
Download the Markdown File
Download the latest Maglev documentation markdown file from:
https://docs.maglev.dev/assets/ai/full_site.md
Save this file somewhere in your project or on your local machine.
Add the Markdown File to Cursor
- Open Cursor and your Maglev project.
- Open the AI Assistant panel (usually accessible via the sidebar or with a shortcut like
Cmd+I). - Locate the "Knowledge" or "Custom Docs" section in the AI Assistant settings.
- Add
full_site.mdas a knowledge source:- Click "Add file" or "Import markdown" (the exact wording may vary).
- Select the
full_site.mdfile you downloaded.
- Save or apply the changes.
The AI assistant in Cursor will now use the Maglev documentation to answer your questions, generate code, and provide context-aware help based on your own docs.
Tips for Best Results
- Download the latest
full_site.mdwhenever you want the most up-to-date documentation. - Keep the file up to date in Cursor’s knowledge base.
- Ask specific questions in Cursor referencing Maglev features, sections, or code examples.
Other IDEs
Instructions for integrating the markdown file with other IDEs (such as VS Code, JetBrains, etc.) will be added here soon.