项目简介
本项目借助Docusaurus静态网站生成器搭建了ThingsPanel文档系统,可在线展示项目文档、博客、API参考等内容,帮助用户更好地理解和使用ThingsPanel项目。
项目的主要特性和功能
- 采用Docusaurus生成静态网站,加载速度快,用户体验良好。
- 支持多版本文档管理,用户能按需切换版本查看不同文档。
- 集成Crowdin翻译工具,实现自动化翻译,支持多语言。
- 提供可配置的导航和侧边栏,方便用户查找信息。
- 具备博客功能,可发布最新消息和教程。
安装使用步骤
1. 环境准备
确保已下载本项目的源码文件。
2. 安装依赖
在项目根目录下执行命令:
bash
$ yarn
3. 本地开发
运行以下命令启动本地开发服务器:
bash
$ yarn start
此命令会自动在浏览器中打开网站,且多数更改可实时呈现,无需重启服务器。
4. 项目构建
运行以下命令生成静态内容:
bash
$ yarn build
5. 项目部署
具体部署方式可参考项目内README文件。
6. 翻译配置
在crowdin.yml
文件中配置Crowdin API token,然后运行相关命令完成翻译和同步,具体步骤见项目内README文件。
7. 菜单与侧边栏配置
通过修改docusaurus.config.js
文件配置顶导航、底部及侧边栏,配置方式见项目内README文件。
编写文档或博客
- 博客:进入
blog
文件夹,按指定命名规则创建新博客文章。 - 文档:进入
docs
或versioned_docs
文件夹,创建新路由文件并编写文档内容,具体文件结构和命名规则见项目内README文件。
注意:内容添加或修改后,需运行翻译和打包命令更新网站,再通过FTP或Git将更新后的文件上传至服务器展示,服务器登录信息见项目内README文件。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】