From 9bd1bc0c098b7f3e9d556e61a3d65e68e6ce48bd Mon Sep 17 00:00:00 2001 From: Joe Wreschnig Date: Mon, 7 Aug 2017 12:53:01 +0200 Subject: [PATCH] Add some usage notes. --- README.md | 11 ++++++++++- pelican-mode.el | 8 ++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 36bddfc..8ab9c6a 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,19 @@ something like it. In particular it assumes: ## 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 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`) diff --git a/pelican-mode.el b/pelican-mode.el index 1d8885e..bfd0ea6 100644 --- a/pelican-mode.el +++ b/pelican-mode.el @@ -38,6 +38,14 @@ ;; ancestor is irrelevant. ;; * If the next component is ``pages'', that indicates a page ;; rather than an article. +;; +;; 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. ;;; Code: -- 2.20.1