This is a simple blog generator which creates a blog based on a user's github projects. It creates a post for each github project and uses the content of project README as post content.
How to create your own blog?
- Clone this repo
based on your use case
Create a github repo:
Commit changes and push to
Your blog is live at
You can also set up custom domain. See github-guide
I trired various blog generators such as Jekyll, Hugo, Ghost, but they seemed to require some maintenance overhead. Plus, for my use case, most of my post would be related to a coding project, so
I didn't want to write a project README AND a corresponding "blog" post leading to duplication of work.
-> used to render markdown (with code blocks and latex) as html.
- On demand rendering - every page load fetches info from github using their api
- When a post is clicked, the README content is fetched as markdown text and rendered into HTML
- Because of on-demand fetching, there is noticeable lag on page load, which is fine for my use case.
to convert markdown to HTML
to format the code blocks and latex blocks once the markdown is converted to html
- Excludes forked projects by default
for theme. I took whitey.css from Typora
- Can skip repos if you don't want to create a post for certain projects (eg: unfinished/not-started projects)
Look into latex rendering support
Add support for non-project posts (don't wanna have to create a repo everytime you have to write a post). I am thinking of adding a special repo- "blog-posts" and fetch all files from that repo as posts.
- [Maybe] Add recent github commits/updates to the project page