X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=README.md;h=8bbca6af6e6578e93f87b155608275e6fd72e22d;hp=0869e4b1afd8d9d867802fff52d11f1affc75481;hb=9bc77986bbc61389013030294e2036b8d8bb1ed3;hpb=2442f07f94c4b90bceae26d04fa593d3a9eba3ff diff --git a/README.md b/README.md index 0869e4b..8bbca6a 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. @@ -17,8 +18,19 @@ something like it. In particular it assumes: 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 + :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.