projects
/
pelican-mode.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Explain what Pelican is.
[pelican-mode.git]
/
README.md
diff --git
a/README.md
b/README.md
index
8137411
..
36bddfc
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-1,8
+1,8
@@
pelican-mode is an Emacs minor mode for editing pages and posts in
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
something like it. In particular it assumes:
* The existence of `pelicanconf.py` and `Makefile` in some ancestor
@@
-11,13
+11,7
@@
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.
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
## Quick Guide
@@
-27,19
+21,22
@@
It also enforces some parts of my preferred Pelican configuration:
* `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`)
* `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
## 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
## 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
[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