README.md

shadcn-docs-nuxt

Beautifully designed Nuxt Content template built with shadcn-vue. Customizable. Compatible. Open Source.

📖 Documentation / Demo

💬 Discord

Quick Start

1. Create a project with the starter template

npx nuxi@latest init -t github:ZTL-UwU/shadcn-docs-nuxt-starter

2. Navigating to the Project Directory

cd [project-name]

3. Start dev server

npm run dev

Contributing

1. Clone this repository.
2. Install dependencies pnpm install.
3. Use pnpm run dev to start dev server.
4. Before committing, run pnpm run lint:fix and pnpm run typecheck.

Credits

• Nuxt Content: Content made easy for Vue Developers.
• shadcn-ui: For the beautiful component & docs design.
• shadcn-vue: For the vue port of shadcn-ui & some docs component source.
• Docus: For the inspiration & some docs component source.
• Nuxt UI Pro Docs: For the inspiration.

Who's Using

• unovue/inspira-ui 3.1K ⭐️
• unjs/magic-regexp 4K ⭐️
• nuxt-monaco-editor
• nuxt-umami
• Msty
• Archiver
• ePoc
• hexo-theme-solitude 1k ⭐️
• Add your project 🚀

License

MIT

---