diff --git a/packages/docs/.vitepress/config.mjs b/packages/docs/.vitepress/config.mjs index b98f79060..9304aacb3 100644 --- a/packages/docs/.vitepress/config.mjs +++ b/packages/docs/.vitepress/config.mjs @@ -18,11 +18,15 @@ export default defineConfig({ { text: "开始", items: [ - { text: "指南", link: "/get-started/" }, - { text: "如何使用？", link: "/get-started/how-to-use" }, + { text: "简介", link: "/get-started/" }, + { text: "如何注册？", link: "/get-started/how-to-register" }, { text: "快速开始", link: "/get-started/quick-start" }, ], }, + { + text: "问题", + items: [{ text: "常见问题", link: "/question/" }], + }, { text: "贡献代码", items: [ diff --git a/packages/docs/get-started/how-to-register.md b/packages/docs/get-started/how-to-register.md new file mode 100644 index 000000000..1a8c0cb03 --- /dev/null +++ b/packages/docs/get-started/how-to-register.md @@ -0,0 +1,25 @@ +# 如何注册？ + +## 支持的方式 + +> 该网站目前提供了 `邮箱` 和 `Github` 注册，您可随意选择一种方式即可 + +## 开始注册 + +> 注意： 以下 是 `邮箱` 注册方式教学 + +1. 浏览器打开 [Earthworm 官网](https://earthworm.cuixueshe.com/) +2. 点击 `注册` 或 `登录` 按钮 + +3. 跳转到注册页面，点击 `Create account` + +4. 跳转到注册页面，输入 `邮箱`，`同意隐私说明`，点击 `Create account` + +5. 跳转到 验证码页面，检查对应邮箱 + +6. 回到第5步页面，输入验证码 + +7. 输入完验证码后，会出现邮箱注册确认弹窗，点击 `Sign in` 即可。 + +8. 恭喜你，成功注册 🎉 开始你的学习之路吧~ + diff --git a/packages/docs/get-started/how-to-use.md b/packages/docs/get-started/how-to-use.md deleted file mode 100644 index b70b57cf5..000000000 --- a/packages/docs/get-started/how-to-use.md +++ /dev/null @@ -1 +0,0 @@ -# 如何使用？ diff --git a/packages/docs/get-started/index.md b/packages/docs/get-started/index.md index 322b3075f..87127d0eb 100644 --- a/packages/docs/get-started/index.md +++ b/packages/docs/get-started/index.md @@ -1,36 +1,16 @@ -# 概述 +## 简介 -## 让你上瘾的英语学习工具 +[Earthworm](https://earthworm.cuixueshe.com/) 是一款让你上瘾的英语学习工具，它使用 `连词成句` 、 `i + 1` 、 `以终为始` 等学习理论来帮助你习得英语，通过不断的 `重复` 形成肌肉记忆，最重要的是 `游戏化` 的形式让学习英语从此不再痛苦。 -### 使用 连词成句 、 i + 1 、 以终为始 等学习理论来帮助你习得英语 +![](/home-page-preview.png) -### 通过不断的 重复 形成肌肉记忆 +## 为什么说它是你英语学习的必备工具？ -### 最重要的是 游戏化 的形式让学习英语从此不再痛苦 - -## **为什么会给大家介绍这个网站?** - -- 因为这对于你来说是最好的多方面的输入材料. - -## **我为什么会使用它?** - -- 因为它的学习方式更符合我们的学习方式: 单词 -> 短语 -> 句子, 会让你感到你从 0 到 1 组成一个句子的乐趣. - -## **EarthWorm 的学习形式是什么?** - -- 游戏化的让你深入学习, 你可以体验下, 说再多, 不如自己使用一次. - -## **为什么会上瘾?** - -- 你完成一课后,你会停不下来,你会感到组成一个复杂句子的快感, 会让你越来越兴奋. - -## **它能满足你英语学习的哪些点?** - -1. 听力: 该网站提供了**听力模式**, 你可以用它来提高你的英语听力 -2. 语法: **单词 -> 短语 -> 句子**, 会让你了解某个单词在短语,句子中的位置 -3. 单词: 这一点也是该网站宣传的重点: **连词成句** -4. i+1(可理解): 这一点很重要, 如果你一开始就选择很难的输入材料,我相信很多人坚持不了多久... -5. 有趣: 这一点占用你 15 分钟时间, 你可以自行使用后可知 -6. 足量: 目前该网站提供了 51 节课, 但根据了解, 已经在开发多课程包了, 不会太久就会上线. -7. 重复: 这个网站会将你学习的内容, 拆分到后续的课程中,帮你达到重复,回顾的效果. -8. 音乐模式(支持中): 这个模式很新颖, 用户可上传或使用内置的音乐来学习 +1. `听力`：该网站提供了`听力模式`, 你可以用它来提高你的英语听力 +2. 语法：`单词 -> 短语 -> 句子`, 会让你了解某个单词在短语,句子中的位置 +3. 单词：这一点也是该网站宣传的重点: `连词成句` +4. `i+1(可理解)`：这一点很重要, 如果你一开始就选择很难的输入材料,我相信很多人坚持不了多久... +5. `有趣`：这一点占用你 15 分钟时间, 你可以自行使用后可知 +6. `足量`：目前该网站提供了 `零基础英语`、`高考写作课程`、`小猪佩奇（第一季）`，后续还会添加更多课程 +7. `重复`：这个网站会将你学习的内容, 拆分到后续的课程中,帮你达到重复,回顾的效果. +8. 音乐模式(支持中)：这个模式很新颖, 用户可上传或使用内置的音乐来学习 diff --git a/packages/docs/public/home-page-preview.png b/packages/docs/public/home-page-preview.png new file mode 100644 index 000000000..e8d88ca02 Binary files /dev/null and b/packages/docs/public/home-page-preview.png differ diff --git a/packages/docs/public/register/email.png b/packages/docs/public/register/email.png new file mode 100644 index 000000000..2ace1b178 Binary files /dev/null and b/packages/docs/public/register/email.png differ diff --git a/packages/docs/public/register/ensure.png b/packages/docs/public/register/ensure.png new file mode 100644 index 000000000..ff0f93538 Binary files /dev/null and b/packages/docs/public/register/ensure.png differ diff --git a/packages/docs/public/register/entry.png b/packages/docs/public/register/entry.png new file mode 100644 index 000000000..4caf328a9 Binary files /dev/null and b/packages/docs/public/register/entry.png differ diff --git a/packages/docs/public/register/input.png b/packages/docs/public/register/input.png new file mode 100644 index 000000000..8068b2df1 Binary files /dev/null and b/packages/docs/public/register/input.png differ diff --git a/packages/docs/public/register/register-page.png b/packages/docs/public/register/register-page.png new file mode 100644 index 000000000..471905419 Binary files /dev/null and b/packages/docs/public/register/register-page.png differ diff --git a/packages/docs/public/register/success.jpg b/packages/docs/public/register/success.jpg new file mode 100644 index 000000000..1b88bdcf1 Binary files /dev/null and b/packages/docs/public/register/success.jpg differ diff --git a/packages/docs/public/register/verify-code.png b/packages/docs/public/register/verify-code.png new file mode 100644 index 000000000..d9931842b Binary files /dev/null and b/packages/docs/public/register/verify-code.png differ diff --git a/packages/docs/question/index.md b/packages/docs/question/index.md new file mode 100644 index 000000000..115085ff0 --- /dev/null +++ b/packages/docs/question/index.md @@ -0,0 +1,25 @@ +## 常见问题 + +### 如何向开发团队提出更多的功能需求？ + +1. 可以加入我们官方 Telegram 群组, 详细的描述您想要的功能以及告知这个功能想要解决的问题是什么 +2. 也可以去 github/issues 来提交您想要的功能需求 + +--- + +### 如何向开发团队报告我在应用中遇到的错误或漏洞？ + +- 如果您在应用中发现了错误或漏洞，可以加入我们官方 Telegram 群组，提供详细的描述和重现问题的步骤，当然最好提供一个小视频 🤪 + +--- + +### 如果我忘记了账户密码，该如何恢复或重置密码？ + +1. 加入 Telegram 群组，联系阿崔，告诉阿崔你的帐号 +2. 暂时没有修改密码的功能, 只能注销帐号然后重新注册 + +--- + +### Earthworm 项目是完全免费的吗？ + +- 不完全免费，因为想要长久发展收费是必然的。未来会采用订阅模式，为会员提供更多的学习内容和功能