https://github.com/ztl-uwu/shadcn-docs-nuxt
Effortless and beautiful docs template built with Nuxt Content & shadcn-vue.
https://github.com/ztl-uwu/shadcn-docs-nuxt
docs documentation-tool markdown nuxt nuxt-content shadcn-vue vue
Last synced: about 1 year ago
JSON representation
Effortless and beautiful docs template built with Nuxt Content & shadcn-vue.
- Host: GitHub
- URL: https://github.com/ztl-uwu/shadcn-docs-nuxt
- Owner: ZTL-UwU
- License: mit
- Created: 2024-05-20T10:23:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-09T12:26:29.000Z (about 1 year ago)
- Last Synced: 2025-05-09T13:41:34.138Z (about 1 year ago)
- Topics: docs, documentation-tool, markdown, nuxt, nuxt-content, shadcn-vue, vue
- Language: Vue
- Homepage: https://shadcn-docs-nuxt.vercel.app/
- Size: 5.82 MB
- Stars: 478
- Watchers: 8
- Forks: 75
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://shadcn-docs-nuxt.vercel.app/)
💬 [Discord](https://discord.gg/9P5HzAz8DT)
## Quick Start
1. Create a project with the [starter template](https://github.com/ZTL-UwU/shadcn-docs-nuxt-starter)
```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](https://content.nuxt.com/): Content made easy for Vue Developers.
- [shadcn-ui](https://ui.shadcn.com/): For the beautiful component & docs design.
- [shadcn-vue](https://www.shadcn-vue.com/): For the vue port of shadcn-ui & some docs component source.
- [Docus](https://docus.dev/): For the inspiration & some docs component source.
- [Nuxt UI Pro Docs](https://docs-template.nuxt.dev/): For the inspiration.
## Who's Using
- [unovue/inspira-ui](https://github.com/unovue/inspira-ui) 1.9K ⭐️
- [unjs/magic-regexp](https://github.com/unjs/magic-regexp) 4K ⭐️
- [nuxt-monaco-editor](https://github.com/e-chan1007/nuxt-monaco-editor)
- [nuxt-umami](https://github.com/ijkml/nuxt-umami)
- [Msty](https://docs.msty.app/getting-started/onboarding)
- [Archiver](https://github.com/Ast3risk-ops/archiver)
- [Add your project 🚀](https://github.com/ZTL-UwU/shadcn-docs-nuxt/edit/main/README.md)
## License
[MIT](https://github.com/ZTL-UwU/shadcn-docs-nuxt/blob/main/LICENSE)
---
[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