Visual Studio Code Extension

Visual Studio Code (VS Code) is a preferred editor for many developers due to its versatility and extensive extension ecosystem. To enhance the experience further, Theneo offers a dedicated VS Code extension that simplifies the creation and previewing of API references directly within the editor.

Installation and Configuration

Install Theneo VS Code Extenstion

Configure the Extension:

1. After installation, sign in to your Theneo account at app.theneo.io
2. Once signed in, navigate to your profile settings.
3. Within your profile settings, locate and select the "Tools & Integrations" section.
4. In the "Tools & Integrations" section, find and copy your Theneo API key.
5. In VS Code Extension open the command palette by pressing Ctrl+Shift+P (or Cmd+Shift+P on Mac).
6. Type 'Preferences: Open Settings (UI)' and select it.
7. Search for Theneo Markdown in the “Extensions” section
8. Paste your Theneo API key

New Features

• Ability to export projects from Theneo as markdown and json.
• Ability to Import markdown into theneo directly.
• Ability to merge json to an existing project in Theneo.

Usage

Export Project from Theneo

1. Open the command palette by pressing Ctrl+Shift+P (or Cmd+Shift+P on Mac).
2. Search for “Theneo: Export Project from Theneo”.
3. Select the project from your list of published projects created in Theneo.
4. Enter a parent directory to export the project and press enter.

Import Project to Theneo

1. Open the command palette by pressing Ctrl+Shift+P (or Cmd+Shift+P on Mac).
2. Search for “Theneo: Import Project To Theneo”.
3. Enter project name after “/”. example /project
4. Choose if you want to publish the document.

Merge Project to Theneo

1. Open the command palette by pressing Ctrl+Shift+P (or Cmd+Shift+P on Mac).
2. Search for "Theneo: Merge Project To Theneo".
3. Copy the relative path to the section that you want to merge.
4. Pick the project you are merging with (usually the same project as you exported).
5. Go over the changes and press commit merge button.

Open Preview

1. Open the command palette by pressing Ctrl+Shift+P (or Cmd+Shift+P on Mac).
2. Search for “Theneo: Open Current Project Preview”.
3. Type the project name and press enter.

The Theneo VS Code extension streamlines the API documentation process by integrating it into your development environment. It saves time and enhances efficiency by eliminating the need to switch between tools for documentation tasks.

With just a few clicks, you can generate a live preview of your API documentation, making it easier to develop and review your API descriptions and endpoints without ever leaving VS Code.