53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
# Jiscuss 官方页 & 文档页
|
|
|
|
这是基于 Java 的开源论坛 **Jiscuss** 的官方首页与文档站。项目文档站已从 VuePress 1 + vuepress-theme-reco 升级为 **VitePress 2.0** 架构。
|
|
|
|
## 架构升级规划
|
|
|
|
- 保留原有 Markdown 文章内容与静态资源，不删除历史页面。
|
|
- 使用 VitePress 2.0 替代 VuePress 1，减少主题耦合并提升启动、热更新与构建速度。
|
|
- 将站点配置迁移到 `docs/.vitepress/config.mts`，统一维护导航、侧边栏、搜索、页脚与最后更新时间。
|
|
- 将原 VuePress 首页转换为 VitePress Home Layout，并补充文档站升级说明。
|
|
- 保留旧的 `docs/.vuepress` 目录作为历史迁移参考，新架构运行时使用 `docs/.vitepress`。
|
|
|
|
## 目录结构
|
|
|
|
```text
|
|
docs/
|
|
index.md # VitePress 首页
|
|
README.md # 原首页内容保留
|
|
timeLine/
|
|
index.md # VitePress 时间线入口
|
|
README.md # 原时间线内容保留
|
|
views/other/guide.md # Jiscuss 文档正文
|
|
public/ # VitePress 静态资源
|
|
.vitepress/ # VitePress 2.0 配置与主题扩展
|
|
.vuepress/ # VuePress 1 历史配置保留
|
|
```
|
|
|
|
## 开发
|
|
|
|
```bash
|
|
yarn install
|
|
yarn dev
|
|
```
|
|
|
|
开发服务默认监听 `0.0.0.0`，便于本机或容器环境访问。
|
|
|
|
## 构建
|
|
|
|
```bash
|
|
yarn build
|
|
yarn preview
|
|
```
|
|
|
|
构建产物输出到项目根目录的 `public/`，与原 VuePress 构建产物目录保持一致，便于沿用已有部署方式。
|
|
|
|
## Jiscuss 简介
|
|
|
|
Jiscuss 是一个简单、轻量、开源的 Java 论坛项目，目标是在简单易用的前提下提供发帖、回帖、用户管理、评论等论坛基础能力。
|
|
|
|
## License
|
|
|
|
[MIT](https://github.com/chuyaoyuan)
|