Published on 31/08/2021 by

Nevulo profile picture

Why and how I built the blog

What I want to achieve with the blog, and how it works behind the scenes

Cover image by Clay Banks

Why I built the blog

Before we start with how, let's learn more about why. I think it's important to establish why you want to do a project, and what you and others should gain from it. I know a lot of people have made blogs, but I'm not worried about diluting the market 😅 Instead, this blog has one mission I want to personally achieve:

Educate people on programming concepts in an understandable, concise format while being accessible

To achieve the mission, there are key goals as indicators of progress and success:

👉 needs to educate people on programming

👉 needs to be understandable

👉 needs to be concise

👉 needs to be accessible

Now that we've established exactly what is needed when developing the blog, we can think about the best way to tick off each of those goals when writing the posts and developing the blog page.

My main keyword for the blog was "accessible"; the blog should be simple to use, both for me (when making edits) and for viewers. Hosting blog content on a place like GitHub is good for accessibility for many reasons:

  • I can quickly push out new blog posts and make iterative changes to existing ones, even through the GitHub website
  • It gives other people the opportunity to fix content, translate existing content or contribute new content
  • It gives people another place to access the blog just in case my website goes down

So, GitHub it is then! Now the question becomes: how do we get blog content hosted on a repo on GitHub loaded into my blog when users visit?

How it's done

Fetching Posts from GitHub

All of the blog posts are stored in a repo on GitHub. While the blog is loading, a hook called useRepoFile is rendered which sends a

to read the blogmap.json file on the repo:

1const response = await fetch(
2 `${file}`
4// contains an array of posts
5const posts = await response.json();

The response from this request contains JSON data, specifically an array containing all of the blog posts including their name, description, image, etc.

2 {
3 "slug": "test-post",
4 "title": "Test post",
5 "description": "...",
6 "image": "..."
7 },
8 ...

While we wait for the response to complete, we play a loading animation. Once it does complete, we render a <Post /> component for each post returned from the hook and pass in the metadata as props.

Loading a Single Post

Each post in the blogmap.json file mentioned above has a location property which includes the location of the post in the repo. In our case, the posts are stored under the posts folder. In the example above, the location property could be posts/test-post.mdx.

When a user clicks on a blog post, we use the same useRepoFile hook to request a file on the repo under posts/test-post.mdx. Any markdown in the post is parsed client-side and the final content is rendered on the page.

Publishing Posts

To publish a post, I simply add a file ending in .mdx on the

repo. However, it won't appear on the homepage for my blog since it looks at blogmap.json and we haven't updated that file with the properties of the new post.

In order to programatically update the blogmap.json file with the properties for the post, all posts include properties about itself (image, description, title, etc) at the bottom of the post which looks like this:

2- slug: 'numbers-in-javascript'
3 title: 'Numbers in JavaScript'
4 description: "Simple, innocuous methods which will trip you up when working with numbers in JavaScript"
5 image: ""
6 createdAt: 1627826463001
7 location: 'posts/numbers-in-javascript.mdx'
8 labels:
9 - programming
10 - javascript

I set up a GitHub action to automatically update the blogmap.json file when adding/updating a post in the posts folder. It does this by searching the content of the post using a command line tool called grep for a [PROPERTIES] tag wrapped in a HTML comment (this is so users don't see the properties when reading the post normally).

The properties are formatted in a language called

which the action parses as JSON, then appended to the array of posts in the blogmap.json file. You can check out the source code for the action - it's a bit of a mess but it gets the job done.

That's pretty much it!

One message I want to make clear is I think it's important to develop solutions that make sense for your project and align with your goals.

I had a few goals in mind for the blog, but I wanted it to be as simple as possible: simple to read, and simple for me and others to make changes. I didn't want to have to deal with maintaining a database, or even setting up something like Firebase. Managing blog content would be a nightmare and you'd have to have a separate admin panel.



You need to be signed in to comment