Vscode Restructuredtext

reStructuredText Language Support in Visual Studio Code

reStructuredText Language Support for Visual Studio Code

Build Status Current Version Install Count Download Count Gitter

This extension provides rich reStructuredText language support for Visual Studio Code. Now you write reStructuredText scripts using the excellent IDE-like interface that VS Code provides.

reStructuredText in Visual Studio Code

Features

  • Code Snippets
  • Live Preview
  • Editor Enhancement
  • Linter
  • IntelliSense (Experimental)

To get Syntax Highlighting, please also install this extension by Trond Snekvik.

Frequent Asked Questions can be found here.

How to install from Marketplace

This extension is hosted at Visual Studio 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 (by LeXtudio Inc.).

After installing this extension, please visit the homepage for this extension to learn how to use it.

Contributing to the code

Check out the development documentation for more details on how to contribute to this extension!

License

This extension is licensed under the MIT License. Please see the third-party notices file 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. Either rstcheck or doc8 can be used as default 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.

Currently, the experiment is to enable live preview via Esbonio language server.

IntelliSense

The IntelliSense support is provided by Esbonio language server.

Popular Restructuredtext Projects
Popular Visual Studio Code Projects
Popular Data Formats Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
Python
Typescript
Language
Sphinx
Visual Studio Code
Intellisense
Documentation Tool
Restructuredtext
Sphinx Doc