README.md

   1 # pelican-mode
   2
   3 pelican-mode is a minor mode for editing pages and posts in [Pelican]
   4 sites. It's intended to be used alongside [markdown-mode] or
   5 [rst-mode].
   6
   7 It also assumes you've set up Pelican with `pelican-quickstart` or
   8 something like it. In particular it assumes:
   9
  10  * The existence of `pelicanconf.py` and `Makefile` in some ancestor
  11    directory.
  12  * The first component of the path (e.g. `content`) after that
  13    ancestor is irrelevant.
  14  * If the next component is `pages`, that indicates a static page
  15    rather than a dated post.
  16
  17 It also enforces some parts of my preferred Pelican configuration:
  18
  19  * Categories are never provided (you can have one if you want, but
  20    the default interactive commands don't provide one).
  21  * Tags are always provided.
  22  * Slugs are explicit, and include nested subdirectories.
  23
  24 ## Quick Guide
  25
  26 * `C-x p n` - Insert a post or page header
  27 * `C-x p p` - Remove draft status from a post (i.e. publish it)
  28 * `C-x p t` - Update the date field in a post/page header
  29 * `C-x p h` - Generate HTML output for a site (equivalent to `make html`)
  30 * `C-x p u` - Upload a site using rsync (equivalent to `make rsync_upload`)
  31
  32 ## Troubleshooting
  33
  34 If the commands which invoke `make` can find the Makefile but can't
  35 find `pelican`, your `exec-path` may not be set right. Try out
  36 [exec-path-from-shell].
  37
  38 ## License
  39
  40 This code is released into the public domain via the
  41 [CC0 Public Domain Dedication][0].
  42
  43  [Pelican]: http://getpelican.com/
  44  [markdown-mode]: http://jblevins.org/projects/markdown-mode/
  45  [rst-mode]: http://docutils.sourceforge.net/docs/user/emacs.html
  46  [exec-path-from-shell]: https://github.com/purcell/exec-path-from-shell
  47  [0]: http://creativecommons.org/publicdomain/zero/1.0/legalcode