-pelican-mode is an Emacs minor mode for editing pages and posts in
+pelican-mode is an Emacs minor mode for editing articles and pages 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.
## Quick Guide
-* `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`)
+To enable by default on all text files in a Pelican site:
+
+``` emacs-lisp
+(require 'pelican-mode)
+(pelican-global-mode)
+```
+
+
+Or with `use-package` and deferred loading:
+
+``` emacs-lisp
+(use-package pelican-mode
+ :after (:any org rst markdown-mode adoc-mode)
+ :config
+ (pelican-global-mode))
+```
+
+Or, register `pelican-mode` or `pelican-mode-enable-if-site`
+as hook functions for more direct control.
+
+* `C-c = d` - Update the document’s date
+* `C-c = f` - Set a metadata field (title, category, etc.)
+* `C-c = h` - Generate HTML output for a site (equivalent to `make html`)
+* `C-c = n` - Insert a post or page header
+* `C-c = p` - Remove draft status from a post (i.e. publish it)
+* `C-c = u` - Upload a site using rsync (equivalent to `make rsync_upload`)
## Troubleshooting
projects / pelican-mode.git / blobdiff