Skip to content
This repository was archived by the owner on May 3, 2026. It is now read-only.

huntsyea/nextjs-directory-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

61 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Next.js Directory/Blog Boilerplate

Next.js TypeScript License: MIT GitHub Stars Deploy with Vercel

A modern, customizable directory/blog template built with Next.js 15, MDX, and shadcn/ui. Perfect for creating content-driven websites, directories, portfolios, blogs, or educational content collections.

Deploy with Vercel


✨ Key Features

πŸš€ Modern Stack

Built on Next.js 15 with React 19, TypeScript, and the latest web technologies for blazing-fast performance

πŸ“ MDX-Powered Content

Write content in Markdown with full JSX support - embed interactive components directly in your content

🎨 Beautiful by Default

Gorgeous UI built with shadcn/ui and Tailwind CSS - customizable, accessible, and production-ready

⚑ Lightning Fast

Static site generation ensures optimal performance with instant page loads and perfect Lighthouse scores

πŸ” Search & Discovery

Built-in content search, tag filtering, and smart categorization help users find what they need

πŸŒ™ Dark Mode Included

Automatic dark mode with system preference detection and manual toggle - no extra configuration needed

🎯 What Makes This Special?

  • πŸ“± Mobile-First & Responsive - Looks stunning on every device from phone to desktop
  • πŸ—ΊοΈ SEO Powerhouse - Auto-generated sitemap, RSS feed, and JSON-LD structured data out of the box
  • πŸ–ΌοΈ Smart Image Handling - Automatic image optimization powered by Next.js
  • 🎡 Multimedia Ready - Optional audio player for podcasts, tutorials, and educational content
  • 🏷️ Flexible Tag System - Organize content with tags and categories for easy navigation
  • πŸ”§ Config-Driven Setup - Customize everything through simple configuration files
  • πŸ“– Multi-Content Support - Handle different content types (articles, guides, etc.) with ease
  • πŸš€ One-Click Deploy - Deploy to Vercel in seconds with zero configuration

πŸ› οΈ Tech Stack

πŸš€ Quick Start

# Clone the repository
git clone https://github.com/rohanpatriot/nextjs-directory-boilerplate
cd nextjs-directory-boilerplate

# Install dependencies
pnpm install

# Start development server
pnpm dev

Open http://localhost:3000 to see your site.

πŸ“ Project Structure

β”œβ”€β”€ content/                  # MDX content files
β”‚   β”œβ”€β”€ articles/            # Blog articles
β”‚   └── guides/              # How-to guides and tutorials
β”‚   └── [custom]/            # Add your own content types
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ app/                 # Next.js App Router
β”‚   β”‚   β”œβ”€β”€ [contentType]/   # Dynamic content routes
β”‚   β”‚   β”‚   └── [slug]/      # Content detail pages
β”‚   β”‚   β”œβ”€β”€ tags/            # Tag pages
β”‚   β”‚   β”‚   └── [tag]/       # Tag-filtered content
β”‚   β”‚   β”œβ”€β”€ feed.xml/        # RSS feed
β”‚   β”‚   β”œβ”€β”€ sitemap.ts       # Dynamic sitemap
β”‚   β”‚   └── robots.ts        # Robots.txt
β”‚   β”œβ”€β”€ components/          # React components
β”‚   β”‚   β”œβ”€β”€ layout/          # Layout components
β”‚   β”‚   β”‚   β”œβ”€β”€ ContentCard.tsx
β”‚   β”‚   β”‚   └── ContentGrid.tsx
β”‚   β”‚   β”œβ”€β”€ Search/          # Search components
β”‚   β”‚   └── ui/              # shadcn/ui components
β”‚   β”œβ”€β”€ config/              # Configuration
β”‚   β”‚   β”œβ”€β”€ content.config.ts    # Content type definitions
β”‚   β”‚   └── directory.config.ts  # Site settings
β”‚   β”œβ”€β”€ lib/
β”‚   β”‚   β”œβ”€β”€ content/         # Content system
β”‚   β”‚   β”‚   β”œβ”€β”€ loader.ts    # Content loader
β”‚   β”‚   β”‚   β”œβ”€β”€ types.ts     # TypeScript types
β”‚   β”‚   β”‚   └── index.ts     # Exports
β”‚   β”‚   β”œβ”€β”€ metadata.ts      # SEO metadata
β”‚   β”‚   β”œβ”€β”€ structured-data.tsx  # JSON-LD schemas
β”‚   β”‚   └── utils.ts         # Utility functions
β”‚   └── types/               # TypeScript type definitions
β”‚       └── content.ts       # Content interfaces

✍️ Content

Add MDX files to content/articles/ or content/guides/:

---
title: 'My Post Title'
summary: 'Brief description'
date: '2024-01-15'
author: 'Your Name'
tags: ['tag1', 'tag2']
image: '/images/post-image.jpg'
---

Your content here...

See Content System docs for all frontmatter fields and adding custom content types.

βš™οΈ Configuration

Site settings in src/config/directory.config.ts:

export const directoryConfig = {
  name: 'Your Site Name',
  description: 'Your site description',
  // ...
}

Content types in src/config/content.config.ts:

export const contentConfig = {
  types: {
    articles: { /* config */ },
    guides: { /* config */ },
    // Add your own types
  }
}

See Configuration docs for full reference.

πŸ“š Documentation

Comprehensive documentation is available online and in the repository:

Quick Links

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

πŸ“„ License

This project is released under the MIT License.

About

Production-ready Next.js 15 boilerplate for content-driven websites with MDX, shadcn/ui, and TypeScript.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors