Introduction

Welcome to the component documentation

Introduction

Welcome to the component documentation. This is a sample documentation page built with Fumadocs.

Getting Started

You can start creating your own documentation by adding MDX files to the content/docs directory.

Features

Fast: Built with Next.js and Fumadocs
Markdown Support: Write your docs in MDX
Syntax Highlighting: Code blocks with syntax highlighting
Responsive: Works on all devices

Usage

File Configuration

add .npmrc file to the root of the project, such as:

@pandapro-project:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=

Theme

On This Page

Introduction Getting Started Features Usage File Configuration Install the component Use the component

import type { Config } from "tailwindcss"
 
const config: Config = {
  content: [
    "./app/**/*.{ts,tsx}",
    "./components/**/*.{ts,tsx}",
    "./registry/**/*.{ts,tsx}",
    "./content/**/*.{md,mdx}",
  ],
  theme: {
    extend: {},
  },
  presets: [require("@pandapro-project/tailwind-basic-ui-preset")],
}
 
export default config

{
  "scripts": {
    "generate:basicui": "npx basicui generate",
    "build": "pnpm generate:basicui && next build --turbopack",
  },
  "simple-git-hooks": {
    "pre-commit": "npm run generate:sitemap"
  }
}

{
  "$schema": "https://ui.shadcn.com/schema.json",
  "style": "basic-ui",
  "rsc": true,
  "tsx": true,
  "tailwind": {
    "config": "",
    "css": "app/globals.css",
    "baseColor": "neutral",
    "cssVariables": true,
    "prefix": ""
  },
  "iconLibrary": "lucide",
  "aliases": {
    "components": "@/components",
    "utils": "@/lib/utils",
    "ui": "@/components/ui",
    "lib": "@/lib",
    "hooks": "@/hooks"
  },
  "registries": {
    "@basic-ui": "https://uineo.dev/r/{name}.json"
  }
}