1 Blog in Org2jekyll - 3. About the Jekyll theme used in this blog
This post is part 3 of a short series about writing in org mode using org2jekyll.
The Jekyll theme on this page is slightly modified from the original jekyll clean theme. If you like the theme, you can use it from this blog, or from the original site https://github.com/scotte/jekyll-clean
The theme (optionally) uses Disqus for comments and (optionally) includes Google Analytics. Both are off by default, and can be changed in config.yml
To use this theme for a blog, look at the Jekyll docs and the original site https://github.com/scotte/jekyll-clean. Here are a few notes about about which files can be kept, modified, or removed for a reuse.
- You can generally keep the following directories and
.html
files. They are mostly Liquid language sections (Liquid templates), linked from the front page or used to build pages and posts (from files in the _layouts directory).- Files to keep or modify:
index.html
is the blog "front page". keep this file as it is the Liquid template that builds the front page by querying what blogs are out there.about.html
archive.html
links.html
- Directories and contents to keep or modify:
_layouts
- contains files such as
post.html
andpage.html
. These files define the top level structure of your blog pages or web sites. If you create a org file namedorg/a-test-blog.org
and give it#+LAYOUT: post
, then the result post is created frompost.html
, substituting{ { content } }
tag in thepost.html
with_posts/a-test-blog.html
(_posts/a-test-blog.html
is first created byorg2jekyll-publish-posts
from the org file with same name). In the process, Jekyll transforms and injects files from the_includes
directory, if so directed by the layout filepost.html
.
- contains files such as
_includes
- is the directory where all files mentioned in include tag markup should be located - files used in includes such as
{ % include included-file.html % }
(with the space before / after the percentage removed; jekyll refuses publish a valid include markup)
- is the directory where all files mentioned in include tag markup should be located - files used in includes such as
images
todojs
todoLICENSE
- Files to keep or modify:
- For making your own blog, you may want to generally remove content of the following directories on the top level, but keep the directory nodes:
org
- directory where you write your posts and pages in org format (manually, or supported by
org2jekyll-create-draft
)
- directory where you write your posts and pages in org format (manually, or supported by
_posts
- is a directory with:
.html
files exported from.org
files by commandorg2jekyll-publish-pages
- Also, if you want to write your posts in markdown, you write them here as
.md
- is a directory with:
_site
- is a directory with
.html
files created byjekyll build
. Files here are built byjekyll build
from the following files.html
files and md files on the top level (e.g. index.html Liquid template file on top level is converted to _site/index.html which contains only html markup).org
files from theorg
directory
- is a directory with
Hopefully this is of some use in starting to use a jekyll theme.