Giter VIP home page Giter VIP logo

galacsh / blog-template Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 3.62 MB

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.

Home Page: https://galacsh.github.io/blog-template/

License: MIT License

TypeScript 88.42% CSS 1.29% JavaScript 6.73% SCSS 3.56%
blog markdown nextjs obsidian shadcn-ui ssg vitepress

blog-template's Introduction

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

blog-template's People

Contributors

galacsh avatar

Stargazers

Shubham Mazumder avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.