From b4b931fc9564765ffc4ef7930008df789370e9c9 Mon Sep 17 00:00:00 2001 From: snowykami Date: Wed, 4 Sep 2024 02:43:44 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20=E6=9B=B4=E6=96=B0=E5=BC=80=E5=8F=91?= =?UTF-8?q?=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/components/ContributorBar.vue | 26 ++++++++++++++++++++++++++ docs/components/StatsBar.vue | 5 +++-- docs/components/TryLiteyukiWindow.vue | 11 +++++++++++ docs/components/scripts/const.ts | 4 ++++ docs/components/scripts/i18n.ts | 4 ++++ docs/en/dev/guide.md | 13 +++++++++++-- docs/zh/dev/guide.md | 14 ++++++++++++-- 7 files changed, 71 insertions(+), 6 deletions(-) create mode 100644 docs/components/ContributorBar.vue create mode 100644 docs/components/TryLiteyukiWindow.vue create mode 100644 docs/components/scripts/const.ts diff --git a/docs/components/ContributorBar.vue b/docs/components/ContributorBar.vue new file mode 100644 index 00000000..377bbc46 --- /dev/null +++ b/docs/components/ContributorBar.vue @@ -0,0 +1,26 @@ + + + + + \ No newline at end of file diff --git a/docs/components/StatsBar.vue b/docs/components/StatsBar.vue index 6f731fd5..ce1afa6a 100644 --- a/docs/components/StatsBar.vue +++ b/docs/components/StatsBar.vue @@ -133,7 +133,8 @@ onBeforeRouteUpdate(() => {
- +
@@ -267,7 +268,7 @@ onBeforeRouteUpdate(() => { .stats-info { width: 40%; - margin: 30px; + margin: 10px 30px 30px 30px; } .starmap { diff --git a/docs/components/TryLiteyukiWindow.vue b/docs/components/TryLiteyukiWindow.vue new file mode 100644 index 00000000..96c0baf2 --- /dev/null +++ b/docs/components/TryLiteyukiWindow.vue @@ -0,0 +1,11 @@ + + + + + \ No newline at end of file diff --git a/docs/components/scripts/const.ts b/docs/components/scripts/const.ts new file mode 100644 index 00000000..77a05f3d --- /dev/null +++ b/docs/components/scripts/const.ts @@ -0,0 +1,4 @@ +export const platformBaseURL = "https://github.com/" +export const repoPath = "LiteyukiStudio/LiteyukiBot" + +export const repoURL = `${platformBaseURL}${repoPath}` \ No newline at end of file diff --git a/docs/components/scripts/i18n.ts b/docs/components/scripts/i18n.ts index 7d4c101f..738d05da 100644 --- a/docs/components/scripts/i18n.ts +++ b/docs/components/scripts/i18n.ts @@ -22,6 +22,8 @@ const i18nData = { liteyukiOnly: 'Liteyuki Only', search: 'Search', resourceStore: 'Resources Store', + + thx_contributors: 'Thanks the following contributors!', }, zh: { stats: '统计信息', @@ -43,6 +45,8 @@ const i18nData = { liteyukiOnly: '仅轻雪', search: '搜索', resourceStore: '资源商店', + + thx_contributors: '感谢以下贡献者！', } } diff --git a/docs/en/dev/guide.md b/docs/en/dev/guide.md index 8f3b92da..a34be320 100644 --- a/docs/en/dev/guide.md +++ b/docs/en/dev/guide.md @@ -2,6 +2,12 @@ title: Development Guide order: 0 --- + + + + # Development Guide ## How to Develop @@ -52,8 +58,8 @@ The `src` directory is the application part, please develop business logic in th - commit message should follow the following guidelines: - You should commit the code after completing a feature or fixing a bug, and not mix the code of multiple features or bugs together. - We use gitmoji to mark the type of commit, such as `:sparkles:` for introducing new features, `:bug:` for fixing bugs, etc., please refer to [gitmoji](https://gitmoji.dev/) for details. - - The format of the commit message is ` [module]: `, such as `:sparkles: [liteyuki.event]: add new feature`, - where the module field is the affected part, such as `liteyuki.message`, `docs.en.guide.md`, etc., not much is required, but please fill in as much as possible; the message field is a brief description, in summary, what you did. + - The format of the commit message is ` [type:] `, such as `:sparkles: feat: add new field to event`, + where the type field is the type of commit, not much is required, but please fill in as much as possible; the message field is a brief description, in summary, what you did. - There is no restriction on the language of the commit message, and bilingual use is possible if conditions permit. - The documentation should follow [`Markdown`](https://www.markdownguide.org/) syntax and support vitepress-related content: - Revise the documentation for each language when editing. @@ -62,3 +68,6 @@ The `src` directory is the application part, please develop business logic in th ## Finally - This project is a non-profit open-source project, and we welcome anyone to participate in development. Your contributions will make Liteyuki better. + + + \ No newline at end of file diff --git a/docs/zh/dev/guide.md b/docs/zh/dev/guide.md index 9384cff6..11928435 100644 --- a/docs/zh/dev/guide.md +++ b/docs/zh/dev/guide.md @@ -2,6 +2,13 @@ title: 开发指南 order: 0 --- + + + + + # 开发指南 ## 如何开发 @@ -49,8 +56,8 @@ order: 0 - commit message请遵循以下规范： - 应在每次完成一个功能或修复一个bug后提交代码，不要将多个功能或多个bug的代码混在一起提交。 - 我们使用gitmoji来标记commit的类型，如`:sparkles:`表示引入新功能，`:bug:`表示修复bug等，具体请参考[gitmoji](https://gitmoji.dev/) - - commit message的格式为` [module]: `，如`:sparkles: [liteyuki.event]: add new feature`， - 其中module字段为受影响部分，例如`liteyuki.message`，`docs.en.guide.md`等，不作过多要求，但请尽量填写；message字段为简短的描述，总结来说就是你干了什么。 + - commit message的格式为` [type:] `，如`:sparkles: feat: 给event添加新字段`， + 其中`type`字段为commit类型且**可选**，message字段为简短的描述，总结来说就是你干了什么。 - 不限制commit message的语言，有条件可以使用中英双语。 - 文档请遵循[`Markdown`](https://www.markdownguide.org/)语法，并且支持vitepress相关内容： - 修订文档时，每个语言的文档都要修订。 @@ -59,3 +66,6 @@ order: 0 ## 最后 - 本项目是一个非盈利的开源项目，我们欢迎任何人参与开发，你的贡献将会使轻雪变得更好。 + + +