reStructuredText Language Support for Visual Studio Code

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.

Features

Syntax highlighting
Code snippets
- code Code block
- image Image
- figure Figure
- link Link
- attention Attention
- note Note
- warning Warning
- error Error
- hint Hint
- important Important
- caution Caution
- danger Danger
- tip Tip
- admonition Admonition
- rubric Rubric (footnote)
- doc Doc reference
To trigger snippets, please refer to Visual Studio Code shortcuts.
Preview (ported from rst-vscode extension)

The shortcuts are
- ctrl+shift+r Preview
- ctrl+k r Preview to Side

The preview feature requires Python to be installed. The docutils Python module is also required.

How to Install from Gallery

This extension is hosted at Visual Studio Marketplace

Press F1 to show all commands.
Type ext install and hit Enter.
Change the command to ext install restructuredtext and hit Enter.

When the extension information is displayed, click the install button.

Integration with Sphinx

Check out the workarounds for more details.

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](Third Party Notices.txt) file for details on the third-party files that we include with releases of this project.

Logo

The project logo comes from Legendora Icon by Teekatas Suwannakrua.