Skip to content

Commit

Permalink
docs: publish 0.15 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chivehao committed Aug 20, 2024
1 parent 36a2ddc commit 8f42299
Show file tree
Hide file tree
Showing 58 changed files with 2,744 additions and 68 deletions.
14 changes: 0 additions & 14 deletions docs/getting-started/install/android-app.md

This file was deleted.

12 changes: 6 additions & 6 deletions docs/getting-started/install/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ import DockerArgs from "./slots/docker-args.md"
- [ikarosrun/ikaros](https://hub.docker.com/r/ikarosrun/ikaros)

:::info 注意
目前 Ikaros 并未更新 Docker 的 latest 标签镜像,主要因为 暂未发布正式版本。我们推荐使用固定版本的标签,比如 `ikarosrun/ikaros:v0.14.1`
目前 Ikaros 并未更新 Docker 的 latest 标签镜像,主要因为 暂未发布正式版本。我们推荐使用固定版本的标签,比如 `ikarosrun/ikaros:v0.15.5`

- `ikarosrun/ikaros:v0.14.1`:表示最新的可用镜像,每次发布时都会根据GitHub的标签构建一个新的镜像
- `ikarosrun/ikaros:v0.15.5`:表示最新的可用镜像,每次发布时都会根据GitHub的标签构建一个新的镜像
- `ikarosrun/ikaros:dev`:表示开发中的镜像,不推荐使用,每次Pull Request合并到主分支都会构建并覆盖该镜像。。

后续文档以 `ikarosrun/ikaros:v0.14.1` 为例。
后续文档以 `ikarosrun/ikaros:v0.15.5` 为例。
:::

1. 在系统任意位置创建一个文件夹,此文档以 `~/ikaros` 为例。
Expand All @@ -54,7 +54,7 @@ import DockerArgs from "./slots/docker-args.md"
services:
# ikaros
ikaros:
image: ikarosrun/ikaros:v0.14.1
image: ikarosrun/ikaros:v0.15.5
container_name: ikaros
restart: on-failure:3
depends_on:
Expand Down Expand Up @@ -132,7 +132,7 @@ import DockerArgs from "./slots/docker-args.md"
services:
# ikaros
ikaros:
image: ikarosrun/ikaros:v0.14.1
image: ikarosrun/ikaros:v0.15.5
container_name: ikaros
restart: on-failure:3
networks:
Expand Down Expand Up @@ -216,7 +216,7 @@ import DockerArgs from "./slots/docker-args.md"
```yaml {3}
services:
ikaros:
image: ikarosrun/ikaros:v0.14.1
image: ikarosrun/ikaros:v0.15.5
container_name: ikaros
```

Expand Down
14 changes: 7 additions & 7 deletions docs/getting-started/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ import DockerArgs from "./slots/docker-args.md"
- [ikarosrun/ikaros](https://hub.docker.com/r/ikarosrun/ikaros)

:::info 注意
目前 Ikaros 并未更新 Docker 的 latest 标签镜像,主要因为 暂未发布正式版本。我们推荐使用固定版本的标签,比如 `ikarosrun/ikaros:v0.14.1`
目前 Ikaros 并未更新 Docker 的 latest 标签镜像,主要因为 暂未发布正式版本。我们推荐使用固定版本的标签,比如 `ikarosrun/ikaros:v0.15.5`

- `ikarosrun/ikaros:v0.14.1`:表示最新的可用镜像,每次发布时都会根据GitHub的标签构建一个新的镜像
- `ikarosrun/ikaros:v0.15.5`:表示最新的可用镜像,每次发布时都会根据GitHub的标签构建一个新的镜像
- `ikarosrun/ikaros:dev`:表示开发中的镜像,不推荐使用,每次Pull Request合并到主分支都会构建并覆盖该镜像。。

后续文档以 `ikarosrun/ikaros:v0.14.1` 为例。
后续文档以 `ikarosrun/ikaros:v0.15.5` 为例。
:::

1. 创建容器
Expand All @@ -46,7 +46,7 @@ import DockerArgs from "./slots/docker-args.md"
--name ikaros \
-p 9999:9999 \
-v ~/.ikaros:/root/.ikaros \
ikarosrun/ikaros:v0.14.1 \
ikarosrun/ikaros:v0.15.5 \
--ikaros.security.initializer.master-username=tomoki \
--ikaros.security.initializer.master-password=tomoki
```
Expand All @@ -73,10 +73,10 @@ import DockerArgs from "./slots/docker-args.md"

## 升级版本

1. 拉取新版本镜像(请选择最新的标签替换下方的`v0.14.1`)
1. 拉取新版本镜像(请选择最新的标签替换下方的`v0.15.5`)

```bash
docker pull ikarosrun/ikaros:v0.14.1
docker pull ikarosrun/ikaros:v0.15.5
```

2. 停止运行中的容器
Expand Down Expand Up @@ -104,7 +104,7 @@ import DockerArgs from "./slots/docker-args.md"
--name ikaros \
-p 9999:9999 \
-v ~/.ikaros:/root/.ikaros \
ikarosrun/ikaros:v0.14.1 \
ikarosrun/ikaros:v0.15.5 \
--ikaros.security.initializer.master-username=tomoki \
--ikaros.security.initializer.master-password=tomoki
```
44 changes: 7 additions & 37 deletions docs/getting-started/install/flutter-app.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 非原生APP
title: APP
description: 基于Flutter的跨平台移动端APP
---

Expand All @@ -13,44 +13,14 @@ GitHub: <https://github.com/ikaros-dev/app>
目前功能不完善,欢迎体验测试
:::

## 功能演示

<https://www.bilibili.com/video/BV1ku411E7Dw>

<iframe src="//player.bilibili.com/player.html?aid=532195227&bvid=BV1ku411E7Dw&cid=1231958328&page=1&autoplay=0" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" width='100%' height='600px'> </iframe>

## Android安装包

先进这个页面:<https://github.com/ikaros-dev/app/actions/workflows/android-release.yml>

![Github Ikaros Flutter App Actions](/img/getting-started-install-flutter-app/Snipaste_2023-07-30_12-27-53.png)

往下拉,下载压缩包

![Github Ikaros Flutter App Actions](/img/getting-started-install-flutter-app/Snipaste_2023-07-30_12-31-38.png)

解压后,就是安装包了

![Github Ikaros Flutter App Actions](/img/getting-started-install-flutter-app/Snipaste_2023-07-30_12-34-29.png)
## 下载

## IOS安装包
[ikaros app github releases](https://github.com/ikaros-dev/app/releases) => 点击最新版本 => Assert
=> 安装包(安卓是apk,IOS是ipa后缀)。

:::tip
IOS安装包是未签名的,您需要进行[自签](https://bing.com/search?q=ios%E8%87%AA%E7%AD%BE&ensearch=1)才能正常使用。
:::

先进这个页面:<https://github.com/ikaros-dev/app/actions/workflows/ios-release.yml>

![Github Ikaros Flutter App Actions](/img/getting-started-install-flutter-app/Snipaste_2023-07-30_12-40-35.png)

往下拉,下载压缩包

![Github Ikaros Flutter App Actions](/img/getting-started-install-flutter-app/Snipaste_2023-07-30_12-41-09.png)

解压后,就是安装包了

![Github Ikaros Flutter App Actions](/img/getting-started-install-flutter-app/Snipaste_2023-07-30_12-44-00.png)
## 功能演示

## 其它平台
<https://www.bilibili.com/video/BV1ku411E7Dw>

暂时没有,就编译了`Android``IOS`,其它平台也没做适配。
<iframe src="//player.bilibili.com/player.html?aid=532195227&bvid=BV1ku411E7Dw&cid=1231958328&page=1&autoplay=0" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true" width='100%' height='600px'> </iframe>
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ docker run \
--name ikaros \
-p 9999:9999 \
-v ~/.ikaros:/root/.ikaros \
ikarosrun/ikaros:v0.14.1 \
ikarosrun/ikaros:v0.15.5 \
--ikaros.security.initializer.master-username=tomoki \
--ikaros.security.initializer.master-password=tomoki
```
Expand Down
22 changes: 22 additions & 0 deletions i18n/en/docusaurus-plugin-content-docs/version-0.15.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"version.label": {
"message": "0.15",
"description": "The label for version 0.15"
},
"sidebar.docsSidebar.category.getting-started": {
"message": "getting-started",
"description": "The label for category getting-started in sidebar docsSidebar"
},
"sidebar.docsSidebar.category.getting-started-install": {
"message": "getting-started-install",
"description": "The label for category getting-started-install in sidebar docsSidebar"
},
"sidebar.docsSidebar.category.user-guide": {
"message": "user-guide",
"description": "The label for category user-guide in sidebar docsSidebar"
},
"sidebar.docsSidebar.category.plugins": {
"message": "plugins",
"description": "The label for category plugins in sidebar docsSidebar"
}
}
17 changes: 17 additions & 0 deletions i18n/en/docusaurus-plugin-content-docs/version-0.15/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: About the Documentation
sidebar_label: About
description: Information about this documentation site
---

:::note
This documentation site is built using [Docusaurus](https://docusaurus.io/). Thanks to the [Docusaurus community](https://github.com/facebook/docusaurus) for their contributions.
:::

## Contributing

:::tip
If you find any inaccuracies or have content to add, we welcome your contributions to the documentation.
:::

The current repository for this documentation is located at [ikaros-dev/docs](https://github.com/ikaros-dev/docs). You can fork this repository, make your changes, and submit a pull request for us to review and merge.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Android App (WIP)
description: Native Android App
---

## Introduction

Native app for Android phones.

GitHub: <https://github.com/ikaros-dev/andapp>

:::tip
CI packaging has not been set up yet.
:::
Loading

0 comments on commit 8f42299

Please sign in to comment.