X-Git-Url: https://git.korewanetadesu.com/?p=pelican-mode.git;a=blobdiff_plain;f=README.md;h=0869e4b1afd8d9d867802fff52d11f1affc75481;hp=8137411501ff867769e7d9176b091333977e702c;hb=4dfce47d66561680157026878202ec60f81b4cee;hpb=995804fabef0a6b4bd71b7f264550f177d599dae diff --git a/README.md b/README.md index 8137411..0869e4b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ pelican-mode is an Emacs minor mode for editing pages and posts in -[Pelican] sites. +[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 +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: * The existence of `pelicanconf.py` and `Makefile` in some ancestor @@ -11,35 +11,41 @@ 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]. +[exec-path-from-shell][]. + ## License -This code is released into the public domain via the -[CC0 Public Domain Dedication][0]. +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or (at +your option) any later version. [Pelican]: http://getpelican.com/ [markdown-mode]: http://jblevins.org/projects/markdown-mode/ [rst-mode]: http://docutils.sourceforge.net/docs/user/emacs.html [exec-path-from-shell]: https://github.com/purcell/exec-path-from-shell - [0]: http://creativecommons.org/publicdomain/zero/1.0/legalcode