See what else is in Acrolinx for Visual Studio Code in the release notes in this help center.
Installation and Setup
Acrolinx works on Microsoft Visual Studio Code version 1.7 and later. Check what version you have installed in the menu Code > About Visual Studio Code.
- You should have received an installation file (VisualStudioCodeV1.0.0_B55.vsix) from your administrator.
- To install Acrolinx, open the extensions panel. To open the panel, click the Extensions button in the Activity Bar or navigate in the menu to View > Extensions.... If Extensions... is not available on your View menu, you are using an old version of Visual Studio Code. You need to update to the current version of Visual Studio Code.
- In the header of the Extensions panel, click the More ... icon and select Install from VSIX...
- Select the Acrolinx installation file (VisualStudioCodeV1.0.0_B55.vsix) and click Open.
The installation may take a few seconds. When it's finished, a confirmation message will appear at the top of the screen and prompt you to reload.
Getting Started with Acrolinx
Acrolinx is only available if you open a saved document.
To start using Acrolinx, open a saved markdown (
*.md) or text (
*.txt) document. You can either create a new document and save it, or open a previously saved document. The sidebar isn't available if your content contains unsaved changes. Acrolinx is available if you can see the Acrolinx icon. This icon is found in the title area above the editor.
To open the Acrolinx sidebar, click the Acrolinx icon on the right side of the title area.
You can open a separate sidebar for each Visual Studio Code window that you open.
Sign in to Acrolinx. When you open the sidebar for the first time, it will prompt you for server connection details. Your Acrolinx administrator should have given you your server address already as well as your sign-in details. Enter your sign-in details and click Sign In.
Setting the Checking Options
Before you start checking, make sure that you have the right checking options. Even if your company has someone who sets up Acrolinx for you, it's still good to know what these options are for and how they work.
Open the slide-out menu and click Options to get started. Your administrator sets up the writing guides, so if you're unsure what to select, ask them. Select a writing guide and turn on the other checking types that you want: spelling, grammar, style, tone of voice, deprecated terms, and term sets. Review or update the available options.
After you've updated the checking options, you're ready to run your first check.
Checking, Reviewing, and Correcting Your Content
Once you've set the checking options or selected a checking profile, you can start checking and optimizing your content.
To check your content, click the Check button at the top of the sidebar. Unless your content is flawless, you'll probably see issues show up in the Results tab. Content issues are represented as colored "cards" that you can interact with. Acrolinx also gives you a Scorecard that scores your content based on the types of issues that you're checking for. You also get an overall Acrolinx Score. To see your Scorecard, open the slide-out menu and click Scorecard or click the Acrolinx Score in the top right corner of the sidebar.
In the sidebar, use your mouse to move through the issues. To see the issue highlighted in your content, click the title of the issue in the issue card.
- Edit the issues. Acrolinx offers replacements for some issue types. Replacements appear in green, bold font in the issue cards.
- To correct an issue with a replacement automatically, click it. Often, Acrolinx can't suggest anything when the issue covers a whole sentence. In this case, we'll tell you that the sentence could be improved, but you decide how to improve it. You can also click the MORE INFORMATION button for more information on why we think it's an issue.
- To ignore an issue, click the issue text.
- To see more editing options, click the Show actions button. Depending on your user privileges, you may see different actions.
When you're finished correcting all issues, save and close your content as usual.
Install Acrolinx for Visual Studio Code from the Command Line
Administrators can automate and configure Acrolinx for users just like you would for other Visual Studio Code extensions. For more details, see the admin section in this help center.