reStructuredText Extension for Visual Studio Code

This extension enables reStructuredText related features in Visual Studio Code,

• Code Snippets

• Live Preview

• Editor Enhancement

• Linter

• IntelliSense

Note

To get Syntax Highlighting, you might install this extension by Trond Snekvik.

Getting Started

Install the stable version from Visual Studio Code Marketplace .

1. Upgrade to Visual Studio Code 1.43.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 preview version of this extension.

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

• 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

Frequent Asked Questions can be found here.

License

This 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.