Skip to content

Simple blog template for personal blogs. Inspired by "Next.js - Docs" and "VitePress - Guide" designs. Can be hosted on any static site hosting service. Uses Unified to handle markdown files.

License

Notifications You must be signed in to change notification settings

Galacsh/blog-template

Repository files navigation

Tip

For more information, read posts:

What is this?

This is a simple blog template for personal blogs. This template generates pages from markdown files and builds a static site. So it can be hosted on any static site hosting service, such as Vercel, Netlify, GitHub Pages, etc.

This template doesn't use MDX or @next/mdx directly. Instead, it uses Unified to parse markdown files and convert them to React components.

Even though this template is built with the Next.js - App Router, each post (markdown file) doesn't need to follow app routing conventions. Markdown files placed in /posts directory will be automatically converted to pages. This means the template can also be used with Obsidian vaults with some tweaks.

Theme supports dark mode and responsive design, and is inspired by the Next.js - Docs and the VitePress - Guide.


Main Features (Roadmap)


Main Dependencies


Why didn't I use these?

@next/mdx

I didn't want to follow app routing conventions for each post.

next-mdx-remote

I wanted to have more control over the markdown parsing process.

For example:

  • Caching the list of posts and their metadata
  • Handle slug generation

ContentLayer

By the time I started this project, it seemed like the project was not actively maintained and unstable.

Proposal to become a maintainer for Contentlayer #651

About

Simple blog template for personal blogs. Inspired by "Next.js - Docs" and "VitePress - Guide" designs. Can be hosted on any static site hosting service. Uses Unified to handle markdown files.

Topics

Resources

License

Stars

Watchers

Forks