Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 4.09 KB

README.md

File metadata and controls

76 lines (58 loc) · 4.09 KB

SuzuBlog 🎐

English | 中文 | 日本語

Suzu (鈴) means "bell" in Japanese — a minimalist Next.js + Markdown blog template.

🚀 Live Demo | 📚 Documentation

GitHub License Latest Release

Node.js pnpm Version | Next.js Tailwind CSS | Vercel Eslint Prettier

✨ Features

  • 🚀 Next.js Powered – Supports ISR & SSG for lightning-fast performance.
  • 📄 Markdown Support – Code highlighting with copy button, LaTeX rendering, optimized images, and elegant styling.
  • 🔍 SEO Ready – Auto-generates sitemap, Open Graph, Twitter Cards, and more.
  • 🌍 Multi-Language – Supports English, Chinese, Japanese, and more via config.yml.
  • 📺 Anime List – Fetch & display anime info from AniList API.
  • 🌓 Dark Mode – Adapts to system preferences seamlessly.
  • 📢 RSS Feed – Auto-generated RSS for easy content distribution.
  • ♿ Accessibility First – Semantic HTML, ARIA support, WCAG-compliant colors.

🚀 Get Started

For setup, configuration, Markdown syntax, and deployment guides, follow the documentation:

📖 Suzu Blog Docs

🏗️ Project Structure

.
├── config.yml                # Global configuration file
├── posts                     # Markdown posts directory
│   └── _pages                # Special pages (About/Friends)
├── public                    # Static assets directory
│   └── images                # Image resources
├── src                       # Project source code
│   ├── app                   # Next.js application directory
│   ├── components            # Reusable components
│   ├── services              # Logic for content parsing, configuration, etc.
│   └── types.d.ts            # Global type definitions
├── tailwind.config.ts        # Tailwind CSS configuration
├── package.json              # Project dependencies and scripts
└── pnpm-lock.yaml            # pnpm dependency lock file

❤️ About Suzu

After years of frustration with the maintenance, security risks, and performance issues of other frameworks, I decided to create Suzu Blog using Next.js. It is simple, efficient, and highly customizable, designed for anyone looking to build a modern blog quickly.

🔗 Community Support

Contribute: Contributions are welcome! Please refer to the Contribution Guide.