Skip to content

Commit

Permalink
docs(deploy): rss3 documents (hexojs#1674)
Browse files Browse the repository at this point in the history
  • Loading branch information
Candinya authored Jul 15, 2021
1 parent 941777a commit d7f8804
Show file tree
Hide file tree
Showing 8 changed files with 265 additions and 0 deletions.
6 changes: 6 additions & 0 deletions source/_data/plugins.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2955,3 +2955,9 @@
- tag
- trello
- cards
- name: hexo-deployer-rss3
description: RSS3 deployer plugin for Hexo
link: https://github.com/NaturalSelectionLabs/hexo-deployer-rss3
tags:
- deployer
- rss3
37 changes: 37 additions & 0 deletions source/docs/one-command-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,42 @@ $ hexo generate —deploy && bip deploy

After a few moments, your website will be deployed.

## RSS3

[RSS3](https://rss3.io) is an open protocol designed for content and social networks in the Web 3.0 era.

1. Install [hexo-deployer-rss3].

2. Modify the configuration.

``` yaml
deploy: # The root configuration block for all deployers
- type: rss3
endpoint: https://hub.rss3.io
privateKey: 47e18d6c386898b424025cd9db446f779ef24ad33a26c499c87bb3d9372540ba
ipfs:
deploy: true
gateway: pinata
api:
key: d693df715d3631e489d6
secret: ee8b74626f12b61c1a4bde3b8c331ad390567c86ba779c9b18561ee92c1cbff0
```

| Parameters | Description |
| ----------------- | ---------------------- |
| `endpoint` | a link to the RSS3 Hub |
| `privateKey` | your private key, 64 bytes |
| `ipfs/deploy` | whether to deploy to IPFS |
| `ipfs/gateway` | IPFS API gateway |
| `ipfs/api/key` | IPFS gateway-related authentication content |
| `ipfs/api/secret` | IPFS gateway-related authentication content |

3. generate static files

4. deploy

For deployment-related considerations, you can refer to [Our documentation](https://github.com/NaturalSelectionLabs/hexo-deployer-rss3/blob/develop/README.md).


## Other Methods

Expand All @@ -289,3 +325,4 @@ All generated files are saved in the `public` folder. You can copy them to where
[hexo-deployer-openshift]: https://github.com/hexojs/hexo-deployer-openshift
[hexo-deployer-ftpsync]: https://github.com/hexojs/hexo-deployer-ftpsync
[hexo-deployer-sftp]: https://github.com/lucascaro/hexo-deployer-sftp
[hexo-deployer-rss3]: https://github.com/NaturalSelectionLabs/hexo-deployer-rss3
37 changes: 37 additions & 0 deletions source/ko/docs/one-command-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,42 @@ $ hexo generate —deploy && bip deploy

After a few moments, your website will be deployed.

## RSS3

[RSS3](https://rss3.io)는 Web 3.0 시대의 콘텐츠 및 소셜 네트워크를 위해 설계된 개방형 프로토콜입니다.

1. [hexo-deployer-rss3] 설치

2. 구성을 수정합니다.

``` yaml
deploy:
- type: rss3
endpoint: https://hub.rss3.io
privateKey: 47e18d6c386898b424025cd9db446f779ef24ad33a26c499c87bb3d9372540ba
ipfs:
deploy: true
gateway: pinata
api:
key: d693df715d3631e489d6
secret: ee8b74626f12b61c1a4bde3b8c331ad390567c86ba779c9b18561ee92c1cbff0
```

|매개변수 |설명 |
| ------------------ | ---------------------- |
| `endpoint` | RSS3 Hub에 대한 링크 |
| `privateKey` | 개인 키, 64바이트 |
| `ipfs/deploy` | IPFS에 배포할지 여부 |
| `ipfs/gateway` | IPFS API 게이트웨이 |
| `ipfs/api/key` | IPFS 게이트웨이 관련 검증 내용 |
| `ipfs/api/secret` | IPFS 게이트웨이 관련 검증 내용 |

3. 정적 파일 생성

4. 배포

특정 배포와 관련된 주의 사항은 [당사 문서](https://github.com/NaturalSelectionLabs/hexo-deployer-rss3/blob/develop/README.md)를 참조하세요.

## 다른 메소드들

생성되는 모든 파일들은 `public` 폴더에 저장됩니다. 이 파일들을 당신이 원하는 곳 아무데나 복사하여 사용할 수 있습니다.
Expand All @@ -240,3 +276,4 @@ After a few moments, your website will be deployed.
[hexo-deployer-rsync]: https://github.com/hexojs/hexo-deployer-rsync
[hexo-deployer-openshift]: https://github.com/hexojs/hexo-deployer-openshift
[hexo-deployer-ftpsync]: https://github.com/hexojs/hexo-deployer-ftpsync
[hexo-deployer-rss3]: https://github.com/NaturalSelectionLabs/hexo-deployer-rss3
37 changes: 37 additions & 0 deletions source/pt-br/docs/one-command-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,42 @@ $ hexo generate —deploy && bip deploy

After a few moments, your website will be deployed.

## RSS3

[RSS3] (https://rss3.io) é um protocolo aberto projetado para conteúdo e redes sociais na era da Web 3.0.

1. Instale [hexo-deployer-rss3]

2. Modifique a configuração.

``` yaml
deploy:
- type: rss3
endpoint: https://hub.rss3.io
privateKey: 47e18d6c386898b424025cd9db446f779ef24ad33a26c499c87bb3d9372540ba
ipfs:
deploy: true
gateway: pinata
api:
key: d693df715d3631e489d6
secret: ee8b74626f12b61c1a4bde3b8c331ad390567c86ba779c9b18561ee92c1cbff0
```

| Parâmetros | Descrição |
| ----------------- | ---------------------- |
| `endpoint` | Um link para o hub RSS3 |
| `privateKey` | Sua chave privada, 64 bytes |
| `ipfs/deploy` | Se deve implantar no IPFS |
| `ipfs/gateway` | Gateway de API IPFS |
| `ipfs/api/key` | Conteúdo de verificação relacionado ao gateway IPFS |
| `ipfs/api/secret` | Conteúdo de verificação relacionado ao gateway IPFS |

3. Gere arquivos estáticos

4. Implantação

Para precauções relacionadas à implantação específica, você pode consultar [nossa documentação] (https://github.com/NaturalSelectionLabs/hexo-deployer-rss3/tree/develop/docs/zh_CN/start.md).

## Outros Métodos

Todos os arquivos gerados são salvos no diretório `public`. Você pode copiá-los para onde quiser.
Expand All @@ -275,3 +311,4 @@ Todos os arquivos gerados são salvos no diretório `public`. Você pode copiá-
[hexo-deployer-openshift]: https://github.com/hexojs/hexo-deployer-openshift
[hexo-deployer-ftpsync]: https://github.com/hexojs/hexo-deployer-ftpsync
[hexo-deployer-sftp]: https://github.com/lucascaro/hexo-deployer-sftp
[hexo-deployer-rss3]: https://github.com/NaturalSelectionLabs/hexo-deployer-rss3
37 changes: 37 additions & 0 deletions source/ru/docs/one-command-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,42 @@ $ hexo generate —deploy && bip deploy

After a few moments, your website will be deployed.

## RSS3

[RSS3] (https://rss3.io) - это открытый протокол, разработанный для контента и социальных сетей в эпоху Web 3.0.

1. Установите [hexo-deployer-rss3].

2. Измените конфигурацию.

``` yaml
deploy:
- type: rss3
endpoint: https://hub.rss3.io
privateKey: 47e18d6c386898b424025cd9db446f779ef24ad33a26c499c87bb3d9372540ba
ipfs:
deploy: true
gateway: pinata
api:
key: d693df715d3631e489d6
secret: ee8b74626f12b61c1a4bde3b8c331ad390567c86ba779c9b18561ee92c1cbff0
```

| Параметры | Описание |
| ----------------- | ---------------------- |
| `endpoint` | Ссылка на RSS3 Hub |
| `privateKey` | Ваш закрытый ключ, 64 байта |
| `ipfs/deploy` | Следует ли развертывать в IPFS |
| `ipfs/gateway` | IPFS API Gateway |
| `ipfs/api/key` | Проверочный контент, связанный со шлюзом IPFS |
| `ipfs/api/secret` | Проверочный контент, связанный со шлюзом IPFS |

3. Создавайте статические файлы.

4. Развертывание

Меры предосторожности, связанные с конкретным развертыванием, можно найти в [нашей документации] (https://github.com/NaturalSelectionLabs/hexo-deployer-rss3/tree/develop/docs/zh_CN/start.md).

## Другие способы

Все созданные файлы сохраняются в папке `public`. Вы можете скопировать их куда угодно.
Expand All @@ -240,3 +276,4 @@ After a few moments, your website will be deployed.
[hexo-deployer-rsync]: https://github.com/hexojs/hexo-deployer-rsync
[hexo-deployer-openshift]: https://github.com/hexojs/hexo-deployer-openshift
[hexo-deployer-ftpsync]: https://github.com/hexojs/hexo-deployer-ftpsync
[hexo-deployer-rss3]: https://github.com/NaturalSelectionLabs/hexo-deployer-rss3
37 changes: 37 additions & 0 deletions source/th/docs/one-command-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,42 @@ $ hexo generate —deploy && bip deploy

After a few moments, your website will be deployed.

## RSS3

[RSS3](https://rss3.io) เป็นโปรโตคอลแบบเปิดที่ออกแบบมาสำหรับเนื้อหาและเครือข่ายโซเชียลในยุค Web 3.0

1. ติดตั้ง [hexo-deployer-rss3]

2. แก้ไขการกำหนดค่า

``` yaml
deploy:
- type: rss3
endpoint: https://hub.rss3.io
privateKey: 47e18d6c386898b424025cd9db446f779ef24ad33a26c499c87bb3d9372540ba
ipfs:
deploy: true
gateway: pinata
api:
key: d693df715d3631e489d6
secret: ee8b74626f12b61c1a4bde3b8c331ad390567c86ba779c9b18561ee92c1cbff0
```

| พารามิเตอร์ | คำอธิบาย |
| ----------------- | ---------------------- |
| `deploy` | ลิงก์ไปยัง RSS3 Hub |
| `privateKey` | คีย์ส่วนตัวของคุณ 64 ไบต์ |
| `ipfs/deploy` | ว่าจะปรับใช้กับ IPFS หรือไม่ |
| `ipfs/gateway` | IPFS API เกตเวย์ |
| `ipfs/api/key` | เนื้อหาการตรวจสอบที่เกี่ยวข้องกับเกตเวย์ IPFS |
| `ipfs/api/secret` | การตรวจสอบเนื้อหาที่เกี่ยวข้องกับเกตเวย์ IPFS |

3. สร้างไฟล์แบบคงที่

4. การปรับใช้

สำหรับข้อควรระวังที่เกี่ยวข้องกับการทำให้ใช้งานได้โดยเฉพาะ โปรดดู[เอกสารประกอบของเรา](https://github.com/NaturalSelectionLabs/hexo-deployer-rss3/tree/develop/docs/zh_CN/start.md)

## Other Methods

ไฟล์ท่ีต้องการ generate จะบันทึกอยู่ใน folder `public` คุณสามารถ copy
Expand All @@ -296,3 +332,4 @@ After a few moments, your website will be deployed.
[hexo-deployer-rsync]: https://github.com/hexojs/hexo-deployer-rsync
[hexo-deployer-openshift]: https://github.com/hexojs/hexo-deployer-openshift
[hexo-deployer-ftpsync]: https://github.com/hexojs/hexo-deployer-ftpsync
[hexo-deployer-rss3]: https://github.com/NaturalSelectionLabs/hexo-deployer-rss3
37 changes: 37 additions & 0 deletions source/zh-cn/docs/one-command-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,6 +300,42 @@ $ hexo generate —deploy && bip deploy

After a few moments, your website will be deployed.

## RSS3

[RSS3](https://rss3.io) 是一个为 Web 3.0 时代的内容和社交网络设计的开放协议。

1. 安装 [hexo-deployer-rss3]

2. 修改配置。

``` yaml
deploy: # 所有部署器的根配置块
- type: rss3
endpoint: https://hub.rss3.io
privateKey: 47e18d6c386898b424025cd9db446f779ef24ad33a26c499c87bb3d9372540ba
ipfs:
deploy: true
gateway: pinata
api:
key: d693df715d3631e489d6
secret: ee8b74626f12b61c1a4bde3b8c331ad390567c86ba779c9b18561ee92c1cbff0
```

| 参数 | 描述 |
| ----------------- | ---------------------- |
| `endpoint` | 一个 RSS3 Hub 的链接 |
| `privateKey` | 您的私钥, 64 字节 |
| `ipfs/deploy` | 是否部署到 IPFS 上 |
| `ipfs/gateway` | IPFS API 网关 |
| `ipfs/api/key` | IPFS 网关相关的验证内容 |
| `ipfs/api/secret` | IPFS 网关相关的验证内容 |

3. 生成静态文件

4. 部署

关于具体部署相关的注意事项,您可以参阅 [我们的文档](https://github.com/NaturalSelectionLabs/hexo-deployer-rss3/tree/develop/docs/zh_CN/start.md) 。

## 其他方法

Hexo 生成的所有文件都放在 `public` 文件夹中,您可以将它们复制到您喜欢的地方。
Expand All @@ -310,3 +346,4 @@ Hexo 生成的所有文件都放在 `public` 文件夹中,您可以将它们
[hexo-deployer-openshift]: https://github.com/hexojs/hexo-deployer-openshift
[hexo-deployer-ftpsync]: https://github.com/hexojs/hexo-deployer-ftpsync
[hexo-deployer-sftp]: https://github.com/lucascaro/hexo-deployer-sftp
[hexo-deployer-rss3]: https://github.com/NaturalSelectionLabs/hexo-deployer-rss3
37 changes: 37 additions & 0 deletions source/zh-tw/docs/one-command-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,42 @@ $ hexo generate —deploy && bip deploy

After a few moments, your website will be deployed.

## RSS3

[RSS3](https://rss3.io) 是一個為 Web 3.0 時代的內容和社交網路設計的開放協議。

1. 安裝 [hexo-deployer-rss3]

2. 修改配置。

``` yaml
deploy: # 所有部署器的根配置塊
- type: rss3
endpoint: https://hub.rss3.io
privateKey: 47e18d6c386898b424025cd9db446f779ef24ad33a26c499c87bb3d9372540ba
ipfs:
deploy: true
gateway: pinata
api:
key: d693df715d3631e489d6
secret: ee8b74626f12b61c1a4bde3b8c331ad390567c86ba779c9b18561ee92c1cbff0
```

| 參數 | 描述 |
| ----------------- | ---------------------- |
| `endpoint` | 一個 RSS3 Hub 的鏈接 |
| `privateKey` | 您的私鑰, 64 字節 |
| `ipfs/deploy` | 是否部署到 IPFS 上 |
| `ipfs/gateway` | IPFS API 網關 |
| `ipfs/api/key` | IPFS 網關相關的驗證內容 |
| `ipfs/api/secret` | IPFS 網關相關的驗證內容 |

3. 生成靜態文件

4. 部署

關於具體部署相關的註意事項,您可以參閱 [我們的文檔](https://github.com/NaturalSelectionLabs/hexo-deployer-rss3/tree/develop/docs/zh_TW/start.md) 。

## 其他方法

Hexo 產生的所有檔案都放在 `public` 資料夾,您可以將它們拷貝到您喜歡的地方。
Expand All @@ -241,3 +277,4 @@ Hexo 產生的所有檔案都放在 `public` 資料夾,您可以將它們拷
[hexo-deployer-rsync]: https://github.com/hexojs/hexo-deployer-rsync
[hexo-deployer-openshift]: https://github.com/hexojs/hexo-deployer-openshift
[hexo-deployer-ftpsync]: https://github.com/hexojs/hexo-deployer-ftpsync
[hexo-deployer-rss3]: https://github.com/NaturalSelectionLabs/hexo-deployer-rss3

0 comments on commit d7f8804

Please sign in to comment.