增加README.md,修改 使用指南.md

This commit is contained in:
2024-08-10 21:05:54 +08:00
parent 1576a93b99
commit 38f1e5bcd4
2 changed files with 79 additions and 1 deletions

22
README.md Normal file
View File

@@ -0,0 +1,22 @@
<div align="center">
<img src="https://cdn.xyxsw.site/hdu-cs-wiki%20full.svg" alt="logo" width="450rem" height="450rem"/>
</div>
<h1 align="center">FZU-WIKI</h1>
<pre align="center">喜欢本项目可以点击右上角 star 收藏哦🎇</pre>
## 📖 项目介绍
FZU-WIKI 是福州大学星航电子工作室自发组织的一个开源项目,旨在为全校学生提供一个全面、系统、易用的小百科全书,方便新生以及在校同学快速了解学校方方面面,同时为同学提供学习和生活方面的帮助。
该项目将完全由校内全体学生共同维护,欢迎任何有想法且具备开源精神的伙伴加入到项目贡献中来,完成这项接力式项目的迭代与完善!
项目完全开源,未来计划划分多个文档模块,交由各个学院代表同学负责维护,以最大限度保证项目文档的实时性和准确性。
## 🌟 项目特色
- **全面性**:涵盖学校各个方面的信息,目前主要涵盖学习和生活两大板块。
- **易用性**:采用简洁明了的界面设计,同时支持全页面模糊查询,方便同学快速查找所需信息。
- **开放性**:项目完全开源,欢迎任何有想法且具备开源精神的伙伴加入到项目贡献中来。
- **持续更新**:项目将不断更新,确保信息的时效性和准确性。
## 🚀 项目支持
- 本项目基于hdu-cs-wiki项目进行二次开发感谢hdu-cs-wiki团队的无私奉献
- 本项目q&a模块数据来自“福州大学新生群”(QQ群号:829337155)管理员“23 落枫F.M.”对群内问答的总结,感谢落枫大佬的无私奉献!
- 本项目由星航电子工作室提供技术支持。

View File

@@ -1 +1,57 @@
 # 使用指南
<script setup>
import { onMounted, ref } from 'vue';
function detectBrowserType() {
const userAgent = navigator.userAgent;
if (userAgent.indexOf('Chrome') > -1) {
browserType.value = 'Chrome';
} else if (userAgent.indexOf('Firefox') > -1) {
browserType.value = 'Firefox';
} else if (userAgent.indexOf('Safari') > -1) {
browserType.value = 'Safari';
} else if (userAgent.indexOf('Opera') > -1 || userAgent.indexOf('OPR') > -1) {
browserType.value = 'Opera';
} else if (userAgent.indexOf('Edge') > -1) {
browserType.value = 'Edge';
} else if (userAgent.indexOf('MSIE') > -1 || userAgent.indexOf('Trident/') > -1) {
browserType.value = 'Internet Explorer';
} else {
browserType.value = 'Unknown';
}
}
const browserType = ref('');
onMounted(() => {
detectBrowserType();
});
</script>
## 如何使用本WIKI
- 推荐使用 Chromium 内核的浏览器访问例如Chrome、Edge不同浏览器可能表现不一致您当前的浏览器是<code>{{ browserType }} </code>
- 推荐使用 `暗色模式` ,以获得更好的阅读体验。点击右上角切换按钮即可切换。
- 电脑端推荐按 `Ctrl + 加号` 将页面放大到 150% 以便于阅读。
-`Ctrl + 0` 可快速将页面缩小回 100% 。
- 使用 `Ctrl + F` 快速搜索在某一页面的内容。
- 使用 `Ctrl + K` 唤起搜索框,输入关键词即可快速搜索整个 wiki 。
## 如何提交issue
- 点击进入我们的 [`Gitea`](https://gitea.xinxijishubu.asia/moyin/fzu-product) 仓库。
- 点击页面右上角 `工单` 按钮,创建工单,即可提交问题。
- 请在提交问题时,尽量详细描述问题,以便我们更好地解决您的问题。
## 如何参与贡献?
- 点击页面右上角 `编辑本页` 按钮,即可编辑页面内容。
- 请在编辑时,尽量遵循 `Markdown` 语法,以便其他用户更好地阅读。
- 如果您有其他建议,欢迎在 `讨论区` 提出。
## 如何查看历史版本?