Or download the .zip file and unzip it into your ST2/ST3 packages
directory.

Optionally, to use the Render preview feature, you need to install at least one of
Pandoc, docutils or rst2pdf and they should be accessible in your PATH. (Copy the command_path variable from the package's settings file to your user settings file and add paths to your local installations to it.) In debian/ubuntu you can install them via apt-get:

$ sudo apt-get install pandoc docutils rst2pdf

Usage

Simple snippets work as tab-triggered shortcuts: type the shortcut and press <TAB> to
replace it with the snippet. If the snippet has placeholders, you can jump between them
using tab.

Magic Tables

There is a particular magic expansion for tables. Here is how it works:

Grid table

Create some kind of table outline, separating column with two or more spaces:

This is paragraph text *before* the table.
Column 1 Column 2
Foo Put two (or more) spaces as a field separator.
Bar Even very very long lines like these are fine, as long as you do not put in line endings here.
This is paragraph text *after* the table.

This is paragraph text *before* the table.
+----------+---------------------------------------------------------+
| Column 1 | Column 2 |
+==========+=========================================================+
| Foo | Put two (or more) spaces as a field separator. |
+----------+---------------------------------------------------------+
| Bar | Even very very long lines like these are fine, as long |
| | as you do not put in line endings here. |
+----------+---------------------------------------------------------+
This is paragraph text *after* the table.

Now suppose you add some text in a cell:

+----------+---------------------------------------------------------+
| Column 1 | Column 2 |
+==========+=========================================================+
| Foo is longer now | Put two (or more) spaces as a field separator. |
+----------+---------------------------------------------------------+
| Bar | Even very very long lines like these are fine, as long |
| | as you do not put in line endings here. |
+----------+---------------------------------------------------------+

Press the same trigger: magically, the structure will be fixed:

+-------------------+--------------------------------------------------------+
| Column 1 | Column 2 |
+===================+========================================================+
| Foo is longer now | Put two (or more) spaces as a field separator. |
+-------------------+--------------------------------------------------------+
| Bar | Even very very long lines like these are fine, as long |
| | as you do not put in line endings here. |
+-------------------+--------------------------------------------------------+

In addition, if you would like to keep the column width fixed, you could reflow the table pressing ctrl+t, r (super+shift+t, r in Mac). The result would be this:

+----------+---------------------------------------------------------+
| Column 1 | Column 2 |
+==========+=========================================================+
| Foo is | Put two (or more) spaces as a field separator. |
| longer | |
| now | |
+----------+---------------------------------------------------------+
| Bar | Even very very long lines like these are fine, as long |
| | as you do not put in line endings here. |
+----------+---------------------------------------------------------+

With the base trigger combination and the cursors you can merge simple cells.
For example, suppose you have this table:

The original code of wcwidth was taken to solve alignment issue with CJK characters.

Simple table

Instead of tables above, a simpler style table is also supported. Here is how it works:

Create some kind of table outline, separating column with two or more spaces:

This is paragraph text *before* the table.
Column 1 Column 2
Foo Put two (or more) spaces as a field separator.
Bar Even very very long lines like these are fine, as long as you do not put in line endings here.
This is paragraph text *after* the table.

This is paragraph text *before* the table.
========== ================================================================================================
Column 1 Column 2
========== ================================================================================================
Foo Put two (or more) spaces as a field separator.
Bar Even very very long lines like these are fine, as long as you do not put in line endings here.
========== ================================================================================================
This is paragraph text *after* the table.

Now suppose you add some text in a cell:

========== ================================================================================================
Column 1 Column 2
========== ================================================================================================
Foo is longer now Put two (or more) spaces as a field separator.
Bar Even very very long lines like these are fine, as long as you do not put in line endings here.
========== ================================================================================================

Press the same trigger: magically, the structure will be fixed:

=================== ================================================================================================
Column 1 Column 2
=================== ================================================================================================
Foo is longer now Put two (or more) spaces as a field separator.
Bar Even very very long lines like these are fine, as long as you do not put in line endings here.
=================== ================================================================================================

Headers

Autocompletion

*******************
A longer main title
*******************
A subtitle
----------

respectively.

Folding/unfolding

If you put the cursor in a completed header and press shift + TAB (alt + TAB in Mac),
the section under it will be folded/unfolded.

For example:

Folding/unfolding
+++++++++++++++++<TAB>
If you put the cursor in a completed header and press ``shift + TAB``,
(``alt + TAB`` in Mac) the section under it will be folded/unfolded.
Navigation
++++++++++
...

Result in:

Nested sections under a header are included.

Navigation

Also, it's possible to jump between headers.
alt+down and alt+up move the cursor position to the closer next or
previous header respectively.

alt+shift+down and alt+shift+up to the same, but only between headers
with the same or higher level (i.e. ignore childrens)

The header level is detected automatically.

Adjust header level

With the cursor in a header, press ctrl + + (plus key) and ctrl + -
(minus key) (alt + + and alt + -, in Mac) will increase and decrease the
header level respectively. The adornment decoration (underline / overline) are
autodetected from the document and uses Sphinx's conventions as default.

For example, you have the cursor in:

Magic Footnotes|
---------------

Which is a header level 2 and want to convert to a level 3, press ctrl + - to get:

Magic Footnotes
+++++++++++++++
|

Magic Footnotes

This is the smarter way to add footnotes, grouping them (and keepping count)
in a common region at the bottom of the document.

When you want to add a new note, press alt+shift+f.
This will happen:

A new n+1 (where n is the current footnotes count) note reference
will be added in the current cursor position

The corresponding reference definition will be added
at the bottom of the footnotes region

The cursor will be moved to write the note

After write the note you can go back to the reference with shift+up. Also, if
the cursor is just after a reference (i.e: the caret is next to the underscore like this [XX]_| ) you can jump to its definition with shift+down [1].