TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
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/rest/README.org
Robert O'Connor e9ff9f09c6 Remove trailing whitespace from all files
2017-03-26 13:06:43 -04:00

1.8 KiB
Raw Blame History

reStructuredText layer

/TakeV/spacemacs/media/commit/ed8772fb9385ebaa7a83fa216b382a36a0ecfddb/layers/+lang/rest/img/restructuredtext.png

Description

The layer adds ReStructuredText (ReST) support to Spacemacs and adds some functions to rst-mode.

Features

  • rst files are supported via Emacs built-in rst.el.
  • Lists are inserted by new functions.
  • Directives can be inserted easily.
  • Sphinx support.

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

Sphinx target

To use the layer's Sphinx feature, the following variables should be set.

A parent directory is needed for all Sphinx projects' builds.

    (setq rst-sphinx-target-parent "/your/path/of/build/")

Set a directory in the parent directory for each Sphinx project.

    (setq rst-sphinx-target-projects
          '(("project1" . (latex "folder/in/target/parent" t))
            ("project2" . (html  "folder/in/target/parent" nil))
            ))

Web browser

Set the browser for viewing the HTML page of current rst file. This one is optional. If not set, the default browser will be used.

    (setq rst-slides-program "chromium")

Key bindings

Key Binding Description
<SPC> m c compile projects
<SPC> m f open compiled HTML page of current page