Some documentation.
[pelican-mode.git] / README.md
1 pelican-mode is an Emacs minor mode for editing pages and posts in
2 [Pelican][] sites.
3
4 It's intended to be used alongside [markdown-mode][] or [rst-mode][].
5 It also assumes you've set up Pelican with `pelican-quickstart` or
6 something like it. In particular it assumes:
7
8 * The existence of `pelicanconf.py` and `Makefile` in some ancestor
9 directory.
10 * The first component of the path (e.g. `content`) after that
11 ancestor is irrelevant.
12 * If the next component is `pages`, that indicates a static page
13 rather than a dated post.
14
15
16 ## Quick Guide
17
18 * `C-c P n` - Insert a post or page header
19 * `C-c P p` - Remove draft status from a post (i.e. publish it)
20 * `C-c P t` - Update the date field in a post/page header
21 * `C-c P h` - Generate HTML output for a site (equivalent to `make html`)
22 * `C-c P u` - Upload a site using rsync (equivalent to `make rsync_upload`)
23
24
25 ## Troubleshooting
26
27 If the commands which invoke `make` can find the Makefile but can't
28 find `pelican`, your `exec-path` may not be set right. Try out
29 [exec-path-from-shell][].
30
31
32 ## License
33
34 This program is free software; you can redistribute it and/or modify
35 it under the terms of the GNU General Public License as published by
36 the Free Software Foundation, either version 3 of the License, or (at
37 your option) any later version.
38
39 [Pelican]: http://getpelican.com/
40 [markdown-mode]: http://jblevins.org/projects/markdown-mode/
41 [rst-mode]: http://docutils.sourceforge.net/docs/user/emacs.html
42 [exec-path-from-shell]: https://github.com/purcell/exec-path-from-shell