Skip to content

dhanushd-27/docs

 
 

Repository files navigation

Next.js 15 MDX Template

A modern documentation and blog template built with Next.js 15, MDX, Velite, and Shadcn UI components. This template provides a robust foundation for creating beautiful documentation sites and blogs with a focus on developer experience and performance.

Features

  • Next.js 15 - Built on the latest version of React framework for production
  • MDX Support - Write content using Markdown with embedded React components
  • Content Management - Efficient content organization and processing with Velite
  • Modern UI Components - Pre-built components from Shadcn UI
  • TypeScript - Full type safety out of the box
  • Tailwind CSS - Utility-first CSS framework for styling
  • Documentation Ready - Pre-configured for technical documentation and blogs

Quick Start

  1. Clone the repository:
git clone https://github.com/rudrodip/mext15.git my-docs
cd my-docs
  1. Install dependencies:
bun install
  1. Start the development server:
bun run dev

Project Structure

├── content/          # MDX content files
│   └── docs/         # Documentation pages
├── public/           # Static assets
└── src/
    ├── app/         # Next.js app router pages
    ├── components/  # React components
    ├── config/      # Site configuration
    └── types/       # TypeScript types

Configuration

Site configuration can be customized by editing src/config/site.config.ts. This includes:

  • Site metadata
  • Social links
  • SEO settings
  • Creator information

Contributing

We welcome contributions! Here's how you can help:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

Please refer to our contribution guidelines for more details.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

  • Documentation: Check the /guide directory
  • Issues: Submit via GitHub Issues
  • Discussions: Join our GitHub Discussions

About

Documentations repo for Plura.

Resources

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 78.8%
  • MDX 16.7%
  • CSS 4.2%
  • JavaScript 0.3%