;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
+
;;; Commentary:
;;
-;; Probably, this doesn't handle a lot of error cases. I also never
-;; tested it on networked drives and the lookup for pelicanconf.py
-;; might slow it down considerably.
+;; pelican-mode is an Emacs minor mode for editing pages and posts in
+;; Pelican sites. Pelican is a static site generator which can
+;; process a variety of text file formats. For more information, see
+;; URL https://blog.getpelican.com/.
+;;
+;; 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 directory.
+;; * The first component of the path (e.g. ``content'') after that
+;; ancestor is irrelevant.
+;; * If the next component is ``pages'', that indicates a page
+;; rather than an article.
;;; Code:
(require 'subr-x)
(defgroup pelican-mode nil
- "Support for Pelican articles and pages."
+ "Support for Pelican articles and pages.
+
+For more information about Pelican see URL https://blog.getpelican.com/."
:group 'convenience)
(defcustom pelican-mode-default-page-fields
See the documentation for `pelican-mode-set-field' for more information
about metadata fields and special values."
- :group 'pelican
+ :group 'pelican-mode
:type '(plist))
(defcustom pelican-mode-default-article-fields
See the documentation for `pelican-mode-set-field' for more information
about metadata fields and special values."
- :group 'pelican
+ :group 'pelican-mode
:type '(plist))
-(defcustom pelican-mode-set-field-alist
+(defcustom pelican-mode-formats
'((markdown-mode . pelican-mode-set-field-markdown-mode)
+ (adoc-mode . pelican-mode-set-field-adoc-mode)
(rst-mode . pelican-mode-set-field-rst-mode))
"Functions to handle setting metadata, based on major mode.
This association list maps modes to functions that take two
arguments, field and value strings."
- :group 'pelican
+ :group 'pelican-mode
:type '(alist :key-type function :value-type function))
(defun pelican-mode-timestamp (&optional time)
(replace-match header)
(insert header)))
(let ((text (when value (format ":%s: %s\n" field value))))
- (when (re-search-forward "^#" nil t)
- (forward-line 2))
+ (when (looking-at "^.*\n#")
+ (forward-line 3))
(if (re-search-forward (format "^:%s:.*\n" (regexp-quote field)) nil t)
(replace-match (or text ""))
(when text
(replace-match text)
(insert text))))))
+(defun pelican-mode-set-field-adoc-mode (field value)
+ "Set AsciiDoc metadata FIELD to VALUE."
+ (setq field (downcase field))
+ (if (equal field "title")
+ (let ((header (format "= %s\n\n" value)))
+ (if (looking-at "= .*\n\n+")
+ (replace-match header)
+ (insert header)))
+ (let ((text (when value (format ":%s: %s\n" field value))))
+ (when (looking-at "^=")
+ (forward-line 2))
+ (if (re-search-forward (format "^:%s:.*\n" (regexp-quote field)) nil t)
+ (replace-match (or text ""))
+ (when text
+ (if (re-search-forward "^$" nil t)
+ (replace-match text)
+ (insert text)))))))
+
(defun pelican-mode-set-field (field value)
"Set FIELD to VALUE.
(when (symbolp field)
(setq field (string-remove-prefix ":" (symbol-name field))))
(let ((set-field
- (assoc-default nil pelican-mode-set-field-alist #'derived-mode-p)))
+ (assoc-default nil pelican-mode-formats #'derived-mode-p)))
(unless set-field
(error "Unsupported major mode %S" major-mode))
(save-excursion
(when-let (file-name (file-name-sans-extension buffer-file-name))
(file-name-base file-name))))
-(defun pelican-mode-find-in-parents (file-name)
- "Find FILE-NAME in the default directory or one of its parents, or nil."
- (let* ((parent (expand-file-name default-directory)))
- (while (and (not (file-readable-p (concat parent file-name)))
- (not (string= parent (directory-file-name parent))))
- (setq parent (file-name-directory (directory-file-name parent))))
- (let ((found (concat parent file-name)))
- (if (file-readable-p found) found nil))))
-
(defun pelican-mode-find-root ()
"Return the root of the buffer's Pelican site, or nil."
- (when-let (conf (pelican-mode-find-in-parents "pelicanconf.py"))
- (file-name-directory conf)))
+ (locate-dominating-file default-directory "pelicanconf.py"))
(defun pelican-make (target)
"Execute TARGET in a Makefile at the root of the site."
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
+Pelican is a static site generator which can process a variety of
+text file formats. For more information, see URL
+https://blog.getpelican.com/.
+
When Pelican mode is enabled, additional commands are available
for editing articles or pages:
positive, and disable it otherwise. If called from Lisp, enable
the mode if ARG is omitted or nil.
+Pelican is a static site generator which can process a variety of
+text file formats. For more information, see URL
+https://blog.getpelican.com/.
+
When Pelican global mode is enabled, text files which seem to
be part of a Pelican site will have `pelican-mode' automatically
enabled.
or add `pelican-mode-enable-if-site' to more specific mode
hooks."
:global t
- :group 'pelican
+ :group 'pelican-mode
(if pelican-global-mode
(add-hook 'text-mode-hook #'pelican-mode-enable-if-site)
(remove-hook 'text-mode-hook #'pelican-mode-enable-if-site)))
projects / pelican-mode.git / blobdiff