English | 简体中文

Nuxt3-Blog

📖 Project Introduction

This is a personal blog website built with Nuxt3 + TypeScript + UnoCSS, designed for displaying articles, recording life, and sharing personal moments. The project utilizes a modern front-end technology stack, features responsive layout and dark mode support, focusing on excellent user experience and performance optimization.

🛠️ Technology Stack

• Nuxt3: Vue's server-side rendering framework, providing excellent SEO support and performance
• TypeScript: Enhances code maintainability and type safety
• UnoCSS: Atomic CSS engine, improving style development efficiency
• Vite: Modern front-end build tool, providing an extremely fast development experience
• @nuxt/content: Powerful content management system, making blog article management convenient
• Waline: Lightweight commenting system
• Algolia: Efficient site-wide search solution
• Pnpm: High-performance package manager

✨ Key Features

• ✅ Article Display: Supports Markdown format, code highlighting, reading time estimation
• ✅ Article Search: Integrates Algolia, providing an efficient full-site search experience
• ✅ Responsive Layout: Adapts to various devices, from mobile to desktop platforms
• ✅ Dark Mode: Supports light/dark theme switching, protecting users' eyesight
• ✅ Article Comments: Integrates the Waline comment system, supporting anonymous comments
• ✅ Website SEO: Optimized for search engines, improving website visibility
• ✅ Sitemap: Automatically generates sitemap.xml, helping with search engine indexing
• ✅ Configuration System: Easily customize blog name, header navigation, footer links, and more through configuration files

🚀 Quick Start

Requirements

• Node.js 16.x or higher
• pnpm 7.x or higher

Installation and Running

# Clone repository
git clone https://github.com/alickx/nuxt3-blog.git
cd nuxt3-blog

# Install dependencies
pnpm install

# Run in development mode
pnpm dev

# Build project
pnpm build

# Preview build result
pnpm preview

📝 Content Creation

Blog articles are stored in the src/content/_articles directory, written in Markdown format. Each article needs to include frontmatter metadata, for example:

---
title: 'Article Title'
description: 'Article Description'
date: '2023-01-01'
tags: ['tag1', 'tag2']
---

Article content...

⚙️ Customization

The blog can be easily customized through the configuration file located at src/config/site.ts. This allows you to modify:

• Blog name and basic information
• Header navigation menu items
• Footer links and sections
• Social media links
• SEO metadata and favicon
• Algolia search configuration

Example configuration:

// src/config/site.ts
export const siteConfig = {
  name: "Your Blog Name",
  title: "Your Blog Title",
  description: "Your blog description",
  author: "Your Name",

  // Navigation menu
  nav: [
    { name: "Home", path: "/" },
    { name: "About", path: "/about" },
    // Add more menu items
  ],

  // Footer links by section
  footerLinks: [
    {
      title: "Social Media",
      links: [
        { name: "Github", url: "https://github.com/yourusername" },
        // Add more links
      ]
    },
    // Add more sections
  ],

  // SEO configuration
  seo: {
    meta: {
      keywords: "keyword1,keyword2",
      description: "Site description"
    }
  },

  // Algolia search configuration
  algolia: {
    apiKey: "your-api-key",
    applicationId: "your-application-id",
    indexName: "your-index-name",
    lang: "en"
  }
}

🌐 Deployment Strategy

The project uses a Vercel + Cloudflare deployment approach:

1. Vercel: Provides continuous integration and deployment services; each time code is pushed or an article is added, deployment is automatically triggered
2. Cloudflare: Through setting up CNAME records and Cloudflare's CDN, enables access acceleration for domains without ICP filing in China

Deployment Steps

1. Import GitHub repository on Vercel
2. Configure build command pnpm build
3. Set environment variables (if needed)
4. Set up custom domain
5. Add domain in Cloudflare and set CNAME record pointing to the domain provided by Vercel

🤝 Contribution Guidelines

Contributions to this project are welcome! Whether submitting bugs, improving documentation, or adding new features, your participation will make this project better.

1. Fork this repository
2. Create your feature branch: git checkout -b feature/amazing-feature
3. Commit your changes: git commit -m 'Add some amazing feature'
4. Push to the branch: git push origin feature/amazing-feature
5. Submit a Pull Request

📄 License

This project is distributed and used under the LICENSE open source license.

---

Made with ❤️ by alickx