【源码】基于Hugo和Docsy主题的技术文档网站生成器

项目简介

本项目是基于Hugo和Docsy主题的技术文档网站生成器，可帮助用户快速搭建与部署技术文档网站。Docsy是专门为技术文档设计的Hugo主题，具备便捷的目录导航与结构化布局等功能。项目借助本地化的JavaScript库，适合在无互联网访问或访问延迟大的环境中部署。

项目的主要特性和功能

1. 可快速搭建文档网站，用户复制项目和子模块就能快速建立自己的技术文档网站。
2. 支持本地化，采用全本地化的JavaScript库，适用于无互联网访问的环境。
3. 支持多种文档格式，如.html和.md格式的文档源文件。
4. 能进行UML图绘制，支持使用PlantUML和Mermaid在文档中绘制UML图。
5. 可生成PDF文档，使用wkhtmltopdf工具能将文档网站生成为PDF格式。
6. 生成静态网站，通过Hugo生成静态文档网站，并可部署到Nginx服务器上。

安装使用步骤

1. 复制项目

复制本项目及其子模块： bash git clone --recurse-submodules https://gitee.com/henry-tech/docsy-example.git my-project-docs

2. 下载Hugo

下载并安装支持SCSS编译的Hugo扩展版本（hugo_extended_*）。

3. 安装Node.js和NPM

安装Node.js和NPM用于后续的依赖管理： bash https://nodejs.org

4. 编写和预览文档

进入项目目录，启动Hugo服务器进行文档编写和预览： bash cd my-project-docs hugo server 打开浏览器，访问http://localhost:1313/查看文档。

5. 生成静态文档网站

使用以下命令生成静态文档网站： bash npm install hugo 生成的静态文档网站位于public/目录下。

6. 部署到Nginx

将public/目录下的文件复制到Nginx的html目录下，即可在浏览器中访问生成的文档网站： bash http://nginx.org/en/download.html

7. 使用PlantUML和Mermaid绘制UML图

在.md文件中直接书写PlantUML或Mermaid代码，即可在文档中嵌入UML图。

8. 生成PDF文档

使用wkhtmltopdf工具将文档网站生成为PDF格式： bash wkhtmltopdf --print-media-type --javascript-delay 2000 http://localhost:1313/en/docs/getting-started/ getting-started.pdf

下载地址

点击下载 【提取码: 4003】【解压密码: www.makuang.net】