README.md

UI Doc Starter

We all know how annoying it is to setup a new documentation project. That is why this was created to help you get started quickly with Nuxt Content & UI Thing. UI Thing is just a set of Nuxt components that were styled to look like the ones from shadcn/ui.

Modules

There are several modules at play in this project:

• Nuxt Content
• Nuxt TailwindCSS
• Nuxt Color Mode
• Nuxt Icons
• Nuxt Image
• V-Wave
• Nuxt ESLint
• Nuxt PWA

Setup

Clone the repo and install the dependencies:

npx --yes giget@latest gh:BayBreezy/ui-doc-starter docs --install

Deployment

An instance is deployed on Netlify at https://ui-doc-starter.behonbaker.com

Development Server

Start the development server

# npm
npm run dev

Production

Build the application for production:

# npm
npm run build

Locally preview production build:

# npm
npm run preview

Check out the deployment documentation for more information.