Permalink
Browse files

Merge pull request #24 from livibetter/improve-docs

add TOC, use kbd, fix table syntax, put example code in literal block
  • Loading branch information...
nvie committed Nov 30, 2015
2 parents c05be3f + 9445c67 commit 7a66513629decd5e715e57e109bcb9bad8141139
Showing with 58 additions and 50 deletions.
  1. +12 −6 README.rst
  2. +46 −44 tutorial.rst
View
@@ -3,6 +3,10 @@ vim-rst-tables
.. image:: http://stillmaintained.com/nvie/vim-rst-tables.png
+.. contents:: **Contents**
+ :local:
+
+
Installation
------------
1. Install the following packages from PyPI:
@@ -22,7 +26,7 @@ Installation
4. Copy the file ``ftplugin/rst_tables.vim`` to your ``~/.vim/ftplugin``
directory. If your vim is not already configured to source scripts
in this directory, make sure to add the appropriate command to your
- .vimrc::
+ ``.vimrc``::
source "~/.vim/ftplugin/rst_tables.vim"
@@ -48,12 +52,13 @@ Creating a new table
This is paragraph text *after* the table.
2. Put your cursor somewhere in the table.
-3. To create the table, press ``,,c`` (or ``\\c`` if vim's <Leader> is set to
- the default value). The output will look something like this::
+3. To create the table, press :kbd:`,,c` (or :kbd:`\\c` if vim's
+ :kbd:`&lt;Leader&gt;` is set to the default value). The output will look
+ something like this::
This is paragraph text *before* the table.
- +==========+=========================================================+
+ +----------+---------------------------------------------------------+
| Column 1 | Column 2 |
+==========+=========================================================+
| Foo | Put two (or more) spaces as a field separator. |
@@ -77,5 +82,6 @@ you can define the column width you would prefer, and re-flow your table.
1. Change the number of "---" signs in the top row of your table to match
the column widths you would prefer.
2. Put your cursor somewhere in the table.
-3. Press ``,,f`` to re-flow the table (or ``\\f`` if vim's <Leader> is set to
- the default value; see also the :map command).
+3. Press :kbd:`,,f` to re-flow the table (or :kbd:`\\f` if vim's
+ :kbd:`&lt;Leader&gt;` is set to the default value; see also the ``:map``
+ command).
View
@@ -1,58 +1,60 @@
Simple example
==============
-Set your cursor inside the following paragraph and type ",,c":
-
-Feature Description
-Easy It's soo easy, man.
-Predictable Amount of spaces doesn't matter.
-Repeatable It can be repeated.
-Flexible Even spaces at the end of a line are fine.
-
-Then, the paragraph should turn into:
-
-+=============+============================================+
-| Feature | Description |
-+=============+============================================+
-| Easy | It's soo easy, man. |
-+-------------+--------------------------------------------+
-| Predictable | Amount of spaces doesn't matter. |
-+-------------+--------------------------------------------+
-| Repeatable | It can be repeated. |
-+-------------+--------------------------------------------+
-| Flexible | Even spaces at the end of a line are fine. |
-+-------------+--------------------------------------------+
+Set your cursor inside the following paragraph and type :kbd:`,,c`::
+
+ Feature Description
+ Easy It's soo easy, man.
+ Predictable Amount of spaces doesn't matter.
+ Repeatable It can be repeated.
+ Flexible Even spaces at the end of a line are fine.
+
+Then, the paragraph should turn into::
+
+ +-------------+--------------------------------------------+
+ | Feature | Description |
+ +=============+============================================+
+ | Easy | It's soo easy, man. |
+ +-------------+--------------------------------------------+
+ | Predictable | Amount of spaces doesn't matter. |
+ +-------------+--------------------------------------------+
+ | Repeatable | It can be repeated. |
+ +-------------+--------------------------------------------+
+ | Flexible | Even spaces at the end of a line are fine. |
+ +-------------+--------------------------------------------+
Then, fix the "soo" to become "so" and insert the word "really" between
"doesn't" and "matter". Finally, rename "Easy" to "Super easy", so it looks
-like this:
+like this::
-+=============+==================================+
-| Feature | Description |
-+=============+==================================+
-| Super easy | It's so easy, man. |
-+-------------+----------------------------------+
-| Predictable | Amount of spaces doesn't really matter. |
-+-------------+----------------------------------+
-| Repeatable | It can be repeated. |
-+-------------+----------------------------------+
+ +-------------+----------------------------------+
+ | Feature | Description |
+ +=============+==================================+
+ | Super easy | It's so easy, man. |
+ +-------------+----------------------------------+
+ | Predictable | Amount of spaces doesn't really matter. |
+ +-------------+----------------------------------+
+ | Repeatable | It can be repeated. |
+ +-------------+----------------------------------+
-Then, set your cursor inside the table again, and type ,,f to reformat the
-table.
+Then, set your cursor inside the table again, and type :kbd:`,,f` to reformat
+the table.
A more complex example
======================
-Feature| Description |
-Ease of use | Drop dead simple!
-Foo | Bar, qux, mux
-Predictability | Deploykdj sfkljsdjf ljdflsk jsdflkj dsflkj sdlkj dfslkj
-| | dfslkjds flkdjsfl sdfjlk jdfslk djsfl dfjslk jsdflk jfdslk jdfslkds fjlkds
-| | jldkfj ldfsjlsd jldsf jlkjds flds fjlk jdflk jdsflj dslfjs dlfj sdflkj sdlfj
-| |dfslkjds flkdjsfl sdfjlk jdfslk djsfl dfjslk jsdflk jfdslk jdfslkds fjlkds
-| |jldkfj ldfsjlsd jldsf jlkjds flds fjlk jdflk jdsflj dslfjs dlfj sdflkj sdlfj
-| |dfslkjds flkdjsfl sdfjlk jdfslk djsfl dfjslk jsdflk jfdslk jdfslkds fjlkds
-| |jldkfj ldfsjlsd jldsf jlkjds flds fjlk jdflk jdsflj dslfjs dlfj sdflkj sdlfj |
-| |ldfsj dlfsj dfskjdfs ldsfj
+::
+
+ Feature| Description |
+ Ease of use | Drop dead simple!
+ Foo | Bar, qux, mux
+ Predictability | Deploykdj sfkljsdjf ljdflsk jsdflkj dsflkj sdlkj dfslkj
+ | | dfslkjds flkdjsfl sdfjlk jdfslk djsfl dfjslk jsdflk jfdslk jdfslkds fjlkds
+ | | jldkfj ldfsjlsd jldsf jlkjds flds fjlk jdflk jdsflj dslfjs dlfj sdflkj sdlfj
+ | |dfslkjds flkdjsfl sdfjlk jdfslk djsfl dfjslk jsdflk jfdslk jdfslkds fjlkds
+ | |jldkfj ldfsjlsd jldsf jlkjds flds fjlk jdflk jdsflj dslfjs dlfj sdflkj sdlfj
+ | |dfslkjds flkdjsfl sdfjlk jdfslk djsfl dfjslk jsdflk jfdslk jdfslkds fjlkds
+ | |jldkfj ldfsjlsd jldsf jlkjds flds fjlk jdflk jdsflj dslfjs dlfj sdflkj sdlfj |
+ | |ldfsj dlfsj dfskjdfs ldsfj
And some para-text below it.

0 comments on commit 7a66513

Please sign in to comment.