X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=README.md;h=0869e4b1afd8d9d867802fff52d11f1affc75481;hp=8b365cb8e7042e9ea5eec08aa9c1c8a150158b4c;hb=4dfce47d66561680157026878202ec60f81b4cee;hpb=3315a18243301484682db5648146579430001772 diff --git a/README.md b/README.md index 8b365cb..0869e4b 100644 --- a/README.md +++ b/README.md @@ -11,28 +11,33 @@ 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. - -It also enforces some parts of my preferred Pelican configuration: - * Categories are never provided (you can have one if you want, but - the default interactive commands don't provide one). - * Tags are always provided. - * Slugs are explicit, and include nested subdirectories. ## 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`) + ## Troubleshooting If the commands which invoke `make` can find the Makefile but can't find `pelican`, your `exec-path` may not be set right. Try out [exec-path-from-shell][]. + ## License This program is free software; you can redistribute it and/or modify