Org-jekyll-mode WIKI

中文介绍

Introduction

org-jekyll-mode is an emacs plugins which can easily create org-mode file which name like jekyll posts format and publish org-mode files to standard jekyll posts. org-jekyll-mode also support user to control their post’s yaml front matter values in org-mode files.

Installation

To install this plugins, just clone the source code from github.

git clone https://github.com/jsuper/org-jekyll-mode.git   

Then, add org-jekyll-mode to your load-path and enable it.

(add-to-list 'load-path "path-to org-jekyll-mode")   
(require 'org-jekyll-mode)
(org-jekyll-mode)

Before you use it, you should settings some variables. Please see below section

Variables in org-jekyll-mode

All these variables can be setted by M-x customize

org-jekyll/org-mode-project-root [MUST BE SETTED]

This variable store your org-mode project path, each files create by org- jekyll-mode will store in this folder. It’s must be setted.

org-jekyll/jekyll-project-root [MUST BE SETTED]

This var descibes your jekyll blog root path. Must be setted.

org-jekyll/org-mode-static-files-folder-name

This variable is used to store your folder name which you used to store org-mode static files. Which means all your static files are in an folder , e.g: I like to put all my static files in “org-mode-project-root/assets” , so I will set this variable’s value to “assets”

org-jekyll/export-with-toc

This variable is used to tell org-jekyll whether should export table of content for current file, default value is nil

org-jekyll/headlines-level

Define the headline level for export toc, defualt value is 2.

org-jekyll/default-post-layout

Define the default layout of export posts, default value is “post”

org-jekyll/html-link-home

Define your site home, default is “/”, if you have a custom site home like “/blog”, so you can set this variable.

org-jekyll/yaml-list-value-sperator

Define the value seprator of yaml front matter in org-mode files, default is “;”

org-jekyll/org-mode-static-extensions

Define the static file extensions, if you want to add new extension in it, please use add-to-list or append

org-jekyll/yaml-front-matter-keywords

Define the jekyll yaml-front-matter, please never change its value.

Any other variables you can get it’s description like this: `C-h v org-jekyll TAB`

Key bindings in org-jekyll-mode

[C-c C-n] Create an post with no timestamp prefix

[C-c C-d] Create an post with timestamp prefix

[C-c C-p] Publish current files in org-mode-project to your posts

Jekyll yaml front matter support

org-jekyll-mode support all jekyll blog yaml front matter. To ensure there is no conflicts with org-mode intrinsic keywords we add prefix to yaml front matter, for example:

If you want to setting the post layout in org-mode files, you can do it like this:

#+YAML/LAYOUT: post

As the previous example, all yaml font matter in org-mode files should be start with #+YAML/