Vim reStructured Text

Title: Vim reStructured Text - A Quick Introduction
Author: George V. Reilly <george@reilly.org>
Date: 2006/05/12

What is VST?

VST is an easy way to produce:

from reStructured text: plain text with minimal markup.

The powerful Vim editor is used to prepare the material.

Please read the source of these slides to see how the effects used herein are achieved.

Simple markup

Blockquotes

You can embed blockquotes inside your text:

 Simple markup
 ==============

 + Bulleted Lists
 + Numeric lists (nested)

     #. **Bold** text
     2. *Italics* text
     #. ``typewriter`` text

 + Replacement -- |VST| -- of text.

is most of the text of the previous slide.

Links

VST supports a variety of hyperlink notations.

The full effect of these links cannot be seen in the S5 slides. Regenerate with :Vst instead.

Images

http://www.vim.org/images/vim_header.gif

Tip

You can apply a variety of attributes to images.

If you need really fine control, you may need to use .. raw:: html

Simple Tables

su

mo

tu

we

th

fr

sa

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

Rich Tables

Cells are separated

by bar with spaces around

<Space>|<Space>

You may use inline

markup, links

included.

You can use various types of structure elements:

 Welcome to world  
 of preformatted   
 text.
  • like lists

    • various

  • embedded

  • one into other

VST will interpret them.

Even paragraphs.

  1. And

  2. not

Text may span across several columns. Cell can be also empty ->

Conclusion

VST is an easy way to produce marked-up documents with easy-to-read source, in Vim.

This slideshow displays only a few features of VST. Be sure to read the manual.