This project is still WIP

A starter blogging template powered by nextjs, windicss and typescript

💖 Used by

• Demo - this repo

Are you using the template🚗 ? Please add yourself to the list above via a PR

🎉 Features

• Written in Typescript, with native type support.
• i18n
• Responsive design - mobile friendly
• Light and dark mode support
• Current best web engineering practices: lint + prettier + husky + commintlint + lint-staged
• Support for tags
• [] Powerful search with Algolia
• [] PR workflow - Run checks/lints on PR and preview

🔨 Usage

1. Clone the repo
2. Customize theme.config.ts
3. Customize data/intro/index.md and data/intro/index.zh-CN.md (about author)
4. Update blogs data/blogs/* with your own blogs
5. Update components/footer/index.tsx to customize social information
6. Deploy on Vercel

📦 Installation

$ yarn

🚗 Development

First, run the development server:

yarn run dev

Open your browser and visit http://localhost:3000.

📕 Overview

• theme.config.js - Theme configuration
• next.config.js - Nextjs configuration
• windi.config.ts - Windicss configuration
• pages/* - Static pages
• data/* - MDX data that is used for introduction and blogs
• public/* - Static assets
• interface/index.ts - Common types
• styles/index.css - Common custom variant
• styles/prism.css - Prism theme for code blocks

🙏 Credit

Inspired by the following awesome work:

leerob.io

antfu.me

tailwind-nextjs-starter-blog

🎈 License

This project is MIT licensed.