X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=README.md;h=e29499dc234944af92bcee2273bb4df3be97325d;hp=9463fe764fcda0445315eb8ff0f23985d05da351;hb=0eeee74fd9a459dd8c04c264c183d80f2d2b98b2;hpb=fdfb3a275949d1923df471312789e0f7d8bc530a diff --git a/README.md b/README.md index 9463fe7..e29499d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ -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. @@ -11,14 +12,23 @@ something like it. In particular it assumes: 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`)