reStructuredText Language Support in Visual Studio Code
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE.md Sep 27, 2018
.vscode Add new command to underline current line. Oct 22, 2017
images Added a live preview screen shot. Jul 8, 2016
media Revised the command names. Nov 18, 2018
preview-src Revised the command names. Nov 18, 2018
python Switched to RST-vscode approach. Nov 17, 2018
snippets Added literalinclude snippet Mar 13, 2018
src Added linting log entries. Dec 13, 2018
syntaxes Added experimental support for indented sections. Fixed #85. Apr 14, 2018
test-resources Fixed test cases. Nov 19, 2018
test Updated text to reflect actual underLineChars sequences Sep 14, 2018
.editorconfig Added a new way to work with sphinx. Jan 30, 2016
.gitignore Fixed preview revival. Nov 19, 2018
.travis.yml Updated nvm. Sep 2, 2018
.vscodeignore Moved test files. Nov 19, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Jun 16, 2017
CONTRIBUTING.md Create CONTRIBUTING.md Sep 28, 2017
LICENSE.txt Added basic files. Nov 25, 2015
README.md Updated documentation and error messages. Sep 8, 2018
Third Party Notices.txt Updated documentation. Mar 15, 2018
appveyor.yml Removed dir. Sep 2, 2018
build.bat Enabled test cases. Nov 19, 2018
language-configuration.json Support comments in language-configuration.json Nov 14, 2018
package-lock.json Bumped the version. Dec 11, 2018
package.json Bumped the version. Dec 13, 2018
package.nls.json Switched to RST-vscode approach. Nov 17, 2018
tsconfig.json Switched to RST-vscode approach. Nov 17, 2018
tslint.json Revised the command names. Nov 18, 2018
webpack.config.js Switched to RST-vscode approach. Nov 17, 2018

README.md

reStructuredText Language Support for Visual Studio Code

Gitter Current Version Install Count Open Issues Stories in Progress

Windows Linux
Build status Build status Build status

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

  • Syntax Highlighting
  • Code Snippets
  • Live Preview
  • Section Builder
  • Linter
  • IntelliSense (Experimental)

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

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!

Check the dashboard on work items.

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.

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 reStructuredText Language Server.