1 pelican-mode is an Emacs minor mode for editing articles and pages in
4 It's intended to be used alongside a major mode for the Pelican
5 document. Currently supported formats are Markdown, reStructuredText,
6 AsciiDoc, and Org. It also assumes you've set up Pelican with
7 `pelican-quickstart` or something like it. In particular it expects:
9 * The existence of `pelicanconf.py` and `Makefile` in some ancestor
11 * The first component of the path (e.g. `content`) after that
12 ancestor is irrelevant.
13 * If the next component is `pages`, that indicates a static page
14 rather than a dated post.
19 To enable by default on all text files in a Pelican site:
22 (require 'pelican-mode)
27 Or with `use-package` and deferred loading:
30 (use-package pelican-mode
31 :demand :after (:any org rst markdown-mode adoc-mode)
33 (pelican-global-mode))
36 Or, register `pelican-mode` or `pelican-mode-enable-if-site`
37 as hook functions for more direct control.
39 * `C-c = d` - Update the document’s date
40 * `C-c = f` - Set a metadata field (title, category, etc.)
41 * `C-c = h` - Generate HTML output for a site (equivalent to `make html`)
42 * `C-c = n` - Insert a post or page header
43 * `C-c = p` - Remove draft status from a post (i.e. publish it)
44 * `C-c = u` - Upload a site using rsync (equivalent to `make rsync_upload`)
45 * `C-c = g` - Upload a site to GitHub Pages (equivalent to `make github`)
50 If the commands which invoke `make` can find the Makefile but can't
51 find `pelican`, your `exec-path` may not be set right. Try out
52 [exec-path-from-shell][].
57 This program is free software; you can redistribute it and/or modify
58 it under the terms of the GNU General Public License as published by
59 the Free Software Foundation, either version 3 of the License, or (at
60 your option) any later version.
62 [Pelican]: http://getpelican.com/
63 [markdown-mode]: http://jblevins.org/projects/markdown-mode/
64 [rst-mode]: http://docutils.sourceforge.net/docs/user/emacs.html
65 [exec-path-from-shell]: https://github.com/purcell/exec-path-from-shell