From df01c9a46333fce22b04ef076b308ceacec429f9 Mon Sep 17 00:00:00 2001 From: mattkae Date: Tue, 20 Jun 2023 11:51:17 -0400 Subject: One minor cleanup --- posts/hello.html | 83 +++++++++++++++++++++++++++--------------------------- posts/sitemap.html | 4 +-- 2 files changed, 44 insertions(+), 43 deletions(-) (limited to 'posts') diff --git a/posts/hello.html b/posts/hello.html index b1fb9a4..ea52aaa 100644 --- a/posts/hello.html +++ b/posts/hello.html @@ -28,9 +28,9 @@ -
-

TLDR

-
+
+

TLDR

+
-
-

Introduction

-
+
+

Introduction

+

I've recently fallen in love with org-mode, specifically when I use it with org-roam. I find the whole workflow of creating, tagging, and - later on - searching for information on my computer to be very elegant. On top of that, now that I have the time, I want to begin writing blog posts to better work out my thoughts. With both of these things in mind, I am again turning to the universal tool for human prospering: org-mode. This time, I want to see how it can help me turn a simple org file into a blog post on my website. My requirements are:

  1. Org files must get published to HTML files in a particular format with a preset stylesheet
    2. -
  2. Code blocks with code highlighting
    3. +
  3. Code blocks must include code highlighting
  4. Images must be supported
  5. Posts must be timestamped with the creation date next to the title
    6. -
  6. Generate a high-level "directory" page with all of the posts by order of creation
    7. -
  7. Posts should be able to have tags that will be used to filter content
    8. +
  8. A high-level "directory" page should be generated containing a list of the posts ordered chronologically with the newest at the top
    9. +
  9. Posts should have tags that can be used for filtering and search.

@@ -71,9 +71,9 @@ And that's pretty much it for now. Without further ado, let's jump into getting

-
-

Basic HTML File

-
+
+

Basic HTML File

+

As a pilot, we are going to use this org file that I am currently writing (hello.org) as our guinea pig. The goal is to have this org file be our very first blog post.

@@ -114,9 +114,9 @@ We then do a chmod +x publish.sh to make it an executable and run i
-
-

Disabling features that we don't want

-
+
+

Disabling features that we don't want

+

The next thing will be to remove some of the generated items that I didn't ask for, namely the table of contents, author, section numbers, creation time stamp, and the validation link.

@@ -134,7 +134,8 @@ The next thing will be to remove some of the generated items that I didn't ask f :with-toc nil ; Disable table of contents :with-author nil ; Disable author :section-numbers nil ; Disable section numbers - :time-stamp-file))) ; Disable timestamp + :time-stamp-file nil ; Disable timestamp + :with-date nil))) ; Disable date (setq org-html-validation-link nil) ; Disable the validation link at the bottom @@ -145,9 +146,9 @@ The next thing will be to remove some of the generated items that I didn't ask f
-
-

Styling & Code Highlighting

-
+
+

Styling & Code Highlighting

+

Next thing on our list is custom styling. This can be achieved by first installing the htmlize package from melpa / elpa. The EmacsWiki describes this as "a package for exporting the contents of an Emacs buffer to HTML while respecting display properties such as colors, fonts, underlining, invisibility, etc" (reference). If used "out-of-the-box", the buffer will be exported to HTML with all of the styles inlined (e.g. if you underline something in your org file, you will generate a <span style="text-decoration: underline">...</span>). However, we are more interested in styling everything by ourselves: we don't want htmlize making assumptions about what underlining means to us! Luckily, htmlize gives us the option to export with class names instead of inline styles so that we can specify each style for ourselves.

@@ -318,9 +319,9 @@ If we run the publish again, we can see that we have full styling on our code sn
-
-

Images

-
+
+

Images

+

Our first two criteria have been met! Next on the list is solving images. As an example, let's use this squirrel image that I found online with an open source license. The ideal situation would be:

@@ -365,7 +366,7 @@ So what's the fix here? Well, we have two options, but I am going to go with the That's all there is to it! There are simpler ways as well, but that should do it:

-
+

squirrel.jpg

Figure 1: A Cute Squirrel

@@ -374,9 +375,9 @@ That's all there is to it! There are simpler ways as well, but that should do it
-
-

Creation Date

-
+
+

Creation Date

+

Let's add the creation date below the title next. To start, we will modify the publish command to remove the title (:with-title nil) and, in its place, show a preamble bit of HTML that contains a formatted div with the title and the "last modified" span.z

@@ -436,9 +437,9 @@ Note that the downside of this is that the created date will change whenever you
-
-

Generating the Directory

-
+
+

Generating the Directory

+

For every org file in my _posts folder, I would like to create a link to the generated HTML file at the /posts.html page of my website. You can think of this as the "directory" of all posts. My criteria is:

@@ -499,9 +500,9 @@ From here, you may customize it however you like. The following are my customiz

-
-

Sitemap Title

-
+
+

Sitemap Title

+

I changed the title to "Matthew's Blog Posts".

@@ -525,9 +526,9 @@ I changed the title to "Matthew's Blog Posts".
-
-

Format blog entries in the list

-
+
+

Format blog entries in the list

+

I like to include the creation date on the blog posts. To do this, we can use org-publish-find-property to find the date property of the org file. Afterward, we can format a string that includes our formatted timestamp and the org-publish-sitemap-default-entry, which is just a link with the title of the post.

@@ -549,9 +550,9 @@ I like to include the creation date on the blog posts. To do this, we can use
-
-

Tags & Filtering

-
+
+

Tags & Filtering

+

I use Org-roam for all of my note-taking and, in the next blog post, I plan to demonstrate how I will hook up my Org-roam note-taking workflow to my blogging. In the meantime, just know that we can add tags to the top of our org files like this:

@@ -772,9 +773,9 @@ Finally, let's append the following to posts/posts.css so that our
-
-

Conclusion

-
+
+

Conclusion

+

There are many more customizations that I plan to do on this system in the future, but I plan to leave this for now so that I can actually get to some blogging. I will proofread and fix my mistakes as time goes on, but this should be a good jumping off point for anyone interested in using org for their own blogging system.

diff --git a/posts/sitemap.html b/posts/sitemap.html index efc2268..b8292f1 100644 --- a/posts/sitemap.html +++ b/posts/sitemap.html @@ -21,7 +21,7 @@

Matthew's Blog Posts

- Last modified: 2023-06-20 at 11:46 + Last modified: 2023-06-20 at 11:51
@@ -29,7 +29,7 @@

  • Hello, Org created on June 20, 2023

    -
    +

    technology,home

    -- cgit v1.2.1