Mkdocs Shadcn

Next.js MkDocs Alternative: Modern Documentation Site Generator

This project offers a seamless transition from MkDocs Material, leveraging Next.js 14+ for superior performance and a modern development experience. It integrates Tailwind CSS for deep customization and shadcn/ui for polished components. Developers can maintain their existing MkDocs project structure while benefiting from features like full-text search, advanced image optimization, and enhanced Markdown support, creating fast, responsive, and feature-rich documentation sites with ease.

Features:

• Responsive Design: Mobile-first layout for optimal viewing on all screen sizes.
• Dark Mode Support: Auto-adapts to system preferences with manual toggle options.
• Fast Page Loads: Optimized performance using Next.js 14+ and the App Router.
• Tailwind CSS Customization: Deeply personalize styles and themes for unique branding.
• Shadcn/ui Components: Integrates pre-built, high-quality UI elements for a polished look.
• Full-Text Search: Pagefind integration enables efficient site-wide content discovery.
• GitHub Flavored Markdown: Enhanced Markdown rendering with support for tables.
• Dynamic Sidebar Navigation: Auto-generated, collapsible navigation based on your mkdocs.yml file.
• Previous/Next Page Navigation: Allows users to seamlessly navigate between documentation pages.
• Mobile Navigation Drawer: Includes keyboard shortcuts (⌘K / Ctrl+K) for quick access on smaller screens.
• Advanced Image Optimization: Utilizes the Next.js Image component for automatically optimized images.
• Lightbox Gallery Support: Display images in an interactive lightbox gallery using !![] syntax.
• Code Syntax Highlighting: Employs rehype-pretty-code with GitHub-themed light and dark styles.
• Copy-to-Clipboard for Code: Provides a one-click button for copying code snippets.
• Admonition Blocks: Supports over 12 types of admonitions (e.g., note, warning, danger), including collapsible versions.

Summary:

This Next.js project serves as a powerful, modern alternative to MkDocs Material, enabling developers to create fast, responsive, and highly customizable documentation websites. It maintains compatibility with existing MkDocs content and configuration while introducing enhanced features like advanced image handling, superior code block presentation, and a rich component library. It's designed for developers seeking an improved documentation generation experience with contemporary web technologies.