How Do I Preview Formatted README.rst Files in the IDE?

The README files in our open-source examples are written in reStructuredText, a simple markup language often used for documenting Python software. 

In the IDE, the default view of a README.rst file shows the source (markup) content. If you want to preview the file---that is, see it rendered in HTML---first open the README.rst file, then click the Open Preview toggle in the top right of the IDE. This is especially helpful if the README contains images.

Alternatively, you can use the following shortcut keys: Ctrl + Shift + R


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request



Please sign in to leave a comment.