YDoc 文档站构建工具入门：3分钟快速搭建你的第一个静态站点

YDoc 文档站构建工具入门：3分钟快速搭建你的第一个静态站点

【免费下载链接】ydoc🐶YDoc 是一个更懂你的文档站构建工具，基于 markdown 轻松生成完整静态站点项目地址: https://gitcode.com/gh_mirrors/yd/ydoc

YDoc 是一个更懂你的文档站构建工具，基于 markdown 轻松生成完整静态站点。本文将带你快速入门 YDoc，只需3分钟即可搭建属于你的第一个静态文档站点，让你的文档展示更加专业美观。

准备工作：一键安装 YDoc

要开始使用 YDoc，首先需要安装它。确保你的电脑已经安装了 Node.js 环境，然后打开终端，执行以下命令：

npm install -g ydoc

安装完成后，你可以通过ydoc -v命令来验证是否安装成功。如果显示版本号，则说明安装成功，可以开始使用 YDoc 了。

快速搭建：3分钟创建文档站点

第一步：克隆项目仓库

首先，克隆 YDoc 的项目仓库到本地，执行以下命令：

git clone https://gitcode.com/gh_mirrors/yd/ydoc

进入克隆下来的项目目录：

cd ydoc

第二步：初始化文档站点

在项目目录下，执行 YDoc 的初始化命令，快速创建一个基础的文档站点结构：

ydoc init

执行该命令后，YDoc 会自动生成一个包含默认配置和示例文档的站点结构，你可以在docs目录下看到相关的文档文件，如 docs/index.md 等。

第三步：本地预览站点

初始化完成后，使用以下命令启动本地服务器，实时预览你的文档站点：

ydoc serve

命令执行成功后，会显示本地访问地址，通常是http://localhost:8080。打开浏览器访问该地址，你就可以看到生成的静态文档站点了。

自定义配置：打造个性化站点

YDoc 提供了丰富的配置选项，让你可以根据自己的需求自定义站点。配置文件为项目根目录下的 ydoc.js，你可以在其中设置站点标题、导航栏、主题等。

例如，你可以修改title字段来设置站点的标题，修改nav字段来配置导航菜单。修改完成后，重新执行ydoc serve命令，即可看到配置生效后的效果。

生成静态文件：部署你的站点

当你完成文档的编写和站点的配置后，可以使用以下命令生成最终的静态文件：

ydoc generate

生成的静态文件会保存在_site目录下，你可以将该目录下的文件部署到任何支持静态文件的服务器上，如 Nginx、GitHub Pages 等。

总结

通过本文的介绍，你已经了解了如何使用 YDoc 快速搭建一个静态文档站点。从安装到部署，整个过程简单高效，即使是新手也能轻松上手。YDoc 基于 markdown，让你可以专注于文档内容的编写，而无需关心复杂的站点构建细节。

如果你想进一步了解 YDoc 的更多功能，可以查看官方文档 docs/official.md，里面有详细的使用教程和高级配置说明。开始使用 YDoc，让你的文档展示更加专业吧！

【免费下载链接】ydoc🐶YDoc 是一个更懂你的文档站构建工具，基于 markdown 轻松生成完整静态站点项目地址: https://gitcode.com/gh_mirrors/yd/ydoc