Welcome to the Interactive reStructuredText Tutorial!
This project provides a hands-on learning experience for reStructuredText (reST), an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. reStructuredText is commonly used for technical documentation, including Python's official documentation, and is a core component of the Docutils project.
Through these interactive lessons, you'll learn the fundamentals and more advanced features of reStructuredText, enabling you to write clear, well-structured documents. Each lesson includes an interactive editor where you can practice the concepts immediately.
Official Docutils Documentation
For more comprehensive information, refer to the official Docutils and reStructuredText documentation:
- reStructuredText Quickref
- reStructuredText Markup Specification
- reStructuredText Directives
- reStructuredText Interpreted Text Roles
Tools
- reStructuredText Playground - Experiment with reST syntax live in your browser.
Table of Contents
-
1. Introduction to reStructuredText
-
2. Inline Markup
-
3. Document Structure
-
4. Lists and Blocks
-
5. Tables & Data
-
6. Multimedia
-
7. Directives, Roles & Comments
-
8. Configuration & Best Practices