Skip to content

Commit

Permalink
Update Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
6get-xiaofan committed Sep 4, 2024
1 parent b914db3 commit f6fe2a3
Show file tree
Hide file tree
Showing 8 changed files with 61 additions and 198 deletions.
6 changes: 1 addition & 5 deletions docs/.vitepress/config/index.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import { defineConfig } from 'vitepress'
import { sharedConfig } from './shared'
import { pagefindPlugin } from 'vitepress-plugin-pagefind'

export default defineConfig({
...sharedConfig,
vite: {
plugins: [pagefindPlugin()],
}
...sharedConfig
})
6 changes: 5 additions & 1 deletion docs/.vitepress/config/shared.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress'

export const sharedConfig = defineConfig({
title: 'McHMR',
description: 'Minecraft 服务器客户端热更新解决方案',
description: 'Minecraft 服务器客户端自动更新解决方案',
appearance: 'dark',

sitemap: {
Expand Down Expand Up @@ -60,6 +60,10 @@ export const sharedConfig = defineConfig({
],

themeConfig: {
search: {
provider: 'local'
},

logo: '/logo.svg',

outline: [2, 3],
Expand Down
33 changes: 19 additions & 14 deletions docs/.vitepress/theme/styles/vars.css
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@
--c-green-soft: #633131;

/* light theme is a bit different */
--vp-c-brand-1: var(--vp-c-green-1);
--vp-c-brand-2: var(--vp-c-green-2);
--vp-c-brand-3: var(--vp-c-green-3);
--vp-c-brand-soft: var(--vp-c-green-soft);
--vp-c-brand-1: var(--c-yellow-1);
--vp-c-brand-2: var(--c-yellow-2);
--vp-c-brand-3: var(--c-yellow-3);
--vp-c-brand-soft: var(--c-yellow-soft-1);

--c-text-dark-1: #d9e6eb;
--c-text-dark-2: #c4dde6;
Expand All @@ -36,8 +36,8 @@
--c-text-light-2: #476582;
--c-text-light-3: #90a4b7;

--vp-c-brand-dark: var(--c-green-soft);
--vp-c-brand-darker: var(--c-green-soft);
--vp-c-brand-dark: var(--c-yellow-soft-1);
--vp-c-brand-darker: var(--c-yellow-soft-1);
--vp-c-brand-dimm: rgba(100, 108, 255, 0.08);
--vp-c-brand-text: var(--c-text-light-1);
--c-bg-accent: var(--c-white-dark);
Expand All @@ -53,11 +53,11 @@
}

html.dark:root {
/* --c-black: #ffffff;
--c-white: #000000; */
/* --c-divider-light: rgba(60, 60, 67, 0.12);
--c-divider-dark: rgba(84, 84, 88, 0.48); */
/* --c-brand-light: var(--c-yellow-light); */
--c-black: #ffffff;
--c-white: #000000;
--c-divider-light: rgba(60, 60, 67, 0.12);
--c-divider-dark: rgba(84, 84, 88, 0.48);
--c-brand-light: var(--c-yellow-light);

--vp-c-brand-1: var(--c-yellow-1);
--vp-c-brand-2: var(--c-yellow-2);
Expand All @@ -75,7 +75,7 @@ html.dark:root {
--c-divider: var(--c-divider-dark);
--c-bg-accent: var(--c-black-light);
/* --vp-code-inline-bg: var(--vp-c-black-light); */

/*
--vp-c-bg: var(--c-black);
--vp-c-bg-soft: var(--c-black-light);
--vp-c-bg-soft-up: var(--c-black-lighter);
Expand All @@ -93,7 +93,8 @@ html.dark:root {
var(--c-yellow-2) 30%,
var(--c-green-2)
);
}
*/
}

html.dark .DocSearch {
--docsearch-hit-active-color: var(--c-text-light-1);
Expand Down Expand Up @@ -128,7 +129,7 @@ html.dark .DocSearch {
);
--vp-home-hero-image-background-image: linear-gradient(
15deg,
var(--c-yellow-2) 65%,
var(--c-yellow-2) 15%,
var(--c-green-1) 30%
);
--vp-home-hero-image-filter: blur(40px);
Expand Down Expand Up @@ -221,4 +222,8 @@ i.el-icon {
.VPHome {
padding-bottom: 0 !important;
}
}

.brand {
color: #ffffff !important;
}
2 changes: 1 addition & 1 deletion docs/docs/guide/what-is-mchmr.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ McHMR(全称:Minecraft Hot Module Replacement) 是为解决 Minecraft 服务

McHMR 的官方指南视频预计正式版上线后发布在 Bilibili。将由开发者录制、剪辑,它涵盖了 Windows Server、Linux 的手动部署和 Docker 自动部署,及使用示例。观看视频,这是使用 McHMR 的最佳方式,当然,如果你有阅读文档的能力,可以直接参阅文档。

## 为什么叫 McHRM?
## 为什么叫 McHMR?

当年使用 McHMR 作为项目名称的初衷是通过开发热更新模组,达到游戏内的热更新,但由于种种原因放弃了,而 McHMR 这一名称被延续了下来,本质上已不再是热更新,而是通过外部程序达成自动更新。

Expand Down
3 changes: 1 addition & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,4 @@ features:
- title: 数据可视化
icon: 📦
details: 管理端可以直观看到各版本的下载量、单日/每月的下载量、服务器的玩家数量和服务器状态等。
---

---
31 changes: 31 additions & 0 deletions docs/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
page: true
title: Meet the Team
---

<script setup>
import { VPTeamMembers } from 'vitepress/theme'

const members = [
{
avatar: 'https://avatars.githubusercontent.com/u/57002549?v=4',
name: 'Gabriel Ryder',
title: '',
links: [
{ icon: 'github', link: 'https://github.com/6get-xiaofan' }
]
},
{
avatar: 'https://avatars.githubusercontent.com/u/166266777?v=4',
name: 'fusheng357',
title: '',
links: [
{ icon: 'github', link: 'https://github.com/fusheng357' }
]
}
]
</script>

# 认识团队

<VPTeamMembers size="small" :members="members" />
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@
"unplugin-auto-import": "^0.17.5",
"unplugin-element-plus": "^0.8.0",
"unplugin-vue-components": "^0.26.0",
"vitepress": "1.0.0-rc.40",
"vitepress-plugin-pagefind": "^0.4.10"
"vitepress": "1.0.0-rc.40"
},
"type": "module"
}
Loading

0 comments on commit f6fe2a3

Please sign in to comment.