From 0c20ee307af5652e2e5c0531ee932fa86d0d195f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=88=9D=E4=BA=94?= <141227996+ChuwuYo@users.noreply.github.com> Date: Fri, 6 Jun 2025 19:22:54 +0800 Subject: [PATCH] docs: fix grammatical errors and spelling issues in documentation (#547) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: fix README.md typo - change "For a example" to "For an example" * docs: fix grammar errors in documentation - read and write permissions。 to read and write permissions. * docs: fix grammatical error in addon writing guide - **docs/pages/addons/write.md**: Changed "Write a Addon" to "Write an Addon" in title * docs: fix grammatical error in third-party integration guide - **docs/pages/guide/third-party/index.md**: Changed "in a article" to "in an article" * docs: fix "This is a example" to "This is an example" * docs: fix spelling "archieved" to "achieved" in why.md --- README.md | 2 +- docs/pages/addons/write.md | 2 +- docs/pages/dev/docs.md | 2 +- docs/pages/guide/deploy.md | 2 +- docs/pages/guide/third-party/index.md | 2 +- docs/pages/guide/why.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ceafb079..c3e75233 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ pnpm create valaxy # yarn create valaxy ``` -For a example, you can see [demo/yun](./demo/yun/) folder. +For an example, you can see [demo/yun](./demo/yun/) folder. ## Features diff --git a/docs/pages/addons/write.md b/docs/pages/addons/write.md index 7710608e..a084409e 100644 --- a/docs/pages/addons/write.md +++ b/docs/pages/addons/write.md @@ -1,5 +1,5 @@ --- -title: Write a Addon +title: Write an Addon title_zh: 编写一个插件 categories: - addon diff --git a/docs/pages/dev/docs.md b/docs/pages/dev/docs.md index c4ccd200..c593f77a 100644 --- a/docs/pages/dev/docs.md +++ b/docs/pages/dev/docs.md @@ -26,7 +26,7 @@ Valaxy 将中英文写一个 Markdown 文件中,因此您可以很容易地进 :::
-This is a example. +This is an example.
``` diff --git a/docs/pages/guide/deploy.md b/docs/pages/guide/deploy.md index b2b4aa2f..5603e0fd 100644 --- a/docs/pages/guide/deploy.md +++ b/docs/pages/guide/deploy.md @@ -111,7 +111,7 @@ This is because when there is a directory with the same name, GitHub Pages will ::: en When you use `pnpm create valaxy` to create a template project, it contains the file [`.github/workflows/gh-pages.yml`](https://github.com/YunYouJun/valaxy/blob/main/packages/create-valaxy/template-blog/.github/workflows/gh-pages.yml) for the CI workflow of GitHub Actions. -- Select the Github repository, go to `Settings`-> `Action` -> `General` -> `Workflow permissions`, and select `read and write permissions`。 +- Select the Github repository, go to `Settings`-> `Action` -> `General` -> `Workflow permissions`, and select `read and write permissions`. - Push to your GitHub repository, and go to `Settings` -> `Pages`. Select `gh-pages` branch. > `gh-pages` has been automatically deployed by `.github/workflows/gh-pages.yml`. diff --git a/docs/pages/guide/third-party/index.md b/docs/pages/guide/third-party/index.md index eb2d7345..e509f265 100644 --- a/docs/pages/guide/third-party/index.md +++ b/docs/pages/guide/third-party/index.md @@ -153,7 +153,7 @@ Valaxy provides a quick integration plug-in: [valaxy-addon-algolia](https://gith ::: en > Implementd based on [Aplayer](https://github.com/DIYgod/APlayer) and [MetingJS](https://github.com/metowolf/MetingJS) -For example, add a song from Netease Cloud in a article: +For example, add a song from Netease Cloud in an article: Enable it in the FrontMatter of the article: ::: diff --git a/docs/pages/guide/why.md b/docs/pages/guide/why.md index 43e645b2..fd603e18 100644 --- a/docs/pages/guide/why.md +++ b/docs/pages/guide/why.md @@ -191,7 +191,7 @@ iles 与 Valaxy 的一些基础结构功能很相似,它相比 Vitepress 拥 ::: ::: en -After completing the development of Valaxy's basic structures, I learned about iles from my group friend, which is very similar to many features I have archieved. +After completing the development of Valaxy's basic structures, I learned about iles from my group friend, which is very similar to many features I have archived. It has more features than Vitepress and is also suitable for writing a document with more interaction.