X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=README.md;h=65c21d4a86b4b064a79a4976aec8c1df782d0ec2;hp=a0e13bdc96a833c6cc19135516865eabbc10ebcf;hb=209ad24318e1f28675da430aa10ef3467694b9ac;hpb=677ddbc98da226c94f29adbe7be3657956dd4d58 diff --git a/README.md b/README.md index a0e13bd..65c21d4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -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 a major mode for the Pelican @@ -18,18 +18,30 @@ AsciiDoc, and Org. It also assumes you've set up Pelican with To enable by default on all text files in a Pelican site: - (require 'pelican-mode) - (pelican-global-mode) +``` emacs-lisp +(require 'pelican-mode) +(pelican-global-mode) +``` + + +Or with `use-package` and deferred loading: + +``` emacs-lisp +(use-package pelican-mode + :demand :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 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 u` - Upload a site using rsync (equivalent to `make rsync_upload`) +* `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