# polyos-site

**Repository Path**: brsvh/polyos-site

## Basic Information

- **Project Name**: polyos-site
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2023-07-18
- **Last Updated**: 2023-08-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# [WIP] PolyOS 官网

PolyOS 的官网，主要用于发布 PolyOS、分发镜像以及提供源码获取、编译构建、系统启动的相关文档。

## 介绍

网站主要使用 [docusaurus] 进行构建。

[docusaurus]: https://docusaurus.io

### 项目结构

**TODO**

## 项目计划

### stage 0

主要提供 PolyOS Mobile 的相关内容。

- [ ] 开发官网的主要组件/页面 [#3]
- [ ] 编写初始的教程文档 [#4]
- [ ] i18n

[#3]: https://isrc.iscas.ac.cn/gitlab/riscv/raios/polyos-site/-/issues/3
[#4]: https://isrc.iscas.ac.cn/gitlab/riscv/raios/polyos-site/-/issues/4
[PolyOS Mobile 文档]: https://isrc.iscas.ac.cn/gitlab/riscv/polyosmobile/docs

## 项目开发

### 运行本地开发服务器

```shell
npm run start
```

受 [#5] 影响，显示指定站点语言为简体中文。

```shell
npm run start -- --locale zh-Hans
```

### 构建站点

```shell
npm run build
```

### 同步文档

```shell
bin/docsync --checkout-from isrc --languages en,zh_CN
bin/docsync --checkout-from https://isrc.iscas.ac.cn/gitlab/riscv/polyosmobile/docs.git \
            --languages en,zh_CN
```

通过 `--checkout-from` 指定从哪里同步，可选的参数值为 `isrc` ， `gitee` 或者一个 url。

文档会同步到 .docs 目录下，当暂时修改后你可能会希望不要执行从上游仓库检出，请使用 `--skip-checkout` 。

```shell
bin/docsync --skip-checkout --languages en,zh_CN
```

**NOTE**

当进行同步后，请在提交信息中引用本次同步的具体提交，方便查找问题原因（以及可能的版权问题）。

e.g. _COMMIT_MESSAGE_:

```
chore: sync docs

ref: riscv/polyosmobile/docs@db252d94684f610fea3d91cf28e67785b35f3d31
```

### 更新翻译

```shell
npm run write-translations
# for Simplified Chinese
npm run write-translations -- --locale zh-Hans
```

## License

polyos-site consists of web source code and documentation derived from polyos-docs, so different directories use different licenses.

In the following directories, all files are licensed under CC-BY 4.0:

- docs
- i18n/en/docusaurus-plugin-content-docs
- i18n/zh-Hans/docusaurus-plugin-content-docs

All other remaining files are licensed under the MIT license.

You should have received copies of all the licenses along with the source code of polyos-site.

If you haven't received them, please visit https://mit-license.org/ and http://creativecommons.org/licenses/by/4.0/ to obtain the original copies of the licenses.