rst-snippets
This Atom Package is focused on developing some shortcuts for editing reStructuredText documents.
Headers
This is set of shortcut methods to take the current line and turn it into a reStructuredText header.
Usage
- Set reStructuredText as syntax (or open a .rst)
- Create a line of text::
This is a Line of text
- Put your cursor somewhere in the content to turn into a heading.
- Press
ctrl+alt+h 1
to turn the line of text into a Level 1 heading. The output will look something like this::
====================== This is a Line of text ======================
Notes
You can choose the heading level by pressing the corresponding level key after pressing
ctrl+alt+h
.
Level | Key Sequence | Character | Top Bar |
---|---|---|---|
1 | ctrl+alt+h 1 |
= |
yes |
2 | ctrl+alt+h 2 |
- |
yes |
3 | ctrl+alt+h 3 |
= |
no |
4 | ctrl+alt+h 4 |
- |
no |
5 | ctrl+alt+h 5 |
````` | no |
6 | ctrl+alt+h 6 |
' |
no |
7 | ctrl+alt+h 7 |
. |
no |
8 | ctrl+alt+h 8 |
~ |
no |
9 | ctrl+alt+h 9 |
* |
no |
10 | ctrl+alt+h a |
+ |
no |
11 | ctrl+alt+h b |
^ |
no |
Tables
This is a Atom adaptation of Vincent Driessen's vim-rst-tables
1 code
by Martín Gaitán gaitan@gmail.com
Usage
-
Set reStructuredText as syntax (or open a .rst)
-
Create some kind of table outline:
This is paragraph text *before* the table. Column 1 Column 2 Hickory Insert two (or more) spaces as a field separator. Dickory Long lines like these are fine, as long as you do not put in line endings here. Dock This is the last line. This is paragraph text *after* the table.
-
Put your cursor somewhere in the content to convert as table.
-
Press
ctrl+alt+t enter
(to create the table). The output will look something like this:This is paragraph text *before* the table. +----------+---------------------------------------------------------------------------------+ | Column 1 | Column 2 | +==========+=================================================================================+ | Hickory | Insert two (or more) spaces as a field separator. | +----------+---------------------------------------------------------------------------------+ | Dickory | Long lines like these are fine, as long as you do not put in line endings here. | +----------+---------------------------------------------------------------------------------+ | Dock | This is the last line. | +----------+---------------------------------------------------------------------------------+ This is paragraph text *after* the table.
-
Suppose you want to wrap long line within a cell. First break the line and place pipes to delineate the column. Then press
ctrl+alt+t t
(to fix the formatting).This is paragraph text *before* the table. +----------+---------------------------------------------------------------------------------+ | Column 1 | Column 2 | +==========+=================================================================================+ | Hickory | Insert two (or more) spaces as a field separator. | +----------+---------------------------------------------------------------------------------+ | Dickory | Long lines like these are fine, as long as you do not | | put in line endings here. | +----------+---------------------------------------------------------------------------------+ | Dock | This is the last line. | +----------+---------------------------------------------------------------------------------+ This is paragraph text *after* the table.
The output will look something like this:
This is paragraph text *before* the table. +----------+-------------------------------------------------------+ | Column 1 | Column 2 | +==========+=======================================================+ | Hickory | Insert two (or more) spaces as a field separator. | +----------+-------------------------------------------------------+ | Dickory | Long lines like these are fine, as long as you do not | | | put in line endings here. | +----------+-------------------------------------------------------+ | Dock | This is the last line. | +----------+-------------------------------------------------------+ This is paragraph text *after* the table.
-
If you wanted to add additional content to a cell, but not increase the width of the current table. Add your additional text to the line, then press
ctrl+alt+t r
to reflow and wrap text as needed.This is paragraph text *before* the table. +----------+-------------------------------------------------------+ | Column 1 | Column 2 | +==========+=======================================================+ | Hickory | Insert two (or more) spaces as a field separator. | +----------+-------------------------------------------------------+ | Dickory | Long lines like these are fine, as long as you do not | | | put in line endings here. | +----------+-------------------------------------------------------+ | Dock | This is the last line. Fore score and seven years ago, the quick brown fox jumped over the lazy dogs. | +----------+-------------------------------------------------------+ This is paragraph text *after* the table.
The output will look something like this:
> This is paragraph text *before* the table.
>
> +----------+------------------------------------------------------+
> | Column 1 | Column 2 |
> +==========+======================================================+
> | Hickory | Insert two (or more) spaces as a field separator. |
> +----------+------------------------------------------------------+
> | Dickory | Long lines like these are fine, as long as you |
> | | do not put in line endings here. |
> +----------+------------------------------------------------------+
> | Dock | This is the last line. Fore score and seven |
> | | years ago, the quick brown fox jumped over the lazy |
> | | dogs. |
> +----------+------------------------------------------------------+
>
> This is paragraph text *after* the table.
Tip
Change something in the output table and run ctrl+alt+t enter
again: Magically,
it will be fixed.
And ctrl+alt+t r
reflows the table maintaining the current column width.