Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ZTL-UwU/shadcn-docs-nuxt
A nuxt content docs theme built with shadcn-vue
https://github.com/ZTL-UwU/shadcn-docs-nuxt
docs documentation-tool markdown nuxt nuxt-content shadcn-vue vue
Last synced: 16 days ago
JSON representation
A nuxt content docs theme built with 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 (4 months ago)
- Default Branch: main
- Last Pushed: 2024-05-30T14:16:17.000Z (4 months ago)
- Last Synced: 2024-05-30T17:14:41.023Z (4 months ago)
- Topics: docs, documentation-tool, markdown, nuxt, nuxt-content, shadcn-vue, vue
- Language: Vue
- Homepage: https://shadcn-docs-nuxt.vercel.app/
- Size: 457 KB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- 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]
Beautifully designed _Nuxt Content_ template built with _shadcn-vue_. **Customizable. Compatible. Open Source.**
- [Documentation / Demo](https://shadcn-docs.nuxt.dev/)
## 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. Install dependencies
```bash
npm install
```
3. Start dev server
```bash
npm run dev
```
## Contributing
1. Clone this repository
2. Install dependencies `bun install`.
3. Use `bun run dev` to start dev server.
## 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.
## 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://npmjs.com/package/shadcn-docs-nuxt
[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.js
[nuxt-href]: https://nuxt.com/