pelican-mode is an Emacs minor mode for editing pages and posts in
[Pelican][] sites.
-It's intended to be used alongside [markdown-mode][] or [rst-mode][].
-It also assumes you've set up Pelican with `pelican-quickstart` or
-something like it. In particular it assumes:
+It's intended to be used alongside a major mode for the Pelican
+document. Currently supported formats are Markdown, reStructuredText,
+AsciiDoc, and Org. It also assumes you've set up Pelican with
+`pelican-quickstart` or something like it. In particular it expects:
* The existence of `pelicanconf.py` and `Makefile` in some ancestor
directory.
ancestor is irrelevant.
* If the next component is `pages`, that indicates a static page
rather than a dated post.
-
+
## Quick Guide
+To enable by default on all text files in a Pelican site:
+
+ (require 'pelican-mode)
+ (pelican-global-mode)
+
+Or, register `pelican-mode` or `pelican-mode-enable-if-site`
+as hook functions for more direct control.
+
+* `C-c P d` - Update the document’s date
+* `C-c P f` - Set a metadata field (title, category, etc.)
+* `C-c P h` - Generate HTML output for a site (equivalent to `make html`)
* `C-c P n` - Insert a post or page header
* `C-c P p` - Remove draft status from a post (i.e. publish it)
-* `C-c P t` - Update the date field in a post/page header
-* `C-c P h` - Generate HTML output for a site (equivalent to `make html`)
* `C-c P u` - Upload a site using rsync (equivalent to `make rsync_upload`)