Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

shadcn-docs-nuxt

ZTL-UwU2kMIT1.0.2TypeScript support: included

Effortless and beautiful docs template built with Nuxt Content & shadcn-vue.

markdown, docs, vue, nuxt, documentation-tool, nuxt-content, shadcn-vue

readme

hero

shadcn-docs-nuxt

built with nuxt npm version npm downloads License sponsor

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

License

MIT


Buy Me a Coffee at ko-fi.com