docs: fix grammatical errors and spelling issues in documentation (#547)

* 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
This commit is contained in:
初五 2025-06-06 19:22:54 +08:00 committed by GitHub
parent d238c88cde
commit 0c20ee307a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 6 additions and 6 deletions

View File

@ -41,7 +41,7 @@ pnpm create valaxy
# yarn 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 ## Features

View File

@ -1,5 +1,5 @@
--- ---
title: Write a Addon title: Write an Addon
title_zh: 编写一个插件 title_zh: 编写一个插件
categories: categories:
- addon - addon

View File

@ -26,7 +26,7 @@ Valaxy 将中英文写一个 Markdown 文件中,因此您可以很容易地进
::: :::
<div> <div>
This is a example. This is an example.
</div> </div>
``` ```

View File

@ -111,7 +111,7 @@ This is because when there is a directory with the same name, GitHub Pages will
::: en ::: 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. 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. - 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`. > `gh-pages` has been automatically deployed by `.github/workflows/gh-pages.yml`.

View File

@ -153,7 +153,7 @@ Valaxy provides a quick integration plug-in: [valaxy-addon-algolia](https://gith
::: en ::: en
> Implementd based on [Aplayer](https://github.com/DIYgod/APlayer) and [MetingJS](https://github.com/metowolf/MetingJS) > 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: Enable it in the FrontMatter of the article:
::: :::

View File

@ -191,7 +191,7 @@ iles 与 Valaxy 的一些基础结构功能很相似,它相比 Vitepress 拥
::: :::
::: en ::: 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. It has more features than Vitepress and is also suitable for writing a document with more interaction.