reStructuredText Ecosystem in Visual Studio Code

Visual Studio Code is a modern code editor for developers and more. To enable very good editing experience for a programming language, the following features are critical and necessary,

• Syntax Highlighting (via dependent extension by Trond Snekvik)

• Code Snippets

• Editor Enhancement

• Linter

• IntelliSense (via dependent extension by Alex Carney)

• Live Preview (via dependent extension by Alex Carney)

In recent years, different extension authors have collaborated to make sure reStructuredText language is well supported in VS Code.

The starting point is the reStructuredText extension by LeXtudio Inc., which provides the basic features and also prompts to install all other necessary ones.

Getting Started

Install the stable version from Visual Studio Code Marketplace .

1. Upgrade to Visual Studio Code 1.82.0 or above.

2. Switch to the Extensions view by clicking the fifth icon in the left most bar.

3. Type “restructuredtext” in the search box and hit Enter key.

4. Click “Install” button to install “reStructuredText” extension.

Note

If you want to stay on the edge, you can install Visual Studio Code Insider and then install the prerelease version of this extension.

You can go through the follow articles to better understand the various features,

• Visit Docs Home
• Articles
  • Prerequisites
  • Configuration
  • Keyboard Shortcuts
  • Live Preview
  • Linter
  • IntelliSense
  • Editor Enhancement
  • Code Snippets
  • Hacking the Source Code
  • Troubleshooting Guide
  • Background
  • Project History
  • reStructured Ecosystem
  • Third Party Licensing
• Support Services
• Privacy Policy

Frequent Asked Questions can be found here.

License

The reStructuredText extension is licensed under the MIT License.

Please see Third Party Licensing for details on the third-party files that we include with releases of this project.

Acknowledgements

Logo

The project logo comes from Legendora Icon by Teekatas Suwannakrua.

Linter

The linter support is based on Cody Hoover’s ruby-linter.

Live Preview

The initial idea was brought from Thomas Haakon Townsend’s ReStructured Text Previewer, but soon after moving fully to Sphinx, this extension becomes its own beast.

IntelliSense

The IntelliSense support is provided by the Esbonio Language Server.