Using org-mode with Jekyll
Since my journey into Google Docs’s Hell I have been getting more reacquainted with org-mode for other purposes as well. Traditionally, I have been writing this blog using Markdown and publishing it with Jekyll. I love Markdown, and while it is fine for most cases, but what better way to gain more experience with org-mode than to blog with it! The best tutorial that I have found so far is this one from the org mode web site: Using org to Blog with Jekyll. One “gotcha” that I have ran into so far, is everything breaking if I include a table of contents (which happens by default when you export to HTML). The simplest solution for this is to add the following to the top of your org flavored file.
#+OPTIONS: toc:nil
This allows the front-matter to be exported properly. I am also choosing not to include section numbering for my posts. So the complete front-matter for this post looks like this:
#+OPTIONS: toc:nil num:nil
#+BEGIN_HTML
---
layout: post
title: "Using org-mode with Jekyll"
permalink: /:title/
tags: hacking
---
#+END_HTML
Configuration
;; File ~/.emacs.d/customizations/setup-org.el
;; ...
;;;;
;; Projects
;;;;
;; levlaz.org Blog
(setq org-publish-project-alist
'(("levlaz"
;; Path to org files.
:base-directory "~/git/levlaz.org/_org"
:base-extension "org"
;; Path to Jekyll Posts
:publishing-directory "~/git/levlaz.org/_posts/2016/"
:recursive t
:publishing-function org-html-publish-to-html
:headline-levels 4
:html-extension "html"
:body-only t
)))
Workflow
- Add a new file to
git/levlaz.org/_org/$DATE-$TITLE.org
- Add the front matter shown above
- Blog my heart out
- Check my spelling with
ispell
- Publish the org file with
C-c C-e P p
, this moves the file fromgit/levlaz.org/_org/
to/git/levlaz.org/_posts/2016/$DATE-$TITLE.html
- Build and Deploy my site with my Rakefile:
rake deploy
.
Conclusion
Thank you for reading! Share your thoughts with me on bluesky, mastodon, or via email.
Check out some more stuff to read down below.
Most popular posts this month
- Setting up ANTLR4 on Windows
- Meritocracy?
- Possible Plagiarism Made me Cringe
- SQLite DB Migrations with PRAGMA user_version
- Using Plex with Nextcloud
Recent Favorite Blog Posts
This is a collection of the last 8 posts that I bookmarked.
- The Rise of Bluesky from Communications of the ACM
- Podcaster, DJ, and writer DJ Louie XIV on going for it (even if you’re terrified) from The Creative Independent
- Useful Bluesky Tools from Robb Knight • Posts • Atom Feed
- Re: Bluesky from Colin Devroe
- From the Red Hell to the Sky of Blue from Straphanger
- We don’t need to use what we make from Derek Sivers blog
- Ubuntu Summit 2024: A joyful experience filled with sorrow from Planet KDE | English
- Sabotage from jwz
Articles from blogs I follow around the net
13/12/2024
# I can't believe it's been over a month since the last post. Not very good for someone who's supposed to be back. Still, I've also been struggling to get back to making music again; I've had a couple of ideas and put them on SoundClou…
via Colin Walker - Daily Feed December 18, 2024Christmas with Grubbs – an animated holiday special I worked on that you and your kids will love.
I am part of an animated holiday special and you can watch it on YouTube for free! Christmas With Grubbs is an animated holiday special based on Max Weaver's comic. It's about a little boy and his imaginary friend who get into all sorts of mischie…
via WIL WHEATON dot NET December 17, 2024Businessweek: Crypto Got What It Wanted in November’s Election. Now What?
The industry is now in a position to weaken financial rules that might protect consumers from the next crypto crash.
via Citation Needed December 17, 2024