From c0ffa3052334fd3fc14fefd1dbc7b0185e8bb489 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?DL=E8=8B=A5=E5=BD=B1?= <1843370860@qq.com> Date: Mon, 2 Sep 2024 18:14:46 +0800 Subject: [PATCH] =?UTF-8?q?chore:=E5=90=8C=E6=AD=A5=E4=BB=A3=E7=A0=81?= =?UTF-8?q?=EF=BC=8C=E6=B7=BB=E5=8A=A0logo=EF=BC=8C=E5=88=A0=E9=99=A4md?= =?UTF-8?q?=E6=96=87=E4=BB=B6=E5=A4=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/.vitepress/config.js | 53 +++++++++++----- docs/about/index.md | 3 + docs/features/index.md | 127 ++++++++++++++++++++++++++++++++++++++ docs/guide/index.md | 51 +++++++++++++++ docs/index.md | 35 +++++++---- docs/public/gitee.js | 16 +++++ docs/public/gitee.svg | 20 ++++++ docs/public/logo-dark.svg | 8 +++ docs/public/logo.svg | 7 +++ {md => docs/todo}/plan.md | 0 md/May.md | 5 -- md/README copy.md | 29 --------- md/lrsNotes.md | 68 -------------------- public/logo.svg | 2 +- 14 files changed, 295 insertions(+), 129 deletions(-) create mode 100644 docs/about/index.md create mode 100644 docs/public/gitee.js create mode 100644 docs/public/gitee.svg create mode 100644 docs/public/logo-dark.svg create mode 100644 docs/public/logo.svg rename {md => docs/todo}/plan.md (100%) delete mode 100644 md/May.md delete mode 100644 md/README copy.md delete mode 100644 md/lrsNotes.md diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 5d6cf09..42d38f5 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -1,16 +1,20 @@ import {defineConfig} from 'vitepress' -const gitee_icon_svg = '\n' + '\n' + '\n' + ' \n' + ' Gitee\n' + ' \n' + '' +import gitee from '../public/gitee.js'; export default defineConfig({ - base: './', + base: '/', lang: 'zh-CN', title: "狼人杀在线笔记", description: "为狼人杀游戏玩家设计的在线笔记工具", themeConfig: { + logo: { + light: '/logo.svg', + dark: '/logo-dark.svg' + }, nav: [ {text: '主页', link: '/'}, - {text: '使用指南', link: '/guide/'}, + {text: '简介', link: '/guide/'}, {text: '功能介绍', link: '/features/'}, {text: '待开发功能', link: '/todo/'}, {text: '关于项目', link: '/about/'}, @@ -18,23 +22,20 @@ export default defineConfig({ sidebar: [ { - text: '使用指南', + text: '简介', items: [ - {text: '快速开始', link: '/guide/'}, + {text: '前言', link: '/guide/'}, ] }, { text: '功能介绍', items: [ - {text: '自动保存', link: '/features/#自动保存笔记信息'}, - {text: '版型选择', link: '/features/#官狼各游戏版型选择'}, - {text: '快捷记录', link: '/features/#快捷记录起跳关键信息'}, + {text: '自动保存', link: '/features/#💾-添加自动保存笔记信息'}, + {text: '版型选择', link: '/features/#📜-官狼各游戏版型选择'}, + {text: '快捷记录', link: '/features/#⚡-快捷记录起跳关键信息'}, + {text: '导出记录', link: '/features/#⚡-导出游戏记录信息'}, ] }, - { - text: '待开发功能', - link: '/todo/' - }, { text: '关于项目', link: '/about/' @@ -43,12 +44,34 @@ export default defineConfig({ socialLinks: [ {icon: 'github', link: 'https://github.com/syhy0612/lrsNotes'}, - {icon: {svg: gitee_icon_svg}, link: 'https://gitee.com/syhy0612/lrsNotes'} + {icon: {svg: gitee}, link: 'https://gitee.com/syhy0612/lrsNotes'} ], footer: { message: `基于 MIT 许可发布`, copyright: `版权所有 © 2024 syhy0612 | 湘ICP备2024080657号-1` - } - } + }, + + docFooter: { + // prev: '上一页', + // next: '下一页' + prev: false, + next: false + }, + + outline: { + label: '页面导航' + }, + + langMenuLabel: '多语言', + returnToTopLabel: '回到顶部', + sidebarMenuLabel: '菜单', + darkModeSwitchLabel: '主题', + lightModeSwitchTitle: '切换到浅色模式', + darkModeSwitchTitle: '切换到深色模式' + }, + appearance: 'auto', + head: [ + ['link', {rel: 'icon', type: 'image/svg+xml', href: '/logo.svg'}] + ], }) \ No newline at end of file diff --git a/docs/about/index.md b/docs/about/index.md new file mode 100644 index 0000000..0e5c4a9 --- /dev/null +++ b/docs/about/index.md @@ -0,0 +1,3 @@ +# 关于 + +举头思故乡 \ No newline at end of file diff --git a/docs/features/index.md b/docs/features/index.md index e69de29..14c923d 100644 --- a/docs/features/index.md +++ b/docs/features/index.md @@ -0,0 +1,127 @@ +# 🐺 狼人杀在线笔记 + +狼人杀在线笔记是一个为狼人杀游戏玩家设计的工具，方便玩家记录发言信息并导出，提高游戏体验。 + +📌 在线使用：[点击访问](https://lrs-notes.vercel.app) + +## 📒 功能介绍 + +### 💾 添加自动保存笔记信息 + +当用户在笔记内输入信息时，信息会自动保存到浏览器内存中，笔记信息需要手动重置才会清除，无需担心笔记信息丢失。 + +> Tip： 除非用户开了访客模式。 + +### 📜 官狼各游戏版型选择 + +#### 常驻开放场 + +| 版型名称 | 版型配置 | +|:-----|:-----------------------| +| 觉醒女巫 | 3狼-觉狼-4民-预-守-猎-觉女 | +| 标准场 | 4狼-4民-预-女-猎-愚 | +| 奇迹商人 | 3狼-狼王-4民-预-守-女-商 | +| 镜隐迷踪 | 3狼-觉隐-4民-镜-猎-女-守 | +| 丘比特场 | 2狼-狼王-5民-预-女-猎-愚-丘-千面人 | + +#### 每周轮播场 + +| 版型名称 | 版型配置 | +|:-------|:--------------------| +| 觉醒孤独少女 | 4狼-3民-预-女-梦-猎-觉-孤 | +| 狼美人骑士 | 3狼-美-4民-预-女-守-骑 | +| 赤月猎魔人 | 3狼-赤月-4民-预-女-愚-猎魔 | +| 狼王守卫 | 3狼-狼王-4民-预-女-猎-守 | +| 白狼王骑士 | 3狼-白狼王-4民-预-女-守-骑 | +| 纯白夜影 | 3狼-巫-4民-守-女-猎-纯 | +| 动物梦境 | 3狼-美-4羊驼-白猫-河豚-子狐-熊 | +| 寻香识命 | 3狼-香-4民-守-女-猎-觉预 | +| 觉醒之夜 | 3狼-贵-4民-预-女-猎魔-觉愚 | +| 永序之轮 | 3狼-狼妃-4民-预-守-女-王子 | +| 孤独少女 | 4狼-3民-预-女-猎-守-孤独 | +| 噩梦之影 | 3狼-噩-4民-预-女-猎-梦 | +| 时波之乱 | 3狼-寂夜-4民-预-守-女-白昼 | +| 觉醒狼王 | 3狼-觉王-4民-预-女-商-梦 | +| 狼王摄梦人 | 3狼-狼王-4民-预-女-猎-梦 | +| 恶夜骑士 | 3狼-恶夜-4民-预-女-猎-守 | +| 狼王魔术师 | 3狼-狼王-4民-预-女-猎-术 | +| 白狼王守卫 | 3狼-白狼王-4民-预-女-猎-守 | +| 石像鬼守墓人 | 3狼-石-4民-预-女-猎-墓 | +| 迷雾鸦爪 | 3狼-狼鸦-4民-预-愚-梦-炼金 | +| 咒狐乌鸦 | 2狼-狼王-4民-预-女-猎-鸦-咒狐 | +| 猎日逐光 | 3狼-侍-4民-预-女-梦-爵 | + +> Tip：截止网易狼人杀2024-08-17的开放版型。 + +### ⚡ 快捷记录起跳关键信息 + +#### 省流说明 + +1. 在任意玩家的发言信息框内输入`C`。 +2. 系统会弹出多个预设选项，如`跳-预言家-发金水`、`跳-预言家-发查杀`等。 +3. 选择合适的选项后，即可自动填入相应的模版信息。 + +#### 参考示例 + +| 记作/RecordAs | 解释/Describe | +|-----------------|------------------------------------------| +| C预@2查杀/7.11.12/ | 玩家起跳预言家，发2号查杀，警徽流7号、11号、12号。 | +| C女巫@6银水 | 玩家起跳女巫，发6号银水。 | +| A镜@9猎人/2.6.9/ | 玩家起跳魔镜少女，发9号猎人，警徽流2号、6号、9号，后放弃起跳。 | +| C守卫/0/ | 玩家起跳守卫，第一天空盾。 | + +#### 补充说明 + +`C`：Claim （选择起跳声称某种身份） + +`A`：Abandon（放弃起跳或声称某种身份） + +`0`：对施放技能玩家号码的默认值，在警徽流里也代指空。 + +> Tip 1：后续可能会添加其他版型的起跳信息，并按照版型去归纳，敬请期待。 +> +> Tip 2：暂不打算添加多次起跳身份情况的记录方案，如果有好的建议，欢迎提`Issue`。 + +## 💡 项目背景 + +这个小项目源于我观看狼人杀游戏直播时的一个发现。我注意到大多数主播用记事本等工具记录游戏中的发言信息，觉得不太方便。于是我在网上查找有关狼人杀的笔记工具，但遗憾的是，那时的我并没有找到特别合适的工具。 + +2024年6月初，实习结束后，我决定自己尝试制作一个专门的狼人杀在线笔记页面。作为前端小白，借助AI工具，我花了两周时间东拼西凑做了一个简易版本，那时候只会用基础的`HTML`、`CSS` +和一点点`JavaScript` +，连怎么修改角色标记都不会，最后不得不暂时搁置。虽然做得很不专业，但那个简易的版本见证了新版本的起点。我把它保存在了`old` +分支里，作为我学习历程的一个纪念。 + +2024年7月初，因工作需要，我开始学习`Vue3`的基础，以及`Echarts`和`Element Plus`的简单使用。 + +2024年8月初，因试用期能力不足，我从公司离职，这次经历让我认识到自己还有很多需要学习的地方。离职后，我决定重新投入到这个项目中，借此机会提升自己的技能。我用`Vue3` +框架重写了这个项目，新版本放在了`main`分支。借助`Claude`等AI工具的帮助，我逐步改进了这个小项目。虽然比最初的尝试有所进步，但我清楚还有很大的提升空间。 + +## 👨‍💻 开发者说明 + +这个小项目采用了MIT协议开源。如果您觉得它有任何可取之处： + +- 欢迎Fork去自由修改，也许您能把它变得更好。 +- [MIT许可证](https://opensource.org/license/MIT)允许您在遵守协议的前提下自由使用和分发。 + +由于我的技术水平还很有限，可能无法处理复杂的改动，但非常欢迎： + +- 在Issues中分享您的想法或建议，无论大小。 +- 如果您做了什么有趣的改进，也欢迎在Issues里告诉大家。 + +## 💬 反馈与交流 + +如果您在使用过程中有任何问题、建议或想法，欢迎提Issue交流。 + +Issue：[点击跳转](https://github.com/syhy0612/lrsNotes/issues) + +Email：syhy0612@163.com + +> Tip：也可以发邮箱留下联系方式交流。 + +感谢您对这个小项目的关注，祝您游戏愉快！ + +如果您觉得这个项目对您有所帮助，欢迎点个star⭐支持一下。 + +## ⭐ Star历史 + +[![Star History Chart](https://api.star-history.com/svg?repos=syhy0612/lrsNotes&type=Date)](https://star-history.com/#syhy0612/lrsNotes&Date) diff --git a/docs/guide/index.md b/docs/guide/index.md index e69de29..d27451f 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -0,0 +1,51 @@ +# 狼人杀在线笔记 + +狼人杀在线笔记是一个为狼人杀游戏玩家设计的工具，方便玩家记录发言信息并导出，提高游戏体验。 + +在线使用：[点击访问](https://lrs-notes.vercel.app) + + + +## 💡 项目背景 + +这个小项目源于我观看狼人杀游戏直播时的一个发现。我注意到大多数主播用记事本等工具记录游戏中的发言信息，觉得不太方便。于是我在网上查找有关狼人杀的笔记工具，但遗憾的是，那时的我并没有找到特别合适的工具。 + +2024年6月初，实习结束后，我决定自己尝试制作一个专门的狼人杀在线笔记页面。作为前端小白，借助AI工具，我花了两周时间东拼西凑做了一个简易版本，那时候只会用基础的`HTML`、`CSS` +和一点点`JavaScript` +，连怎么修改角色标记都不会，最后不得不暂时搁置。虽然做得很不专业，但那个简易的版本见证了新版本的起点。我把它保存在了`old` +分支里，作为我学习历程的一个纪念。 + +2024年7月初，因工作需要，我开始学习`Vue3`的基础，以及`Echarts`和`Element Plus`的简单使用。 + +2024年8月初，因试用期能力不足，我从公司离职，这次经历让我认识到自己还有很多需要学习的地方。离职后，我决定重新投入到这个项目中，借此机会提升自己的技能。我用`Vue3` +框架重写了这个项目，新版本放在了`main`分支。借助`Claude`等AI工具的帮助，我逐步改进了这个小项目。虽然比最初的尝试有所进步，但我清楚还有很大的提升空间。 + +## 👨‍💻 开发者说明 + +这个小项目采用了MIT协议开源。如果您觉得它有任何可取之处： + +- 欢迎Fork去自由修改，也许您能把它变得更好。 +- [MIT许可证](https://opensource.org/license/MIT)允许您在遵守协议的前提下自由使用和分发。 + +由于我的技术水平还很有限，可能无法处理复杂的改动，但非常欢迎： + +- 在Issues中分享您的想法或建议，无论大小。 +- 如果您做了什么有趣的改进，也欢迎在Issues里告诉大家。 + +## 💬 反馈与交流 + +如果您在使用过程中有任何问题、建议或想法，欢迎提Issue交流。 + +Issue：[点击跳转](https://github.com/syhy0612/lrsNotes/issues) + +Email：syhy0612@163.com + +> Tip：也可以发邮箱留下联系方式交流。 + +感谢您对这个小项目的关注，祝您游戏愉快！ + +如果您觉得这个项目对您有所帮助，欢迎点个star⭐支持一下。 + +## ⭐ Star历史 + +[![Star History Chart](https://api.star-history.com/svg?repos=syhy0612/lrsNotes&type=Date)](https://star-history.com/#syhy0612/lrsNotes&Date) diff --git a/docs/index.md b/docs/index.md index 82df2fd..9402eff 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,21 +5,34 @@ hero: name: "狼人杀在线笔记" text: "专为狼人杀玩家设计" tagline: 方便玩家记录发言信息并导出，提高游戏体验 + image: + src: ./public/logo.svg + alt: 狼人杀在线笔记 actions: - theme: brand text: 开始使用 link: http://lrsnotes.cc - theme: alt - text: 帮助文档 - link: /guide/ + text: 功能介绍 + link: /features/ features: - - title: 自动保存笔记信息 - details: 当用户在笔记内输入信息时，信息会自动保存到浏览器内存中，无需担心笔记信息丢失 - - title: 官狼各游戏版型选择 - details: 支持常驻开放场和每周轮播场等多种游戏版型，满足不同玩家的需求 - - title: 快捷记录起跳关键信息 - details: 通过简单的快捷操作，快速记录玩家的起跳和关键信息，提高记录效率 - - title: PC端可自定义布局 - details: 为PC用户提供灵活的布局自定义选项，优化使用体验 ---- \ No newline at end of file + - icon: 💾 + title: 自动保存笔记信息 + details: 当用户在笔记内输入信息时，信息会自动保存到浏览器内存中，无需担心笔记信息丢失。 + - icon: 📜 + title: 官狼各游戏版型选择 + details: 支持常驻开放场和每周轮播场等多种游戏版型，满足不同玩家的需求。 + - icon: ⚡ + title: 快捷记录起跳关键信息 + details: 通过简单的快捷操作，快速记录玩家的起跳和关键信息，提高记录效率。 + - icon: 📤 + title: PC端可自定义布局 + details: 为PC用户提供灵活的布局自定义选项，优化使用体验。 +--- + + \ No newline at end of file diff --git a/docs/public/gitee.js b/docs/public/gitee.js new file mode 100644 index 0000000..37ba99a --- /dev/null +++ b/docs/public/gitee.js @@ -0,0 +1,16 @@ +export default "\n" + +" \n" + +" logo\n" + +" Created with Sketch.\n" + +" \n" + +" \n" + +" \n" + +" \n" + +" \n" + +" \n" + +" \n" + +" \n" + +" \n" + +" \n" + +"" diff --git a/docs/public/gitee.svg b/docs/public/gitee.svg new file mode 100644 index 0000000..e9a5886 --- /dev/null +++ b/docs/public/gitee.svg @@ -0,0 +1,20 @@ + + + + Gitee\n' + ' + + diff --git a/docs/public/logo-dark.svg b/docs/public/logo-dark.svg new file mode 100644 index 0000000..fed46d1 --- /dev/null +++ b/docs/public/logo-dark.svg @@ -0,0 +1,8 @@ + + + + + + + diff --git a/docs/public/logo.svg b/docs/public/logo.svg new file mode 100644 index 0000000..b89badf --- /dev/null +++ b/docs/public/logo.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/md/plan.md b/docs/todo/plan.md similarity index 100% rename from md/plan.md rename to docs/todo/plan.md diff --git a/md/May.md b/md/May.md deleted file mode 100644 index 1f139c9..0000000 --- a/md/May.md +++ /dev/null @@ -1,5 +0,0 @@ -# 可能要用到的计划或想法布局 - -Dialog 对话框 - -Message 消息提示 \ No newline at end of file diff --git a/md/README copy.md b/md/README copy.md deleted file mode 100644 index 8e4c4f4..0000000 --- a/md/README copy.md +++ /dev/null @@ -1,29 +0,0 @@ -# lrsNotes - -This template should help get you started developing with Vue 3 in Vite. - -## Recommended IDE Setup - -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). - -## Customize configuration - -See [Vite Configuration Reference](https://vitejs.dev/config/). - -## Project Setup - -```sh -npm install -``` - -### Compile and Hot-Reload for Development - -```sh -npm run dev -``` - -### Compile and Minify for Production - -```sh -npm run build -``` diff --git a/md/lrsNotes.md b/md/lrsNotes.md deleted file mode 100644 index 7f3c52e..0000000 --- a/md/lrsNotes.md +++ /dev/null @@ -1,68 +0,0 @@ -# 并不成熟的模版 - -个人使用，仅供参考 - -C：claim 起跳声称某种身份 - -U：give_up/un_claim 放弃起跳或声称某种身份 - -记作：[01] C预@2查杀/7.11.12/ -解释：1号玩家起跳预言家，发2号查杀 警徽流7号,11号,12号。 - -记作：[02] C巫@6银水 -解释：2号玩家起跳女巫，发6号银水。 - -记作：[01] U预@2查杀/7.11.12/ -解释：1号玩家起跳预言家，后放手放弃起跳。 - -**常驻：** - -觉醒孤独少女 4狼-3民-预-女-梦-猎-觉狐 - -标准场 4狼-4民-预-女-猎-愚 - -镜隐迷踪 3狼-觉隐-4民-镜-猎-女-守 - -奇迹商人 3狼-狼王-4民-预-守-女-商 - -丘比特场 2狼-狼王-5民-预-女-猎-愚-丘-千面人 - -**轮换：** - -狼美人骑士 3狼-美-4民-预-女-守-骑 *周一，周三，周日* - -永序之轮 3狼-狼妃-4民-预-守-女-王子 *周二，周五* - -孤独少女 4狼-3民-预-女-猎-守-孤独 *周二，周五，周日* - -噩梦之影 3狼-噩-4民-预-女-猎-梦 *周二* - -时波之乱 3狼-寂夜-4民-预-守-女-白昼 *周二* - -觉醒狼王 3狼-觉王-4民-预-女-商-梦 *周二，周四，周五，周日* - -赤月猎魔人 3狼-赤月-4民-预-女-愚-猎魔 *周一，周三，周日* - -石像鬼守墓人 3狼-石-4民-预-女-猎-墓 *周四，周六，周日* - -恶夜骑士 3狼-恶夜-4民-预-女-猎-守 *周三* - -狼王守卫 3狼-狼王-4民-预-女-猎-守 *周一，周三，周日* - -狼王魔术师 3狼-狼王-4民-预-女-猎-术 *周三，周四，周六* - -白狼王骑士 3狼-白狼王-4民-预-女-守-骑 *周一，周三，周四，周六* - -纯白夜影 3狼-巫-4民-守-女-猎-纯 *周一，周三，周六* - -动物梦境 3狼-美-4羊驼-白猫-河豚-子狐-熊*周一，周六* - -迷雾鸦影 3狼-狼鸦-4民-预-愚-梦-炼金 *周五* - -猎日逐光 3狼-侍-4民-预-女-梦-爵 *周日* - -寻香识命 3狼-香-4民-守-女-猎-觉预 *周一，周三，周六* - -觉醒之夜 3狼-贵-4民-预-女-猎魔-觉愚 *周一，周五，周六* - -咒狐乌鸦 2狼-狼王-4民-预-女-猎-鸦-咒狐 *周五* diff --git a/public/logo.svg b/public/logo.svg index 7bb2171..b89badf 100644 --- a/public/logo.svg +++ b/public/logo.svg @@ -1,6 +1,6 @@ - +