From: "Łukasz Stelmach" <stlman@poczta.fm>
To: emacs-orgmode@gnu.org
Cc: "Łukasz Stelmach" <stlman@poczta.fm>
Subject: [RFC] Add new export backend for Jekyll
Date: Sat, 17 Mar 2018 22:45:28 +0100 [thread overview]
Message-ID: <20180317214528.16908-1-stlman@poczta.fm> (raw)
Jekyll[1] is a static site genrator. Its most notable deployment are
Github Pages. It accepts several input formats including HTML, that
is why ox-jekyll is derived from ox-html. Input files for Jekyll must
be HTML files without any site-specific elements (e.g. menus, headers,
sidebars), because Jekyll will add them. The HTML code, however, must
be prepended with a piece of YAML code which specifies:
+ page title,
+ page category,
+ layout template to use for the page,
+ publication date.
The main task of ox-jekyll is to read Org '#+KEYWORDS' and output them as
Jekyll's front matter. At this point also source code blocks are exported
inside special tags instead of html <pre></pre>.
[1] http://jekyllrb.com/
Signed-off-by: Łukasz Stelmach <stlman@poczta.fm>
---
This is kind of work-in-progress version. "Kind of" because it satisfies
my needs and I would like to ask what others think or need.
How to test this module?
Please comment.
lisp/ox-jekyll.el | 139 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 139 insertions(+)
create mode 100644 lisp/ox-jekyll.el
diff --git a/lisp/ox-jekyll.el b/lisp/ox-jekyll.el
new file mode 100644
index 000000000..273792ba9
--- /dev/null
+++ b/lisp/ox-jekyll.el
@@ -0,0 +1,139 @@
+;;; ox-jekyll.el --- Export org files to Jekyll static site generator
+
+;; Copyright (C) 2011-2015 Free Software Foundation, Inc.
+
+;; Author: Łukasz Stelmach <stlman at poczta dot fm>
+;; Keywords:
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs 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.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This library implements a backend to export Org files as HTML
+;; for further processing by Jekyll static site generator.
+;; See Org manual for more information.
+
+;;; Code:
+
+;;; Dependencies
+
+(require 'ox)
+
+;;; Define Back-End
+
+(org-export-define-derived-backend 'jekyll 'html
+ :menu-entry
+ '(?h 1
+ ((?J "As HTML buffer (Jekyll)" org-jekyll-export-as-html)
+ (?j "As HTML file (Jekyll)" org-jekyll-export-to-html)))
+
+ :translate-alist
+ '((template . org-jekyll-html-template)
+ (src-block . org-jekyll-html-src-block))
+
+ :options-alist
+ '((:jekyll-layout "LAYOUT" nil "post" t)
+ (:jekyll-categories "CATEGORIES" nil nil t))
+ ;; TODO: tags, as soon as I learn how they differ from categories
+ ;; https://github.com/jekyll/jekyll/issues/6853
+ )
+
+(defun org-jekyll-export-as-html
+ "TODO: Doc"
+ (&optional async subtreep visible-only body-only ext-plist)
+ (interactive)
+ (org-export-to-buffer 'jekyll "*Org JEKYLL Export*"
+ async subtreep visible-only body-only ext-plist (lambda () (html-mode))))
+
+(defun org-jekyll-export-to-html
+ "TODO: Doc"
+ (&optional async subtreep visible-only body-only ext-plist)
+ (interactive)
+ (let ((file (org-export-output-file-name ".html" subtreep)))
+ (org-export-to-file 'beamer file
+ async subtreep visible-only body-only ext-plist)))
+
+(defun org-jekyll-html-src-block (src-block contents info)
+ "Transcode a SRC-BLOCK element from Org to a highlight block for Jekyll.
+CONTENTS holds the contents of the item. INFO is a plist holding
+contextual information."
+ (message "org-jekyll-html-src-block")
+ (if (org-export-read-attribute :attr_html src-block :textarea)
+ (org-html--textarea-block src-block)
+ (let ((lang (org-element-property :language src-block))
+ (caption (org-export-get-caption src-block))
+ (code (org-html-format-code src-block info))
+ (label (let ((lbl (org-element-property :name src-block)))
+ (if (not lbl) ""
+ (format " id=\"%s\""
+ (org-export-solidify-link-text lbl))))))
+ (if (not lang) (format "<pre class=\"example\"%s>\n%s</pre>" label code)
+ (format
+ "<div class=\"org-src-container\">\n%s%s\n</div>"
+ (if (not caption) ""
+ (format "<label class=\"org-src-name\">%s</label>"
+ (org-export-data caption info)))
+ (format "\n{%% highlight %s %%}\n%s{%% endhighlight %%}" lang code))))))
+
+(defun org-jekyll-html-template (contents info)
+ "Return complete document for Jekyll, i.e. the HTML contents
+without the <head> and <body> tags but prepended with a front
+matter for Jekyll."
+ (let ((title (org-export-data (plist-get info :title) info))
+ (date (org-export-data (plist-get info :date) info))
+ (categories (org-export-data (plist-get info :jekyll-categories) info))
+ (now (format-time-string "%FT%T%z" (current-time)))
+ last_mod)
+ (setq last_mod (if (and (stringp date) (/= 0 (length date)))
+ now
+ nil))
+ (setq date (if (and (stringp date) (/= 0 (length date)))
+ date
+ (with-current-buffer (plist-get info :input-buffer)
+ (save-excursion
+ (goto-char (point-min))
+ (insert "#+DATE: " now "\n")))
+ now))
+ (concat
+ (format
+ "---
+title: %s
+date: %s
+layout: %s
+%s%s---\n"
+ title date (plist-get info :jekyll-layout)
+ (if (< 0 (length categories))
+ (concat "categories:\n - "
+ (mapconcat 'identity
+ (split-string categories "," t "\\s-+")
+ "\n - ")
+ "\n")
+ "")
+ (when last_mod (concat "last_modified_at: " last_mod "\n")))
+ contents)))
+
+(defun org-html-publish-to-jekyll-html (plist filename pub-dir)
+ "Publish an org file to HTML for postprocessing in Jekyll.
+
+FILENAME is the filename of the Org file to be published. PLIST
+is the property list for the given project. PUB-DIR is the
+publishing directory.
+
+Return output file name."
+ (org-publish-org-to 'jekyll filename
+ (concat "." (or (plist-get plist :html-extension)
+ org-html-extension "html"))
+ plist pub-dir))
--
2.11.0
next reply other threads:[~2018-03-17 21:45 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-17 21:45 Łukasz Stelmach [this message]
2018-03-18 15:17 ` [RFC] Add new export backend for Jekyll Grant Rettke
2018-04-26 23:34 ` Bastien
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180317214528.16908-1-stlman@poczta.fm \
--to=stlman@poczta.fm \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).