diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 14c1fac..5ac8f69 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,4 +1,5 @@ import { defineConfig } from 'vitepress' +import { pagefindPlugin } from 'vitepress-plugin-pagefind' const isProduction = process.env.NODE_ENV === 'production' @@ -85,6 +86,11 @@ export default defineConfig({ footer: { message: "MIT Licensed", copyright: "Copyright © 2024 Taiwan Web Technology Promotion Organization (Web Tech TW)" - } + }, + }, + vite: { + plugins: [ + pagefindPlugin(), + ], }, }) diff --git a/docs/about.md b/docs/about.md index 3edaa7b..3138a5c 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,15 +1,15 @@ # 🔮 About -Hello! +This is the bridge to exchange messages from different instant messaging platforms. -This is the bridge for LINE and Matrix, +![logo](statics/icon.min.png) -to communicate with the chat room which belongs to both of the different providers. +It's powered by opensource ecosystem. Thanks every contributor for their effort. -![logo](statics/icon.min.png) +Arona is a simple bridge for every messenger, helps sending your messages from anywhere to everywhere! -The bridge is using [line-bot-sdk-python](https://github.com/line/line-bot-sdk-python) and [matrix-nio](https://github.com/poljar/matrix-nio) for transporting. +Aims to provide a way to exchange messages between different platforms, such as LINE, Matrix, Telegram, and Discord. -[Instruction of Matrix Bridges](https://matrix.org/bridges/) +Make messages can be sent to any platform, let talks can be free and unlimited. -This is the documentation for Arona, the perfectest bridging for every messenger. +Let's make the world more connected and more friendly. diff --git a/docs/faq.md b/docs/faq.md index dd09fc0..2e09d86 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,7 @@ # ❓ FAQ +As known as Frequently Asked Questions. + ## What is Arona? Arona is a bridge for multiple messaging platforms. diff --git a/docs/index.md b/docs/index.md index 0aa93d7..8de08aa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -18,7 +18,7 @@ features: - title: Simplicity First details: Minimal setup with a simple and intuitive structure that makes it easy to get started. - title: Mutiple Platforms - details: It supports LINE, Telegram, Discord, and Matrix. + details: Send messages to multiple messaging platforms, including Discord, Telegram, Matrix, and LINE. - title: Open Source details: The project is open source and available on GitHub. - title: Cross-platform diff --git a/docs/introduction.md b/docs/introduction.md index 6f397f7..2074747 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -9,6 +9,6 @@ The project will provide a way to exchange messages between different platforms, ## Features - **Simple**: Minimal setup with a simple and intuitive structure that makes it easy to get started. -- **4 Instant Messengers Supported**: Support for LINE, Telegram, Discord and Matrix. +- **Multiple Platforms**: Send messages to multiple messaging platforms, including Discord, Telegram, Matrix, and LINE. - **Open Source**: The project is open source and available on [GitHub](https://github.com/web-tech-tw/arona). - **Cross-platform**: The bridge can be run on any platform that supports Node.js/Docker. diff --git a/docs/zh-tw/index.md b/docs/zh-tw/index.md deleted file mode 100644 index 4e6e303..0000000 --- a/docs/zh-tw/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: home - -hero: - name: Arona - text: "為世上每個通訊軟體打造簡單的溝通橋樑" - tagline: 將你的訊息傳送到全世界! - image: ../statics/icon.min.png - actions: - - theme: brand - text: GitHub - link: https://github.com/web-tech-tw/arona - - theme: alt - text: 文件 - link: /introduction - -features: - - title: 簡單易用 - details: 最小化設定,即可快速啟動。 - - title: 4 個通訊軟體平台 - details: 支援 LINE、Telegram、Discord 以及 Matrix。 - - title: 開放原始碼 - details: 本專案為開放原始碼,並且可在 GitHub 上取得。 - - title: 跨平台 - details: 本橋樑可在任何支援 Node.js/Docker 的平台上運行。 ---- diff --git a/package.json b/package.json index 31b0e58..ecad305 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,9 @@ "node-cache": "^5.1.2", "node-telegram-bot-api": "^0.66.0", "openai": "^4.52.0", + "pagefind": "^1.1.0", "tsx": "^4.15.6", + "vitepress-plugin-pagefind": "^0.4.9", "yaml": "^2.4.5" }, "devDependencies": {