Gist Blog is a platform that transforms your GitHub Gists into blog posts. This project was heavily inspired by Gist.io, but Gist Blog comes with a few extra perks.
Gist Blog is for posts that don't belong on your usual blog, maybe because it doesn't fit the theme or maybe because you want to reach a different audience than the people that usually read your blog.
- Create a GitHub Gist in Markdown.
Make sure the file name ends with
_post.mdand has a title parameter in themetadata*. - Replace the URL:
gist.github.com/{username}/{gist-id} with
gistblog.vercel.app/post/{gist-id} - Your blog post is ready!
List all posts on your profile
- Create multiple posts using the instructions above
- Go to:
gistblog.vercel.app/{username} - Your blog is ready!
You can add metadata to your post in the form of yaml at the top of your markdown file. The syntax for metadata is as follows
---
title: A very interesting and unique blog title
description: An even more interesting and unique description that provides more info about the post
---
For posts to show up in your blog page they MUST have the title field and a file name ending with metadata.
- Turn any GitHub Gist into a blog post.
- Have a place to list all your gist blog posts
- Switch between dark/light mode
- Render markdown into HTML. Supports markdown tables and more
- Add a title and description to you blog using YAML metadata
To run locally for development, fork the project, install the Vercel CLI
npm i -g vercel
cd GistBlog
vercel dev
Then go to localhost:3000 to see the site up and running
For listing all posts on your profile, the content of each post has to be retreived. This is why only 5 posts are shown per page and even then the page might take 3~4 seconds to load.