search

ZTL-UwU / shadcn-docs-nuxt

Effortless and beautiful docs template built with Nuxt Content & shadcn-vue.
https://shadcn-docs-nuxt.vercel.app/
MIT License
221 stars 32 forks source link

How to use in existing project #15

Closed peoray closed 3 months ago

peoray commented 3 months ago

Thanks for this template ;)

The guide does not show how to use it in an existing project. Is it possible to do so?

ZTL-UwU commented 3 months ago

Technically it is possible. You can:

  1. Install shadcn-docs-nuxt
  2. Add extends: ['shadcn-docs-nuxt'] in your nuxt.config
  3. Copy assets/, app.config.ts, and tailwind.config.ts from the starter template into your project root directory.

However, shadcn-docs-nuxt contains index.vue and [...slug].vue in pages/ as a nuxt layer, so I'm not sure if it works in existing projects.

ZTL-UwU commented 3 months ago

Closing this as using shadcn-docs-nuxt with existing project is not the recommended use case.