EkLine VSCode Integration

EkLine flags any style guide violations in your company's documentation with Visual Studio Code diagnostics. It offers immediate feedback, facilitating consistency in your documentation.

Prerequisites

You have an EkLine API token provided by the EkLine contact person.

Getting started

Installation

To install the VSCode extension from the web, follow these steps:

1. Visit the EkLine Extension Page on VSCode Marketplace.
2. Click Install.
3. Open Visual Studio Code when prompted.

Or,

To install the VSCode extension from within VSCode,

1. Open Visual Studio Code.
2. Click on the Extensions icon in the Activity Bar on the side of the window to access the Extensions view.
3. Type "EkLine" in the Extensions view search box.
4. Click the "Install" button next to the extension with the same name.

Configure EkLine linter

EkLine requires an API Token for activation. This token is unique to your EkLine Organization account.

Follow these steps to configure EkLine:

1. Obtain an access token from your EkLine Organization account. Navigate to Settings > Organization > Access Token to find your token.

2. Open Visual Studio Code and go to the EkLine extension settings. You can access this by clicking on the extension's settings icon.

3. Paste your access token into the designated EkLine Token input box.

If you cancel the process or input an invalid token, a popup will appear offering another chance to set up EkLine. If you wish to avoid future popups, you can choose to turn off EkLine.

To turn off EkLine, execute 'Configure EkLine Linter' from the Command Palette or uncheck the 'off' box in the EkLine Extension Settings.

Usage

The EkLine extension provides several commands for linting your documents:

1. EkLine: Review all documents: This command runs EkLine on all supported files in your workspace. You can execute this command from the Command Palette by typing EkLine: Review all documents.

2. EkLine: Review current document: This command runs EkLine on the currently active file. You can execute this command from the Command Palette by typing EkLine: Review current document.

3. EkLine: Configure Extension: This command allows you to configure the EkLine extension settings. You can execute this command from the Command Palette by typing EkLine: Configure Extension.

4. EkLine: Improve writing in current file: This command utilizes EkLineAI to enhance the writing in the active file. You can execute this command from the Command Palette by typing EkLine: Improve writing in current file.

Remember, the extension also runs EkLine on supported files when they are opened or saved.

Troubleshooting

If you encounter issues, try the following:

• Ensure you have the correct access token. If you're unsure, contact your EkLine account administrator.
• If the issue persists, contact our support team at support@ekline.io.