Installation
How to get started with this Next.js MDX template
Quick Start
This is a ready-to-use template that comes with everything you need to build a modern documentation site or blog using Next.js 15, MDX, Velite, and Shadcn UI components.
Clone the repository
Install dependencies
Start the development server
What's Included
This template comes pre-configured with:
- Next.js 15 - The React framework for production
- Velite - Content management system
- MDX - Write content with JSX components
- Shadcn UI - Beautiful and customizable UI components
- Tailwind CSS - Utility-first CSS framework
- TypeScript - Type safety out of the box
Project Structure
The template follows a standard Next.js project structure with additional directories for content management:
Next.js app router pages
Configuration
You can customize the site by editing src/config/site.config.ts
. This includes site metadata, social links, and other configuration options.
Next Steps
You can start adding your own content by:
- Adding MDX files in the
content/docs
directory - Customizing the theme in
tailwind.config.ts
- Modifying site configuration in
src/config/site.config.ts