Nuxt Issue Blog

🚀 A static blog generator powered by GitHub Issues and Nuxt.js

English | 简体中文

✨ Features

• 📦 SSG for fast deployment and SEO
• 🌙 Light/Dark theme support
• 💬 GitHub Issues as CMS
• 🔄 Auto-deploy with GitHub Actions
• 📱 Mobile-friendly responsive design
• 🎨 Clean and minimal UI
• 🔍 Full-text search support
• 📝 Markdown with code highlighting
• 🏷️ Label-based categorization
• 📊 Table of contents navigation

🚀 Quick Start

Prerequisites

- git: ^v2.0.0
- node: ^v12.18.3
- yarn: ^v1.12.0

Setup GitHub Token

1. Go to GitHub Token Settings
2. Select these permissions:

read: user        Read all user profile data
user: email       Access user email addresses (read-only)

3. For organization projects, also select:

read: org         Read org and team membership

⚠️ Warning: Don't select other permissions for security reasons.

Configuration

1. Fork this repository
2. Clone to your local machine
3. Edit blog.config.js:

module.exports = {
  baseUrl: '/blog/',
  userName: 'your-username',
  userEmail: 'your-email',
  repository: 'blog',
  accessToken: 'base64-encoded-token',
  blogName: 'Your Blog Name',
  seo: {
    title: 'Your Blog Title',
    description: 'Your Blog Description',
    keywords: 'your, keywords'
  }
}

Development

# Install dependencies
yarn install

# Start development server
yarn serve

# Build for production
yarn build

# Deploy to GitHub Pages
yarn deploy

🤝 Contributing

1. Fork it
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Create a new Pull Request

📝 License

MIT

🙏 Acknowledgments

• Nuxt.js
• GitHub API
• Element UI