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
- 2024
- Reinstalling Windows at 1am
- SQLite DB Migrations with PRAGMA user_version
- My Custom Miniflux CSS Theme
- How to Disable Wayland in Debian Testing
Recent Favorite Blog Posts
This is a collection of the last 8 posts that I bookmarked.
- Give Your Spouse the Gift of a Couple's Email Domain from mtlynch.io
- Skip the Next iPhone from Articles on Jose M.
- Have smart glasses finally hit an inflection point? from The Torment Nexus
- The McPhee method from the jsomers.net blog
- Pluralistic: LLMs are slot-machines (16 Aug 2025) from Pluralistic: Daily links from Cory Doctorow
- Pluralistic: Bluesky creates the world's weirdest, hardest-to-understand binding arbitration clause (15 Aug 2025) from Pluralistic: Daily links from Cory Doctorow
- Just a Little More Context Bro, I Promise, and It’ll Fix Everything from Jim Nielsen’s Blog
- The Futzing Fraction from Deciphering Glyph
Articles from blogs I follow around the net
If you’re like me; you like files, you like web technologies like HTML, CSS, and JavaScript, you like markdown, you like kanban, you like pomodoro, and you like apps. If this sounds like you reach out. I’ll be open sourcing something in the coming weeks a…
via Colin Devroe September 3, 2025Pluralistic: The worst possible antitrust outcome (03 Sep 2025)
Today's links The worst possible antitrust outcome: Hope you like enshittification. Hey look at this: Delights to delectate. Object permanence: Amazon drivers hang phones from trees; DVD Jon v Windows DRM; Chevron's dirty tricks. Upcoming appearan…
via Pluralistic: Daily links from Cory Doctorow September 3, 2025Give a Problem. Grow a Programmer.
In 2009, I kicked off my senior year in college with a class that ultimately changed the way I thought about my degree—and my future.
via flower.codes September 3, 2025Generated by openring