!hero

shadcn-docs-nuxt

[![built with nuxt][nuxt-src]][nuxt-href]
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![License][license-src]][license-href]
[![sponsor][sponsor-src]][sponsor-href]

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

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

2. Navigating to the Project Directory

`bash
cd [project-name]
`

3. Start dev server

`bash
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

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

License

MIT

---

[npm-version-src]: https://img.shields.io/npm/v/shadcn-docs-nuxt?style=flat&colorA=18181b&colorB=18181b
[npm-version-href]: https://npmjs.com/package/shadcn-docs-nuxt
[npm-downloads-src]: https://img.shields.io/npm/dm/shadcn-docs-nuxt?style=flat&colorA=18181b&colorB=18181b
[npm-downloads-href]: https://npm.chart.dev/shadcn-docs-nuxt?primary=neutral&gray=zinc&theme=light
[license-src]: https://img.shields.io/github/license/ZTL-UwU/shadcn-docs-nuxt.svg?style=flat&colorA=18181b&colorB=18181b
[license-href]: https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/LICENSE
[nuxt-src]: https://img.shields.io/badge/Built%20With%20Nuxt-18181B?logo=nuxt
[nuxt-href]: https://nuxt.com/
[sponsor-src]: https://img.shields.io/badge/sponsor%20me-18181B?logo=kofi
[sponsor-href]: https://ko-fi.com/ztl_uwu