NuxtVue文档启动器

ui-doc-starter — Nuxt 文档模板

作者 BayBreezy

基于 Nuxt 的文档站点启动模板，使用 Nuxt Content 管理内容，并以 UI Thing 组件库搭建界面。

打开源站下载源码 ZIP

看看你的网站会是什么样

浏览真实页面截图，比较内容排版与手机效果。点击下方缩略图切换，放大查看整页细节。

2 个预览视图

桌面端首页1 / 2

访问演示网站在新标签页打开

桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

全部页面与视图 2

截图用于了解视觉与布局，交互效果请以实际项目为准。

采集于 2026-10-02查看来源

值得关注的模板亮点

从已有项目资料中，快速了解它的特点。

使用 Nuxt Content 作为文档内容层

界面基于 UI Thing 组件库，风格接近 shadcn/ui

集成 TailwindCSS、Color Mode、Icons、Image 等常用模块

包含 ESLint 与 PWA 模块配置

提供开发、构建、预览的 npm 脚本

MIT 许可，可商用与分发

模板详细介绍

这是一个面向文档站点的 Nuxt 启动模板，目标是把新建文档项目时繁琐的初始化工作提前做好。内容层使用 Nuxt Content，界面组件来自 UI Thing——一组按 shadcn/ui 风格设计的 Nuxt 组件。模板同时接入 TailwindCSS、Color Mode、Icons、Image、V-Wave、ESLint 与 PWA 等模块，并提供开发、构建与本地预览的 npm 脚本。

仓库以 MIT 许可发布，可免费使用、修改、商用和分发，但需保留版权与许可声明；演示站点部署在 Netlify。模板本身不包含文档内容，实际页面与导航需要按 Nuxt Content 的方式自行编写。

Nuxt文档启动器

适合你的项目吗？

适用场景

为开源项目或产品搭建文档站点
在 Nuxt 项目中试用 Nuxt Content 与 UI Thing 组合
需要一个已配置好常用模块的文档项目起点

适合人群

熟悉 Nuxt 的前端开发者
需要快速起一个文档站点的团队
希望使用 shadcn/ui 风格组件的项目

上手与定制指南

结合仓库当前版本的说明，按下面的资料检查内容、配置与运行要求。

1
使用 npx --yes giget@latest gh:BayBreezy/ui-doc-starter docs --install 拉取模板并安装依赖
2
开发运行 npm run dev，生产构建 npm run build，本地预览 npm run preview
3
演示站点部署在 Netlify，可参考 Nuxt 官方部署文档
4
模板不含现成文档内容，需自行编写 Markdown 内容与导航
5
演示图片、字体、图标等第三方素材需单独核对其许可

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本；免费范围为该版本代码，不代表外部服务或第三方素材免费。

使用时需要遵守

允许免费使用、修改、商用和分发该版本代码。
分发代码副本或实质性部分时，保留原作者版权声明和完整 MIT 许可声明。
代码按现状提供；担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

演示图片、字体、图标及其他第三方素材需按各自许可核对，不能仅凭代码的 MIT 许可判断。
域名、托管、数据库、支付或 AI 等外部服务可能另外收费。

查看原文依据

Permission is hereby granted, free of charge
许可证原文

https://github.com/BayBreezy/ui-doc-starter/blob/main/LICENSE.md https://github.com/BayBreezy/ui-doc-starter/blob/main/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-02。结果仅覆盖已读取资料，依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台: GitHub
资料与维护参考分: 资料较完整 · 86 / 100
技术栈: Nuxt · Vue
网站类型: 文档 · 启动器

这个分数如何计算

本站按许可资料（最高30分）、演示链接（12分）、预览图（10分）、Star数（15分）、记录的维护时间（15分）、描述完整度（8分）、功能记录（5分）和分类资料（5分）计算。它不是代码、安全或性能测试，也不是 Google 评分；有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间: 2025-03-02
截图检查日期: 2026-10-02

已收录演示链接。请用你的内容与屏幕尺寸检查；有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 Nuxt。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料，不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

已完成服务器许可规则与 AI 来源核对；未经过人工编辑审核。

查看当时使用的来源资料

SHA-256: 1ed1a394be4e597935fec989b87f193d04212dcf2ed61f6bbd5875d30454736d

2026-10-02T17:23:34.826Z

来源文件 / 仓库

# 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](https://content.nuxt.com/) & [UI Thing](https://ui-thing.behonbaker.com/getting-started/introduction). UI Thing is just a set of Nuxt components that were styled to look like the ones from [shadcn/ui](https://ui.shadcn.com/).

## Modules

There are several modules at play in this project:

- [Nuxt Content](https://content.nuxt.com/)
- [Nuxt TailwindCSS](https://tailwindcss.nuxtjs.org/)
- [Nuxt Color Mode](https://color-mode.nuxtjs.org/)
- [Nuxt Icons](https://github.com/nuxt/icon)
- [Nuxt Image](https://image.nuxt.com/)
- [V-Wave](https://github.com/justintaddei/v-wave?tab=readme-ov-file#nuxt-)
- [Nuxt ESLint](https://eslint.nuxt.com/packages/module)
- [Nuxt PWA](https://vite-pwa-org.netlify.app/frameworks/nuxt.html#nuxt-3)

## Setup

Clone the repo and install the dependencies:

```bash
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](https://api.netlify.com/api/v1/badges/64f5f619-4c60-4d32-bd92-ebed3f118dad/deploy-status)](https://app.netlify.com/sites/sprightly-rolypoly-6aa2cc/deploys)

## Development Server

Start the development server

```bash
# npm
npm run dev
```

## Production

Build the application for production:

```bash
# npm
npm run build
```

Locally preview production build:

```bash
# npm
npm run preview
```

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

反馈内容错误