Generate Stripe-Like API Docs

Ready to standardize your API documentation and reduce the back-and-forth between your teams? Theneo is the only API documentation tool designed for your entire team, from developers to non-technical team members.

VS Code Extenson

This extension allows you to generate and preview the API Documentations right in the Visual Studio Code.

Theneo Account

If you do not have already, please sign up here

Get Authentication Token

Go to your dashboard https://app.theneo.io/projects, click on your profile , than user settings and Github secret, and copy your secret key

Use the secret key in the extension

After you download the extension, click on "extension settings", in "Theneo: API KEY" add the key you just generated from the platform

Generate API Documentation

Open a json or .yaml file on VS Code Extension

• On the buttom of the page you will see "Theneo Doc"
• Select a project you would like to update
• Select an action item - Preview document or - Publish changes or - Create a project You can see repository of all the APIs in your Theneo Dashboard

Requirements

VScode 1.5+

Extension Settings

This extension contributes the following settings:

• Theneo: your documentation secret key

Known Issues

None yet

Release Notes

0.0.1

Initial release with document preview and publish functionality for existing documents.

0.0.5

Documentation and readme updates

0.0.6

Fixed project list display issues

0.0.7

Updated to support v2 editor projects

0.0.8

Updated to support creating Theneo project from the extension

0.0.9

Updated to preview project from the extension

1.0.0

1.0.1

Added jsdoc support. Now you can create a project from jsdoc comments. You can create js file and add jsdoc comments to the functions and classes, then you can create a project from the extension.

1.0.2

A really nice feature is added to the extension. Now you can create a preview project from the extension. You don't need worry about losing your changes, because you can create a preview project and test your changes any time. See the list of commands below:

PREVIEW PROJECT - A workspace or functionality that allows users to create, edit, and review their changes before finalizing and publishing them.It provides an opportunity to verify and adjust any modifications in a controlled environment, minimizing the risk of introducing errors into the live project.

1. Preview or Update Document - This feature allows you to preview or update the project you've created.

2. Create a Preview Project - With this command, you can create a preview project to test your changes before publishing them. This allows you to see what your final documentation will look like. You have the option to remove the preview project from the extension at any time.

3. Publish Changes - Use this command to publish your changes to the documentation. Be aware that this will overwrite the existing documentation.

4. Create a New Project - This command will create a new project on our platform and also publish your file to the documentation.

5. Delete a Preview Project - If you want to remove your preview project from the documentation, this command will do it.

1.0.3

1.0.4

Added GraphQL support.

1.0.5

1.0.6

1.0.7

2.0.0

New Features

• Ability to export projects from Theneo as markdown and json.

• Ability to Import markdown into Theneo Project.

• 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.
5. Merge Project to Theneo.

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.