Skip to content
/ ui-doc-starter Public template

A Nuxt.js starter template for creating a documentation website. Built with UI Thing & Nuxt Content.

License

Notifications You must be signed in to change notification settings

BayBreezy/ui-doc-starter

Repository files navigation

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:

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

Netlify Status

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.

About

A Nuxt.js starter template for creating a documentation website. Built with UI Thing & Nuxt Content.

Topics

Resources

License

Stars

Watchers

Forks