diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts index 18a7e0728b..3fc8886a0e 100644 --- a/docs/.vuepress/config.ts +++ b/docs/.vuepress/config.ts @@ -94,6 +94,12 @@ export default defineUserConfig({ }, markdown: { + image: { + lazyload: true, + mark: true, + size: true, + }, + icon: { provider: 'iconify' }, plot: true, field: true, diff --git a/docs/.vuepress/public/images/maa-logo_512x512.png b/docs/.vuepress/public/images/maa-logo_512x512.png index 1af2759966..6356261679 100644 Binary files a/docs/.vuepress/public/images/maa-logo_512x512.png and b/docs/.vuepress/public/images/maa-logo_512x512.png differ diff --git a/docs/.vuepress/public/images/preview.jpg b/docs/.vuepress/public/images/preview.jpg new file mode 100644 index 0000000000..47411e0f80 Binary files /dev/null and b/docs/.vuepress/public/images/preview.jpg differ diff --git a/docs/en-us/develop/documentation-guidelines.md b/docs/en-us/develop/documentation-guidelines.md index ebea7a35aa..0351c6f4da 100644 --- a/docs/en-us/develop/documentation-guidelines.md +++ b/docs/en-us/develop/documentation-guidelines.md @@ -9,12 +9,12 @@ icon: jam:write-f The purpose of this document is to guide document writers to better utilize the functionalities provided by the theme, thus achieving a more readable effect. ::: -Our documentation is built on [vuepress](https://github.com/vuejs/vuepress) and utilizes the [vuepress-theme-hope](https://github.com/vuepress-theme-hope/vuepress-theme-hope) theme. You can also refer to the [official documentation](https://theme-hope.vuejs.press/) for more detailed explanations. Here, we only introduce some common functionalities. +Our documentation is built on [vuepress](https://github.com/vuejs/vuepress) and utilizes the [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume) theme. You can also refer to the [official documentation](https://theme-plume.vuejs.press/) for more detailed explanations. Here, we only introduce some common functionalities. ## Deploy Locally 1. Install [Pnpm](https://pnpm.io/installation), and clone the repository refer to [Introduction to GitHub Pull request Flow](./development.md#introduction-to-github-pull-request-flow). -2. Create a terminal in the `website` directory, then run `pnpm i` to download dependencies. +2. Create a terminal in the `docs` directory, then run `pnpm i` to download dependencies. 3. Run `pnpm run dev` to deploy. ## Containers diff --git a/docs/ja-jp/develop/documentation-guidelines.md b/docs/ja-jp/develop/documentation-guidelines.md index fd64cc4855..b7a6eeeb91 100644 --- a/docs/ja-jp/develop/documentation-guidelines.md +++ b/docs/ja-jp/develop/documentation-guidelines.md @@ -9,7 +9,13 @@ icon: jam:write-f このドキュメントの目的は、ドキュメント作成者がテーマが提供する機能をより良く活用し、読みやすさを向上させることを指導することです。 ::: -私たちのドキュメントは [vuepress](https://github.com/vuejs/vuepress) に基づいて構築されており、[vuepress-theme-hope](https://github.com/vuepress-theme-hope/vuepress-theme-hope) テーマが使用されています。詳細な説明については[公式ドキュメント](https://theme-hope.vuejs.press/)をご覧いただけます。ここでは一部の一般的な機能について紹介します。 +私たちのドキュメントは [vuepress](https://github.com/vuejs/vuepress) に基づいて構築されており、[vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume) テーマが使用されています。詳細な説明については[公式ドキュメント](https://theme-plume.vuejs.press/)をご覧いただけます。ここでは一部の一般的な機能について紹介します。 + +## ローカルデプロイ + +1. [pnpm](https://pnpm.io/installation) をインストールし、[Pull Request ワークフローの概要](./development.md#github-pull-request-プロセス概要)を参照してリポジトリをローカルにクローンします。 +2. `docs` ディレクトリでターミナルを開き、`pnpm i` を実行して依存関係をインストールします。 +3. `pnpm run dev` を実行してデプロイします。 ## コンテナ diff --git a/docs/ko-kr/develop/documentation-guidelines.md b/docs/ko-kr/develop/documentation-guidelines.md index f46c5e3109..4b7605ee2f 100644 --- a/docs/ko-kr/develop/documentation-guidelines.md +++ b/docs/ko-kr/develop/documentation-guidelines.md @@ -9,12 +9,12 @@ icon: jam:write-f 이 문서의 목적은 문서 작성자가 주제가 제공하는 기능을 더 잘 활용하여 더 읽기 쉬운 효과를 얻는 데 도움을 주는 것입니다. ::: -우리의 문서는 [vuepress](https://github.com/vuejs/vuepress)로 작성되었으며, [vuepress-theme-hope](https://github.com/vuepress-theme-hope/vuepress-theme-hope) 테마를 사용하고 있습니다. 더 자세한 설명은 [공식 문서](https://theme-hope.vuejs.press/zh/)를 참조할 수 있으며, 여기서는 일부 일반적인 기능에 대해서만 소개하겠습니다. +우리의 문서는 [vuepress](https://github.com/vuejs/vuepress)로 작성되었으며, [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume) 테마를 사용하고 있습니다. 더 자세한 설명은 [공식 문서](https://theme-plume.vuejs.press/)를 참조할 수 있으며, 여기서는 일부 일반적인 기능에 대해서만 소개하겠습니다. ## 로컬 배포 1. [pnpm](https://pnpm.io/installation)을 설치하고, [Pull Request 가이드](./development.md#github-pull-request-진행-과정)을 참고해, 저장소를 로컬에 클론합니다. -2. `website` 경로에서 새로운 터미널을 열고, `pnpm i` 을 실행하여 의존성 파일을 다운로드합니다. +2. `docs` 경로에서 새로운 터미널을 열고, `pnpm i` 을 실행하여 의존성 파일을 다운로드합니다. 3. `pnpm run dev` 를 실행하여 배포를 시작합니다. ## 컨테이너 diff --git a/docs/zh-cn/develop/documentation-guidelines.md b/docs/zh-cn/develop/documentation-guidelines.md index d17fcee2d7..676d072be9 100644 --- a/docs/zh-cn/develop/documentation-guidelines.md +++ b/docs/zh-cn/develop/documentation-guidelines.md @@ -14,7 +14,7 @@ icon: jam:write-f ## 本地部署 1. 安装 [pnpm](https://pnpm.io/installation),并参考 [Pull Request 流程简述](./development.md#github-pull-request-流程简述)将仓库克隆到本地。 -2. 在 `website` 目录下新建终端,运行 `pnpm i` 部署依赖。 +2. 在 `docs` 目录下新建终端,运行 `pnpm i` 部署依赖。 3. 运行 `pnpm run dev` 进行部署。 ## 容器与卡片 diff --git a/docs/zh-tw/develop/documentation-guidelines.md b/docs/zh-tw/develop/documentation-guidelines.md index 56be40d174..6997a82dbf 100644 --- a/docs/zh-tw/develop/documentation-guidelines.md +++ b/docs/zh-tw/develop/documentation-guidelines.md @@ -9,12 +9,12 @@ icon: jam:write-f 本文件的目的在於指導文件編寫者更好地使用主題提供的功能,以達到更易讀的效果。 ::: -我們的文件基於 [vuepress](https://github.com/vuejs/vuepress) 構建,使用了 [vuepress-theme-hope](https://github.com/vuepress-theme-hope/vuepress-theme-hope) 主題,你也可以查看[官方文件](https://theme-hope.vuejs.press/zh/)來獲取更詳細的說明,這裡僅介紹一些常用的功能。 +我們的文件基於 [vuepress](https://github.com/vuejs/vuepress) 構建,使用了 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume) 主題,你也可以查看[官方文件](https://theme-plume.vuejs.press/)來獲取更詳細的說明,這裡僅介紹一些常用的功能。 ## 本地部署 1. 安裝 [pnpm](https://pnpm.io/zh/installation),並參考 [Pull Request 流程簡述](./development.md#github-pull-request-流程簡述)將倉庫克隆到本地。 -2. 在 `website` 目錄下新建終端,運行 `pnpm i` 下載依賴。 +2. 在 `docs` 目錄下新建終端,運行 `pnpm i` 下載依賴。 3. 運行 `pnpm run dev` 進行部署。 ## 容器