Compare commits
2 Commits
main
..
132b2fc310
| Author | SHA1 | Date | |
|---|---|---|---|
| 132b2fc310 | |||
| b78808558b |
+3
-1
@@ -1 +1,3 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
|
docs/.vitepress/cache/
|
||||||
|
docs/.vitepress/dist/
|
||||||
|
|||||||
@@ -1,47 +1,52 @@
|
|||||||
# vuepress-theme-reco-demo
|
# Jiscuss 官方页 & 文档页
|
||||||
|
|
||||||
Blog demo1 for vuepress-theme-reco
|
这是基于 Java 的开源论坛 **Jiscuss** 的官方首页与文档站。项目文档站已从 VuePress 1 + vuepress-theme-reco 升级为 **VitePress 2.0** 架构。
|
||||||
|
|
||||||
## Experience
|
## 架构升级规划
|
||||||
|
|
||||||
**npx**
|
- 保留原有 Markdown 文章内容与静态资源,不删除历史页面。
|
||||||
|
- 使用 VitePress 2.0 替代 VuePress 1,减少主题耦合并提升启动、热更新与构建速度。
|
||||||
|
- 将站点配置迁移到 `docs/.vitepress/config.mts`,统一维护导航、侧边栏、搜索、页脚与最后更新时间。
|
||||||
|
- 将原 VuePress 首页转换为 VitePress Home Layout,并补充文档站升级说明。
|
||||||
|
- 保留旧的 `docs/.vuepress` 目录作为历史迁移参考,新架构运行时使用 `docs/.vitepress`。
|
||||||
|
|
||||||
```
|
## 目录结构
|
||||||
npx @vuepress-reco/theme-cli init my-blog
|
|
||||||
|
```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 历史配置保留
|
||||||
```
|
```
|
||||||
|
|
||||||
**npm**
|
## 开发
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# init
|
|
||||||
npm install @vuepress-reco/theme-cli -g
|
|
||||||
theme-cli init my-blog
|
|
||||||
|
|
||||||
# install
|
|
||||||
cd my-blog
|
|
||||||
npm install
|
|
||||||
|
|
||||||
# run
|
|
||||||
npm run dev
|
|
||||||
|
|
||||||
# build
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
**yarn**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# init
|
|
||||||
yarn global add @vuepress-reco/theme-cli
|
|
||||||
theme-cli init my-blog
|
|
||||||
|
|
||||||
# install
|
|
||||||
cd my-blog
|
|
||||||
yarn install
|
yarn install
|
||||||
|
|
||||||
# run
|
|
||||||
yarn dev
|
yarn dev
|
||||||
|
|
||||||
# build
|
|
||||||
yarn build
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
开发服务默认监听 `0.0.0.0`,便于本机或容器环境访问。
|
||||||
|
|
||||||
|
## 构建
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn build
|
||||||
|
yarn preview
|
||||||
|
```
|
||||||
|
|
||||||
|
构建产物输出到项目根目录的 `public/`,与原 VuePress 构建产物目录保持一致,便于沿用已有部署方式。
|
||||||
|
|
||||||
|
## Jiscuss 简介
|
||||||
|
|
||||||
|
Jiscuss 是一个简单、轻量、开源的 Java 论坛项目,目标是在简单易用的前提下提供发帖、回帖、用户管理、评论等论坛基础能力。
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT](https://github.com/chuyaoyuan)
|
||||||
|
|||||||
@@ -0,0 +1,78 @@
|
|||||||
|
import { defineConfig } from 'vitepress'
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
title: 'Jiscuss',
|
||||||
|
description: 'Jiscuss,一个简单的、基于 Java 的开源论坛。',
|
||||||
|
lang: 'zh-CN',
|
||||||
|
lastUpdated: true,
|
||||||
|
cleanUrls: true,
|
||||||
|
outDir: '../public',
|
||||||
|
head: [
|
||||||
|
['link', { rel: 'icon', href: '/favicon.ico' }],
|
||||||
|
['meta', { name: 'viewport', content: 'width=device-width,initial-scale=1,user-scalable=no' }]
|
||||||
|
],
|
||||||
|
markdown: {
|
||||||
|
lineNumbers: true
|
||||||
|
},
|
||||||
|
themeConfig: {
|
||||||
|
logo: '/head.png',
|
||||||
|
siteTitle: 'Jiscuss',
|
||||||
|
nav: [
|
||||||
|
{ text: '首页', link: '/' },
|
||||||
|
{ text: '文档', link: '/views/other/guide' },
|
||||||
|
{ text: '时间线', link: '/timeLine/' },
|
||||||
|
{ text: 'Jiscuss Demo', link: 'http://demo.jiscuss.com' },
|
||||||
|
{
|
||||||
|
text: '联系作者',
|
||||||
|
items: [
|
||||||
|
{ text: 'Yaoyuan.io', link: 'http://www.yaoyuan.io' },
|
||||||
|
{ text: 'GitHub', link: 'https://github.com/chuyaoyuan' },
|
||||||
|
{ text: 'WeChat', link: 'http://www.chuyaoyuan.com' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
sidebar: {
|
||||||
|
'/views/': [
|
||||||
|
{
|
||||||
|
text: 'Jiscuss 文档',
|
||||||
|
items: [
|
||||||
|
{ text: '快速上手', link: '/views/other/guide' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
'/timeLine/': [
|
||||||
|
{
|
||||||
|
text: '项目时间线',
|
||||||
|
items: [
|
||||||
|
{ text: 'Time Line', link: '/timeLine/' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
search: {
|
||||||
|
provider: 'local'
|
||||||
|
},
|
||||||
|
outline: {
|
||||||
|
label: '本页目录',
|
||||||
|
level: [2, 3]
|
||||||
|
},
|
||||||
|
docFooter: {
|
||||||
|
prev: '上一页',
|
||||||
|
next: '下一页'
|
||||||
|
},
|
||||||
|
lastUpdated: {
|
||||||
|
text: '最后更新',
|
||||||
|
formatOptions: {
|
||||||
|
dateStyle: 'short',
|
||||||
|
timeStyle: 'medium'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
footer: {
|
||||||
|
message: 'Released under the MIT License.',
|
||||||
|
copyright: 'Copyright © 2018-present Yaoyuan'
|
||||||
|
},
|
||||||
|
socialLinks: [
|
||||||
|
{ icon: 'github', link: 'https://github.com/chuyaoyuan' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
})
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
import DefaultTheme from 'vitepress/theme'
|
||||||
|
import './styles.css'
|
||||||
|
|
||||||
|
export default DefaultTheme
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
:root {
|
||||||
|
--vp-c-brand-1: #424242;
|
||||||
|
--vp-c-brand-2: #5f5f5f;
|
||||||
|
--vp-c-brand-3: #232321;
|
||||||
|
--vp-home-hero-name-color: transparent;
|
||||||
|
--vp-home-hero-name-background: linear-gradient(120deg, #232321 30%, #6b7280);
|
||||||
|
--vp-home-hero-image-background-image: linear-gradient(-45deg, #424242 50%, #d1d5db 50%);
|
||||||
|
--vp-home-hero-image-filter: blur(56px);
|
||||||
|
}
|
||||||
|
|
||||||
|
.VPHomeHero .image-src {
|
||||||
|
max-width: 600px;
|
||||||
|
border-radius: 1rem;
|
||||||
|
}
|
||||||
|
|
||||||
|
.VPFeature {
|
||||||
|
border-color: rgba(66, 66, 66, 0.12);
|
||||||
|
}
|
||||||
+14
-22
@@ -1,31 +1,23 @@
|
|||||||
---
|
---
|
||||||
home: true
|
title: Jiscuss
|
||||||
heroImage: /hero.png
|
|
||||||
footer: MIT Licensed | Copyright © 2018-present Evan You
|
|
||||||
heroImageStyle: {
|
|
||||||
maxWidth: '600px',
|
|
||||||
width: '100%',
|
|
||||||
display: block,
|
|
||||||
margin: '9rem auto 2rem',
|
|
||||||
background: '#fff',
|
|
||||||
borderRadius: '1rem',
|
|
||||||
}
|
|
||||||
isShowTitleInHome: false
|
|
||||||
actionText: 快速上手 →
|
|
||||||
actionLink: /views/other/guide
|
|
||||||
features:
|
|
||||||
- title: 简洁至上
|
|
||||||
details: 开发一款看着开心、写着顺手、使用简单的 开源论坛
|
|
||||||
- title: JAVA 驱动
|
|
||||||
details: 基于JAVA,使用SpringBoot + H2 Database + Semantic-UI 构建
|
|
||||||
- title: 持续完善
|
|
||||||
details: 目前的功能还很简陋,日后会一直持续完善
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
# Jiscuss
|
||||||
|
|
||||||
|
> 这里保留原 VuePress 首页文章内容。VitePress 2.0 的首页入口已迁移到 `docs/index.md`。
|
||||||
|
|
||||||
::: tip 介绍
|
::: tip 介绍
|
||||||
1. 这是一个开源JAVA项目;<br>
|
1. 这是一个开源 Java 项目;<br>
|
||||||
2. 项目追求极简;<br>
|
2. 项目追求极简;<br>
|
||||||
3. 你可以打开 [Jiscuss Demo](http://demo.jiscuss.com) 来查看效果。
|
3. 你可以打开 [Jiscuss Demo](http://demo.jiscuss.com) 来查看效果。
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
## 原首页内容
|
||||||
|
|
||||||
|
- **简洁至上**:开发一款看着开心、写着顺手、使用简单的开源论坛。
|
||||||
|
- **Java 驱动**:基于 Java,使用 Spring Boot、H2 Database、Semantic UI 构建。
|
||||||
|
- **持续完善**:目前功能还很简陋,日后会一直持续完善。
|
||||||
|
|
||||||
## 安装
|
## 安装
|
||||||
|
|
||||||
**Build**
|
**Build**
|
||||||
|
|||||||
@@ -0,0 +1,48 @@
|
|||||||
|
---
|
||||||
|
layout: home
|
||||||
|
|
||||||
|
hero:
|
||||||
|
name: Jiscuss
|
||||||
|
text: 基于 Java 的开源论坛
|
||||||
|
tagline: 简单、轻量、开源,面向发帖、回帖、用户管理与评论等论坛基础场景。
|
||||||
|
image:
|
||||||
|
src: /hero.png
|
||||||
|
alt: Jiscuss
|
||||||
|
actions:
|
||||||
|
- theme: brand
|
||||||
|
text: 快速上手
|
||||||
|
link: /views/other/guide
|
||||||
|
- theme: alt
|
||||||
|
text: 查看 Demo
|
||||||
|
link: http://demo.jiscuss.com
|
||||||
|
|
||||||
|
features:
|
||||||
|
- title: 简洁至上
|
||||||
|
details: 开发一款看着开心、写着顺手、使用简单的开源论坛。
|
||||||
|
- title: Java 驱动
|
||||||
|
details: 基于 Java,使用 Spring Boot、Spring JPA、H2 Database 与 Semantic UI 构建。
|
||||||
|
- title: 持续完善
|
||||||
|
details: 目前功能仍在迭代中,后续会持续补充文档、完善功能与优化体验。
|
||||||
|
---
|
||||||
|
|
||||||
|
::: tip 介绍
|
||||||
|
1. 这是一个开源 Java 项目;<br>
|
||||||
|
2. 项目追求极简;<br>
|
||||||
|
3. 你可以打开 [Jiscuss Demo](http://demo.jiscuss.com) 来查看效果。
|
||||||
|
:::
|
||||||
|
|
||||||
|
## 安装
|
||||||
|
|
||||||
|
**Build**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hello world!
|
||||||
|
|
||||||
|
# or
|
||||||
|
|
||||||
|
hello JAVA!
|
||||||
|
```
|
||||||
|
|
||||||
|
## 文档站升级说明
|
||||||
|
|
||||||
|
当前官方页与文档页已升级到 VitePress 2.0 架构,保留原有文章内容与静态资源,并补充了本地搜索、导航、侧边栏、最后更新时间与预览脚本。
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
@@ -0,0 +1,8 @@
|
|||||||
|
---
|
||||||
|
title: Time Line
|
||||||
|
sidebar: false
|
||||||
|
---
|
||||||
|
|
||||||
|
## Time Line
|
||||||
|
|
||||||
|
> 这里保留原 VuePress 时间线页面内容。后续可以继续追加 Jiscuss 的版本记录、里程碑与发布计划。
|
||||||
@@ -3,9 +3,9 @@ title: jiscuss文档
|
|||||||
date: 2019-09-09
|
date: 2019-09-09
|
||||||
---
|
---
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
::: tip 介绍
|
::: tip 介绍
|
||||||
1. 这是一个JAVA项目,旨在简单易用的前提下添加论坛所需的发帖、回帖、用户管理、评论等功能;<br>
|
1. 这是一个JAVA项目,旨在简单易用的前提下添加论坛所需的发帖、回帖、用户管理、评论等功能;<br>
|
||||||
@@ -50,4 +50,15 @@ date: 2019-09-09
|
|||||||
还是衷心地希望能有更多的朋友参与进来,更好地去完善它,就是希望能让Jiscuss,功能越完善,使用越来越简单。
|
还是衷心地希望能有更多的朋友参与进来,更好地去完善它,就是希望能让Jiscuss,功能越完善,使用越来越简单。
|
||||||
|
|
||||||
## License
|
## License
|
||||||
[MIT](https://github.com/chuyaoyuan)
|
[MIT](https://github.com/chuyaoyuan)
|
||||||
|
|
||||||
|
## 文档站架构
|
||||||
|
|
||||||
|
Jiscuss 官方页与文档页已升级为 VitePress 2.0:
|
||||||
|
|
||||||
|
- 配置入口:`docs/.vitepress/config.mts`
|
||||||
|
- 首页入口:`docs/index.md`
|
||||||
|
- 静态资源:`docs/public/`
|
||||||
|
- 构建产物:`public/`
|
||||||
|
|
||||||
|
本次升级保留了原有文章内容,并补充了本地搜索、导航、侧边栏、最后更新时间与预览命令,便于后续继续完善 Jiscuss 的安装、部署与二次开发文档。
|
||||||
|
|||||||
+6
-7
@@ -1,17 +1,16 @@
|
|||||||
{
|
{
|
||||||
"name": "jiscuss",
|
"name": "jiscuss",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"repository": "http://recoluan.gitlab.io/vuepress-theme-reco-doc",
|
"private": true,
|
||||||
|
"repository": "https://github.com/chuyaoyuan/jiscuss",
|
||||||
"author": "yaoyuan",
|
"author": "yaoyuan",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "vuepress dev docs",
|
"dev": "vitepress dev docs --host 0.0.0.0",
|
||||||
"build": "vuepress build docs"
|
"build": "vitepress build docs",
|
||||||
|
"preview": "vitepress preview docs --host 0.0.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"vuepress": "1.0.1",
|
"vitepress": "^2.0.0-alpha.17"
|
||||||
"vuepress-theme-reco": "1.0.8-alpha.3",
|
|
||||||
"@vuepress/plugin-medium-zoom": "1.0.3",
|
|
||||||
"vuepress-plugin-flowchart": "1.4.3"
|
|
||||||
},
|
},
|
||||||
"description": "基于JAVA的开源论坛"
|
"description": "基于JAVA的开源论坛"
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user