docs-please
v0.2.6
Published
Nuxt layer for documentation sites using shadcn-vue
Readme
docs-please
A Nuxt layer for documentation sites using shadcn-vue instead of nuxt-ui.
Overview
This layer provides a complete documentation theme built with:
- shadcn-vue - Beautiful, accessible UI components
- Nuxt Content - Markdown-based content management
- Tailwind CSS v4 - Modern CSS with CSS variables
Installation
# Install the layer
pnpm add docs-please// nuxt.config.ts
export default defineNuxtConfig({
extends: ['docs-please']
})Features
- Documentation layout with sidebar navigation
- Command palette search
- Table of contents
- Dark/Light mode
- Mobile responsive
- MDC components (Callout, CodeBlock, etc.)
Configuration
// app.config.ts
export default defineAppConfig({
docs: {
title: 'My Docs',
description: 'Documentation site',
github: {
url: 'https://github.com/owner/repo'
}
}
})Development
# Install dependencies
pnpm install
# Start development
pnpm devLicense
MIT
