VS Code Extension
The Theneo VS Code extension brings documentation into your editor. Create, export, import, merge, and preview API references without leaving VS Code — no tool-switching, no context loss.
Installation & configuration
Install the Theneo VS Code extension
Get the extension from the Visual Studio Marketplace.
Configure the extension
- After installing, sign in to your Theneo account at app.theneo.io.
- Open your profile settings.
- Go to Tools & Integrations.
- Copy your Theneo API key.
- In VS Code, open the command palette with Ctrl+Shift+P (or Cmd+Shift+P on Mac).
- Run Preferences: Open Settings (UI).
- Search for Theneo Markdown under Extensions.
- Paste your API key.
Features
- Export projects from Theneo as Markdown and JSON.
- Import Markdown into Theneo directly.
- Merge JSON into an existing Theneo project.
Usage
Export a project from Theneo
- Open the command palette (Ctrl/Cmd+Shift+P).
- Run Theneo: Export Project from Theneo.
- Select a published project from your list.
- Enter a parent directory and press Enter.
Import a project to Theneo
- Open the command palette.
- Run Theneo: Import Project To Theneo.
- Enter the project name after “/” (e.g.
/project). - Choose whether to publish.
Merge a project to Theneo
- Open the command palette.
- Run Theneo: Merge Project To Theneo.
- Copy the relative path to the section you want to merge.
- Pick the project to merge with (usually the one you exported).
- Review the changes and click Commit merge.
Open a preview
- Open the command palette.
- Run Theneo: Open Current Project Preview.
- Type the project name and press Enter.
The extension streamlines API documentation by integrating it into your development environment — generating live previews with just a few clicks, so you can develop and review your API descriptions and endpoints without ever leaving VS Code.
Was this section helpful?
On this page
- VS Code Extension