Logoshadcn-docs-template
DocsDemo
Sections
  • Get Started
Getting Started
  • Introduction
  • Installation
Customization
  • Customizing the Template
  • MDC Components
  • Composables
  • Writing Documentation
Components
  • DocTabs
  • Callout
  • ComponentPreview
  • CommandMenu
  • CopyButton
  • DocsSidebar
  • DocsTableOfContents
  • PageHeader
  • SiteHeader
  • CopyCodeButton
  • DocsCopyPage
  • CodeBlockCommand
  • CommandMenuItem
  • CommandMenuKbd
  • GitHubLink
  • LucideIcon
  • MainNav
  • MobileNav
  • ModeSwitcher
  • PageHeaderDescription
  • PageHeaderHeading
  • SiteBody
  • SiteConfig
  • SiteFooter
  • OgImage (Custom)

Installation

PreviousNext

How to install and run the shadcn-docs-template on your local machine.

Get up and running with the shadcn-docs-template in a few easy steps.

1. Clone the Repository

You can clone the template repository directly from GitHub.

git clone https://github.com/hetari/shadcn-docs-template.git docs
cd docs
bun Install

Make sure you have Bun installed on your machine to run the installation command. If you prefer using npm or yarn, you can replace bun install with npm install or yarn install respectively.


2. Start the Development Server

Start the local development server to preview the template.

pnpm dev

The development server usually starts at http://localhost:3000. Open this URL in your browser to see your new documentation site!

IntroductionCustomizing the Template

On This Page

1. Clone the Repository2. Start the Development Server
© shadcn-vue.com