docs: add docs translation reward

This commit is contained in:
YunYouJun 2023-02-20 00:35:50 +08:00
parent 3d0c1903c9
commit 565e4ee04a
2 changed files with 53 additions and 0 deletions

47
docs/pages/dev/docs.md Normal file
View File

@ -0,0 +1,47 @@
---
title: Participate in Docs Writing and Translation
title_zh-CN: 参与文档撰写与翻译
categories:
- Dev
end: false
---
## Docs Writing
Valaxy 正在为 1.0 的发布做准备,我们很期待您参与文档的撰写与翻译。
## 如何翻译
Valaxy 将中英文写一个 Markdown 文件中,因此您可以很容易地进行前后文对比。
您可以以如下方式进行中英文内容书写,而公共的例子则只需保留一份。
```md
::: zh-CN
**效果如下**(点击按钮切换):
:::
::: en
**The effect is as follows** (click the button to switch).
:::
```
## 如何提交
使用 GitHub 的 Pull Request 向 valaxy 提交即可。
建议您以一个完整的 md 文件或一个分类翻译为一次提交。
Commit message 请以 `docs:` 开头。
譬如,我对文档的指南部分的翻译进行了修改。
即:`docs: update guide translation`。
修改了错别字:
即:`docs: fix typo`。
## 奖励
我们将会给为 Valaxy 贡献文档翻译及其他工作的用户发放一些奖励。
- 超过 10 commit赠送 Valaxy Logo 亚克力板挂件
- 超过 20 commit赠送 Valaxy Logo 与小云亚克力板挂件

View File

@ -15,6 +15,12 @@ top: 98
譬如,你修改了 `valaxy.config.ts`/`site.config.ts` 或是 `xxx.md` 文章中的内容或 `frontmatter``tags`/`categories`)所有的变动会立刻显示在预览界面上,无需手动刷新。同时热更新也是局部的,它只变动有修改的地方,不会重新刷新整个页面。
## 自定义
强大的自定义能力,你可以如忒修斯之船一样组件粒度地继承定制主题与你的博客。
更多请参见 [自定义组件](/guide/custom/components)。
## UnoCSS
> 内置的类 TailwindCSS 的工具类(基于 [UnoCSS](https://github.com/unocss/unocss))。