Lysekil: A Static Site Generator For Personal Blogs

This is a static-file blog generator written in Python.

Features

This app converts Markdown files in _source directory to static HTML files under _target directory.
This app generates blog posts in HTML files. Blog posts are called “notes” in this app. The word “blog”, itself short for “web log”, does not sound like something that ages well. Calling them “notes” suggests a wish that your writing will be less time-sensitive. Hopefully your notes are reflected upon from time to time.
- Notes are organized under the archive menu by quarters. It is an arbitrary decision to group notes by quarters rather than months.
- Notes are also categorized by tags. Each note can have one or more tags.
- Your notes will be accessible at: domainname/<year>/<quarter>/<slug>, eg: https://this.xyz/2021/q3/hello-world.
It generates pages too.
- Pages, such as “about me”, are accessible at: domainname/pages/<slug>, eg: https://this.xyz/pages/aboutme
Supports code syntax highlighting by Pygments.
Generates Atom feed file.

Dependencies

These packages are used in this program. Respectively,

python-markdown2 is used to convert markdown to HTML;
Pygments is used to highlight code syntax; and
python-feedgen is used to generate

You need to use Python 3.9+ because FeedGen requires timezone information to indicate time of publication. And zoneinfo package available from Python 3.9 allows you to specify timezones using a string, such as “Europe/Stockholm”.

Usage

Creating a Blog Post

Create a markdown file under _source folder. The folder structure under this directory is flat.
The markdown file should be name something like this:
1. 210101 filename.md in which 210101 will be interpreted as the date of creation of this blog post in yymmdd format. This string is equivalent to January 1, 2021.
2. filename part is for human reading and is not parsed by the generator.
The markdown files are formatted as follows, with front matter and main test separated by an empty line.

Sample 1

title: Sample Post One
tags: tag1, tag3
slug: post_one
summary: This is a sample post that shows how markdown is converted to HTML and how the generated site looks like.

How are you my friend? I'd like to show you some JavaScript.

...

Check out _source/210101 filename.md and the resulting HTML file _target/2021/q1/post_one/index.html.

Sample 2

Multiple lines are allowed in summary field with a greater than sign followed by a few indented lines. (Note there's a space between colon : and greater than sign >.) Also note how footnotes are added in your markdown file.

title: Sample Post 2 With Long Summary
tags: tag1, tag2
slug: sample_post2
summary: >
  This sample post shows you how to use multiple tags.
  And how to write longer summaries and footnotes.

How are you my friend? I'd like to show you some JavaScript[^1].

[^1]: Can you believe the invention of JavaScript has nothing to do with the written language of Java the island?

Check out _source/210202 filename.md and the resulting HTML file _target/2021/q1/sample_post2/index.html.

Fields in the header

title is the title of this blog post. It will be shown in either <h3> or <h1> on the webpage.
tags are the tags of this blog post. You may choose not to tag your post. Multiple tags are separated by a comma.
slug is part of the URL by which this blog post is visited from the web.
- When published, the URL of this post will be: <yourblog.com>/2021/q1/sample_post
- Namely, your domain name; year; quarter; slug.
summary is the summary of this blog post. It will be displayed on the index page, archive pages, tag listing pages, as well as the generated ATOM feed.

Creating a page

This is a sample “about me” page. It also needs to bear a six-digit date stamp in it's filename.

title functions similarly to that of a blog post.

Notably, the page property specifies this markdown file is a page and not a blog post. The difference between the two is that pages are not shown among blogs on the home page or other chornically ordered lists.

The slug determines the URL of the published page. This page will be available at <yourblog.com>/pages/about.

Pages are not listed in the timeline, archive page, tags page or the Atom feed.

title: About Me
page: True
slug: about

Lysekil is a beautiful seaside town in West Sweden.

Check out _source/210721 about.md and the resulting HTML file under _target/pages/about.

Settings

Check out code/settings.py. Hopefully it's self-explanatory.

Generating Site

Run python build.py.

The generated site will be created under _target directory by default.

Move all the generated stuff to GitHub Pages. And it's done.

Publishing Your Site

My own blog at tonghe.xyz is deployed on Netlify.

What I did was:

First, create a git repo and set a matching value for TARGET_DIR property in code/settings.py.
Then commit and push this repo to a git service, for example GitHub.
Log in to Netlify.
- Create a new site and link it to the GitHub repo that you've just committed to.
- Buy a domain name and bind it to your Netlify site.

For an instruction on how you can do that, read this blog post written by Netlify.

Editing the Template

The default color palette of this blog is inspired by Bear.

The page structure is quite straightforward. You can edit the template.scss under _assets folder to change the color palette and styling of the page.

Changing the structure of the pages is a bit more cumbersome. You can start by readingtemplate.py, which contains a bunch of functions that generate HTML partials. These functions are invoked by the output_html method in classes in utils.py.

Known Issues And To Do Items

Issue: Pagination error. When the number of blog posts to be shown is divisible by POSTS_PER_PAGE, one more “next page” link will be created.
To Do: Handling of media files. Currently this app does not handle media files. The user needs to manually copy media files into _target directory.
To Do: Internal linking. Since there is no one-to-one mapping between filenames of your Markdown files and URLs on the web, it might be a minor head-scratcher. I'll do it later.
~~Issue: Somehow you can't use underscores (_) in slugs. I'll fix it later.~~ (This is a non-issue. Turns out you can.)
To Do: I might also want to add support for external commenting services.
To Do: Pinned posts.
To Do: Since we now handle friendly links in a list of dictionaries. When there are more links than can be displayed, displayed items are chosen randomly. We might need to add a weighted or pinned option.

Footnote

The default logo is a picture I took in Lysekil, Västra Götaland, Sweden.
This is an ongoing (aka unfinished) personal project. Don't rely on it for any serious business.

t0nghe / Lysekil