This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+lang/restructuredtext/README.org
2018-10-11 00:13:43 +03:00

33 lines
1 KiB
Org Mode

#+TITLE: reStructuredText layer
[[file:img/restructuredtext.png]]
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#configuration][Configuration]]
- [[#auto-complete][Auto-complete]]
* Description
The layer adds ReStructuredText (ReST) support to Spacemacs and adds some
functions to =rst-mode=.
Note: to add =Sphinx= specific support use the layer =sphinx=.
** Features:
- =rst= files are supported via Emacs built-in =rst.el=.
- Lists are inserted by new functions.
- Directives can be inserted easily.
- auto-completion for directives and options via =auto-complete-rst=.
- snippet support via =yasnippet=.
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =restructuredtext= to the existing =dotspacemacs-configuration-layers= list
in this file.
* Configuration
** Auto-complete
For now =auto-complete-rst= only works with sphinx 1.4.9 and lower.
New 1.5 release (as from December 2016) is not yet supported.