getting started

Usage

Learn how you can make the UI Doc starter your own

If you already know how Nuxt Content works, you can skip this section. Just clone the repository and start writing your documentation.

Clone the repository

You can use a package like giget to clone the repository

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

After that just start the development server

Terminal
npm run dev

Docker

If you are a fan of Docker you can customize the Dockerfile and compose.yml to your liking.

Dockerfile
FROM node:20.0-alpine

WORKDIR /app

COPY package*.json ./

RUN npm install

COPY . .

ENV SITE_URL=http://localhost:3030

RUN npm run build