Skip to content

hetari/shadcn-docs-template

Repository files navigation

shadcn-docs-template

Enjoying my project? Please show your appreciation by starring it on GitHub! ⭐

A production-ready documentation template built with Nuxt 4.4 and shadcn-vue. Engineered for speed, clarity, and developer sanity.


📚 Documentation

For more information, please visit the Documentation.

✨ Features

  • Nuxt 4.4 & Nuxt Content 3: The latest and greatest from the Nuxt ecosystem.
  • Shadcn Vue Integration: Beautifully designed components ready to use.
  • Tailwind CSS 4: Modern styling with the latest Tailwind features.
  • MDC Components: Rich Markdown support with custom components like Callout, ComponentPreview, and more.
  • Dark Mode: Built-in support for light and dark themes via @nuxtjs/color-mode.
  • Search: Integrated search api functionality.
  • Optimized for Performance: Fast loading and great SEO out of the box.

🛠️ Tech Stack

🚀 Getting Started

Installation

  1. Clone the repository:

    git clone https://github.com/hetari/shadcn-docs-template.git
  2. Install dependencies:

    bun install

Upgrade

To upgrade to the latest version, run:

bunx --bun nuxt@latest upgrade
bun update # this will update all dependencies to their latest versions, including Nuxt and its related packages, not recommended if you want to keep the current versions of some packages, but it will ensure that all packages are updated to their latest versions, including Nuxt and its related packages.

Development

Start the development server:

bun dev

The site will be available at http://localhost:3000.