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/+tools/pandoc/README.org
2016-03-30 22:59:55 -04:00

39 lines
1.3 KiB
Org Mode

#+TITLE: Pandoc layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#install][Install]]
- [[#layer][Layer]]
- [[#pandoc][Pandoc]]
- [[#usage][Usage]]
- [[#key-bindings][Key Bindings]]
* Description
This layer adds support for [[http://johnmacfarlane.net/pandoc][Pandoc]].
Pandoc is a universal document converter. It makes it easy to e.g. convert a
Markdown file to org mode or vice versa. It can also export your text to PDF or
DOCX.
This layer automatically install an org exporter using the [[https://github.com/kawabata/ox-pandoc][ox-pandoc]].
* Install
** Layer
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =pandoc= to the existing =dotspacemacs-configuration-layers= list in this
file.
** Pandoc
To use the mode please [[http://pandoc.org/installing.html][install]] pandoc first.
* Usage
For a full list of possible conversions see the [[http://johnmacfarlane.net/pandoc][Pandoc documentation]].
An explanation of all the options offered by =pandoc-mode= can be found at the
[[http://joostkremers.github.io/pandoc-mode][Pandoc-mode website]].
* Key Bindings
| Key Binding | Description |
|-------------+---------------------------------|
| ~SPC P /~ | Start pandoc-mode and open menu |