Appearance

JavaFree 2025 文档系统 ​

基于 VitePress 构建的现代化技术文档平台，支持组件化主题、Element Plus UI 和多语言展示。

本项目用于展示 JavaFree 系统的功能特性、架构设计与开发指南。适用于开发者、运维人员和技术负责人查阅。

🚀 快速开始 ​

1. 环境要求 ​

  • Node.js ≥ v18.0.0
  • npm 或 pnpm（推荐使用 pnpm）

2. 获得项目代码 ​

从JavaFree 软件工作室 淘宝店 https://javafree.taobao.com/ 购买，并其他渠道获得项目代码

markdown

git clone https://gitee.com/javafree-cloud/javafree2025-docs.git
cd javafree2025-docs

3. 安装依赖 ​

bash
pnpm install

⚠️ 若使用 npm，请替换为：npm install

4. 开发模式启动（本地预览） ​

bash
pnpm docs:dev

浏览器将自动打开 http://localhost:3000，实时查看文档内容。

5. 构建生产静态文件 ​

bash
pnpm docs:build

本地查看发布效果 npx serve -s dist 构建完成后，生成的静态文件位于 dist 目录下，可部署至 CDN、Nginx、GitHub Pages 或其他静态托管服务。

6. 预览构建结果（无需部署） ​

bash
pnpm docs:preview

在本地模拟线上环境查看最终效果。

📁 项目结构说明 ​

javafree2025-docs/
├── docs/                  # 文档源码目录（Markdown 文件）
│   ├── index.md           # 主页文档
│   ├── architecture/      # 架构设计文档
│   ├── database/          # 数据库设计
│   ├── deployment/        # 部署方案
│   ├── frontend/          # 前端实现
│   ├── guide/             # 使用指南
│   ├── monitoring/        # 监控体系
│   ├── node_modules/      # 自动生成，忽略提交
│   └── ...
├── public/                # 静态资源（图片、字体等）
│   └── images/screenshots/ # 系统截图存放路径
├── .vitepress/            # VitePress 配置与自定义组件
│   ├── theme/             # 自定义主题组件
│   │   └── JavaFreeLayout.vue # 自定义布局组件
│   ├── components/        # 全局注册的 Vue 组件
│   └── config.ts          # VitePress 配置文件
├── package.json           # 项目依赖与脚本
├── vite.config.ts         # Vite 配置
└── README.md              # 当前文件

🛠️ 自定义主题功能 ​

本项目基于 @vitepress/theme-default 扩展了自定义主题：

  • 使用 @unocss/preset-wind 实现 Tailwind 类似样式
  • 引入 Element Plus 组件库增强交互体验
  • 支持图标系统：Carbon, MDI, Twemoji 等
  • 自定义布局组件 JavaFreeLayout.vue 提供统一导航和头部

🔧 高级配置 ​

使用 Element Plus 组件 ​

在 .vitepress/components 中注册了全局组件，可在 Markdown 中直接使用：

md
<el-button type="primary">点击我</el-button>

图标支持 ​

通过 @iconify-json/* 插件支持大量图标，例如：

md
<carbon:logo-vue />
<mdi:database />

🌐 部署建议 ​

方案一：GitHub Pages（推荐） ​

  1. 将 dist 目录推送到 gh-pages 分支
  2. 在 GitHub 仓库设置 → Pages → 选择 gh-pages 分支
  3. 访问：https://yourusername.github.io/javafree2025-docs

方案二：Nginx 部署 ​

nginx
server {
  listen 80;
  server_name docs.javafree.com;

  location / {
    root /var/www/javafree-docs/dist;
    try_files $uri $uri/ =404;
  }
}

📄 版权与许可 ​

本项目为 JavaFree 2025 官方文档系统，仅供内部学习与参考使用。 未经许可不得用于商业用途。如果从正规渠道购买，可自用，但不可以对外出售本项目源码

💬 联系我们 ​

如有问题，请联系我们获取技术支持。

Last updated: