diff --git a/.github/workflows/build-and-release-documents.yml b/.github/workflows/build-and-release-documents.yml index e9fe91abb..00a0b9970 100644 --- a/.github/workflows/build-and-release-documents.yml +++ b/.github/workflows/build-and-release-documents.yml @@ -5,7 +5,6 @@ name: ドキュメントのビルドとリリース on: push: - branches: [main] tags: - 'v[0-9]+.[0-9]+.[0-9]+' - 'v[0-9]+.[0-9]+.[0-9]+-Beta[0-9]+' @@ -13,6 +12,7 @@ on: permissions: id-token: write + contents: write env: APP_ALESINFINY_MARIS_WEBAPP_NAME: app-alesinfiny-maris-docs-prod @@ -52,6 +52,7 @@ jobs: uses: ./.github/workflows/compress-sample-source with: compressed-source-path: ${{ env.DOCUMENT_BASE_PATH }}/${{ env.COMPRESSED_SOURCE_PATH }} + - name: ドキュメントのビルド uses: ./.github/workflows/build-documents with: diff --git a/.github/workflows/build-documents/action.yml b/.github/workflows/build-documents/action.yml index 82c443e0e..eda03bd71 100644 --- a/.github/workflows/build-documents/action.yml +++ b/.github/workflows/build-documents/action.yml @@ -2,10 +2,10 @@ name: "ドキュメントのビルド" description: "ドキュメントをビルドします。" inputs: document-base-path: - desctiption: "ドキュメントのベースフォルダパス" + description: "ドキュメントのベースフォルダパス" required: true output-folder-name: - desctiption: "ビルドしたドキュメントの出力先フォルダ名" + description: "ビルドしたドキュメントの出力先フォルダ名" required: true runs: using: "composite" @@ -21,6 +21,12 @@ runs: python -m pip install --upgrade pip python -m pip install -r requirements.txt + - name: ソーシャルカードプラグイン用のパッケージインストール + shell: bash + run: | + python -m pip install "mkdocs-material[imaging]" + sudo apt-get install pngquant + - id: setup-version name: ドキュメントのバージョン設定 shell: bash @@ -37,6 +43,7 @@ runs: continue-on-error: true shell: bash run: | + export BUILD_DOCUMENTS=true cd "${{ inputs.document-base-path }}" echo '# Mkdocs Build Result :factory:' >> $GITHUB_STEP_SUMMARY mkdocs build --verbose --clean --strict --site-dir "${{ inputs.output-folder-name }}" > mkdocs_build_log.txt diff --git a/.github/workflows/compress-sample-source/action.yml b/.github/workflows/compress-sample-source/action.yml index 3a286d818..baa2aa39b 100644 --- a/.github/workflows/compress-sample-source/action.yml +++ b/.github/workflows/compress-sample-source/action.yml @@ -2,7 +2,7 @@ name: "サンプルアプリケーションのソースコード圧縮" description: "サンプルアプリケーションのソースコードを圧縮します。" inputs: compressed-source-path: - desctiption: "圧縮したソースコードを配置するフォルダのGITHUB_WORKSPACEからの相対パス" + description: "圧縮したソースコードを配置するフォルダのGITHUB_WORKSPACEからの相対パス" required: true runs: diff --git a/.github/workflows/lint-documents/action.yml b/.github/workflows/lint-documents/action.yml index a988fb874..d2415e2e5 100644 --- a/.github/workflows/lint-documents/action.yml +++ b/.github/workflows/lint-documents/action.yml @@ -34,7 +34,7 @@ runs: shell: bash run: | echo '## Markdownlint Result' >> $GITHUB_STEP_SUMMARY - npx markdownlint --config .markdownlint.yaml --ignore **/node_modules/** --output markdownlint-result.txt . + npx markdownlint --config .markdownlint.yaml --rules custom-lint-rules --ignore **/node_modules/** --output markdownlint-result.txt . echo ':heavy_check_mark: Markdownlint に成功しました。' >> $GITHUB_STEP_SUMMARY - name: Markdownlint 失敗時の結果表示 diff --git a/.github/workflows/pack-and-upload/action.yml b/.github/workflows/pack-and-upload/action.yml index 786545518..3d44911b2 100644 --- a/.github/workflows/pack-and-upload/action.yml +++ b/.github/workflows/pack-and-upload/action.yml @@ -2,7 +2,7 @@ name: "ビルドアーティファクトのパッケージングとアップロ description: "ドキュメントをzip化してアップロードします。" inputs: packaging-folder-path: - desctiption: "パッケージングする対象のGITHUB_WORKSPACEからの相対パス" + description: "パッケージングする対象のGITHUB_WORKSPACEからの相対パス" required: true document-artifact-path: description: "zipファイルのGITHUB_WORKSPACEからの相対パス" diff --git a/custom-lint-rules/requires-title-and-description.js b/custom-lint-rules/requires-title-and-description.js new file mode 100644 index 000000000..7bb33a864 --- /dev/null +++ b/custom-lint-rules/requires-title-and-description.js @@ -0,0 +1,37 @@ + +const hasTitleAndDescription = (params, onError) => { + const title_line = params.frontMatterLines.filter((line) => + line.startsWith("title: ") + ); + const description_line = params.frontMatterLines.filter((line) => + line.startsWith("description: ") + ); + if (title_line.length < 1) { + onError({ + lineNumber: 1, + detail: "Title is not specified", + }); + } else if (title_line.length > 1) { + onError({ + lineNumber: 1, + detail: "Document files are not allowed to specify multiple lists of title", + }); + } else if (description_line.length < 1) { + onError({ + lineNumber: 1, + detail: "Description is not specified", + }); + } else if (description_line.length > 1) { + onError({ + lineNumber: 1, + detail: "Document files are not allowed to specify multiple lists of description", + }); + } + }; + +module.exports = { + names: ["CMD001", "requires-title-and-description"], + description: "All documents should specify title and description", + tags: ["custom"], + function: hasTitleAndDescription, + }; \ No newline at end of file diff --git a/documents/README.md b/documents/README.md index 9bfa778d2..4cbb466d4 100644 --- a/documents/README.md +++ b/documents/README.md @@ -1,4 +1,6 @@ + + # AlesInfiny Maris OSS Edition ドキュメントについて @@ -218,6 +220,43 @@ cSpell の拡張機能をインストールしていると、 [問題] ウィン +### 各ページの title/description の設定 + +以下のように、各 markdown ファイルの上部に `title` と `description` を設定しています。 + +``` text +--- +title: CSR 編 +description: クライアントサイドレンダリングを行う Web アプリケーションの アーキテクチャについて解説します。 +--- +``` + +ここで設定した `title` と `description` を元にソーシャルカードが生成されるため、以下の文字数を守って設定します。 +( `description` を省略すると、 mkdocs.yml の `site_description` の値が設定されます。) + +- カード上に表示できる文字数 + - `title`：全角 9 文字×3 行まで + - `description`: 半角 59 文字(全角だと 30 文字目が半分途切れる)× 2 行まで + +※スペースを空けないと 1 単語とみなされ、同じ行に詰め込もうとして文章が途切れるので適宜スペースで区切ってください。 + +- 例： + + - `title: .NETアプリケーションの処理方式` の場合 + ![ソーシャルカード失敗例](readme-images/social-card-example-error.png) + - `title: .NET アプリケーションの 処理方式` の場合 + ![ソーシャルカード](readme-images/social-card-example.png) + +文字が途切れていないか等を適宜確認してください。 +ソーシャルカードはローカルでは生成せず、 CI 上でのドキュメントビルド時に生成されるよう設定しています。 +生成されたソーシャルカードは以下の手順で確認してください。 + +1. GitHub Actions の「ドキュメントのビルド(CI 用)」を開き、対象のブランチを選択してワークフローを実行します。 + +1. 実行したワークフローの Summary の Artifacts から　documents をダウンロードします。 + +1. ダウンロードした documents.zip 内の docs.zip を解凍し、`assets/images/social` に生成されたソーシャルカードを確認します。 + ### 修正内容のコミット 記事の作成と体裁の修正が完了したら、 Feature ブランチにコミットします。 diff --git a/documents/contents/about-maris/credits.md b/documents/contents/about-maris/credits.md index eb074baba..7118bac35 100644 --- a/documents/contents/about-maris/credits.md +++ b/documents/contents/about-maris/credits.md @@ -1,5 +1,6 @@ --- title: クレジット表記 +description: AlesInfiny Maris OSS Edition ポータルサイトのクレジット表記です。 --- diff --git a/documents/contents/about-maris/terms.md b/documents/contents/about-maris/terms.md index 8057bda53..66c929082 100644 --- a/documents/contents/about-maris/terms.md +++ b/documents/contents/about-maris/terms.md @@ -1,5 +1,6 @@ --- title: 利用規約 +description: AlesInfiny Maris OSS Edition ポータルサイトの利用規約です。 --- # 利用規約 {#top} diff --git a/documents/contents/about-maris/trademarks.md b/documents/contents/about-maris/trademarks.md index 65604cfac..87fba5f94 100644 --- a/documents/contents/about-maris/trademarks.md +++ b/documents/contents/about-maris/trademarks.md @@ -1,5 +1,6 @@ --- title: 商標 +description: AlesInfiny Maris OSS Edition の商標について説明します。 --- # 商標 {#top} diff --git a/documents/contents/app-architecture/client-side-rendering/csr-architecture-overview.md b/documents/contents/app-architecture/client-side-rendering/csr-architecture-overview.md index de5f875db..0cc84b98c 100644 --- a/documents/contents/app-architecture/client-side-rendering/csr-architecture-overview.md +++ b/documents/contents/app-architecture/client-side-rendering/csr-architecture-overview.md @@ -1,6 +1,6 @@ --- title: CSR 編 -description: クライアントサイドレンダリングを行う Web アプリケーションのアーキテクチャについて解説します。 +description: クライアントサイドレンダリングを行う Web アプリケーションの アーキテクチャについて解説します。 --- # CSR アーキテクチャ概要 {#top} diff --git a/documents/contents/app-architecture/client-side-rendering/frontend-architecture.md b/documents/contents/app-architecture/client-side-rendering/frontend-architecture.md index d0ff9d6e5..a6202ed03 100644 --- a/documents/contents/app-architecture/client-side-rendering/frontend-architecture.md +++ b/documents/contents/app-architecture/client-side-rendering/frontend-architecture.md @@ -1,6 +1,6 @@ --- title: CSR 編 -description: クライアントサイドレンダリングを行う Web アプリケーションのアーキテクチャについて解説します。 +description: クライアントサイドレンダリングを行う Web アプリケーションの アーキテクチャについて解説します。 --- # フロントエンドアーキテクチャ {#top} diff --git a/documents/contents/app-architecture/client-side-rendering/global-function.md b/documents/contents/app-architecture/client-side-rendering/global-function.md index b61e02dce..6b72e8905 100644 --- a/documents/contents/app-architecture/client-side-rendering/global-function.md +++ b/documents/contents/app-architecture/client-side-rendering/global-function.md @@ -1,6 +1,6 @@ --- title: CSR 編 -description: クライアントサイドレンダリングを行う Web アプリケーションのアーキテクチャについて解説します。 +description: クライアントサイドレンダリングを行う Web アプリケーションの アーキテクチャについて解説します。 --- # 全体処理方式 {#top} diff --git a/documents/contents/app-architecture/client-side-rendering/index.md b/documents/contents/app-architecture/client-side-rendering/index.md index d69aeb948..73ea360fd 100644 --- a/documents/contents/app-architecture/client-side-rendering/index.md +++ b/documents/contents/app-architecture/client-side-rendering/index.md @@ -1,6 +1,6 @@ --- title: CSR 編 -description: クライアントサイドレンダリングを行う Web アプリケーションのアーキテクチャについて解説します。 +description: クライアントサイドレンダリングを行う Web アプリケーションの アーキテクチャについて解説します。 --- # クライアントサイドレンダリング編 {#top} diff --git a/documents/contents/app-architecture/client-side-rendering/test/backend-application/unit-test.md b/documents/contents/app-architecture/client-side-rendering/test/backend-application/unit-test.md index 075f13caf..80dea1eb3 100644 --- a/documents/contents/app-architecture/client-side-rendering/test/backend-application/unit-test.md +++ b/documents/contents/app-architecture/client-side-rendering/test/backend-application/unit-test.md @@ -1 +1,6 @@ +--- +title: CSR 編 - テスト +description: バックエンドアプリケーションのテスト方針について解説します。 +--- + # 単体テスト ( UT0 ) {#top} diff --git a/documents/contents/app-architecture/console-app/index.md b/documents/contents/app-architecture/console-app/index.md index 425520d17..9b7907f89 100644 --- a/documents/contents/app-architecture/console-app/index.md +++ b/documents/contents/app-architecture/console-app/index.md @@ -1 +1,6 @@ +--- +title: コンソール アプリケーション編 +description: コンソールアプリケーションの アーキテクチャについて解説します。 +--- + # コンソールアプリケーション編 {#top} diff --git a/documents/contents/app-architecture/index.md b/documents/contents/app-architecture/index.md index 0855a9914..3d8b0a37c 100644 --- a/documents/contents/app-architecture/index.md +++ b/documents/contents/app-architecture/index.md @@ -1,3 +1,8 @@ +--- +title: アプリケーション アーキテクチャ +description: AlesInfiny Maris OSS Edition を利用することで構築できる アプリケーションについて説明します。 +--- + # アプリケーションアーキテクチャ {#top} - [概要編](./overview/index.md) diff --git a/documents/contents/app-architecture/overview/application-kind.md b/documents/contents/app-architecture/overview/application-kind.md index bf1e64f16..a11f6acbd 100644 --- a/documents/contents/app-architecture/overview/application-kind.md +++ b/documents/contents/app-architecture/overview/application-kind.md @@ -1,6 +1,6 @@ --- title: 概要編 -description: AlesInfiny Maris OSS Edition を利用することで構築できるアプリケーションの概要を、アプリケーション形態ごとに説明します。 +description: AlesInfiny Maris OSS Edition を利用することで構築できる アプリケーションの概要を説明します。 --- # 構築できるアプリケーション形態 {#top} diff --git a/documents/contents/app-architecture/overview/application-structure.md b/documents/contents/app-architecture/overview/application-structure.md index 1e7f23018..0dc463246 100644 --- a/documents/contents/app-architecture/overview/application-structure.md +++ b/documents/contents/app-architecture/overview/application-structure.md @@ -1,6 +1,6 @@ --- title: 概要編 -description: AlesInfiny Maris OSS Edition を利用することで構築できるアプリケーションの概要を、アプリケーション形態ごとに説明します。 +description: AlesInfiny Maris OSS Edition を利用することで構築できる アプリケーションの概要を説明します。 --- # アプリケーション構成 {#top} diff --git a/documents/contents/app-architecture/overview/configuration-management.md b/documents/contents/app-architecture/overview/configuration-management.md index f60cdb3fc..6c39de426 100644 --- a/documents/contents/app-architecture/overview/configuration-management.md +++ b/documents/contents/app-architecture/overview/configuration-management.md @@ -1,6 +1,6 @@ --- title: 概要編 -description: AlesInfiny Maris OSS Edition のアプリケーションアーキテクチャ概要を解説します。 +description: AlesInfiny Maris OSS Edition を利用することで構築できる アプリケーションの概要を説明します。 --- # 構成管理 {#top} diff --git a/documents/contents/app-architecture/overview/dotnet-application-processing-system/event-id-management-policy.md b/documents/contents/app-architecture/overview/dotnet-application-processing-system/event-id-management-policy.md index 61a85ff6b..d0fd3bf96 100644 --- a/documents/contents/app-architecture/overview/dotnet-application-processing-system/event-id-management-policy.md +++ b/documents/contents/app-architecture/overview/dotnet-application-processing-system/event-id-management-policy.md @@ -1,5 +1,5 @@ --- -title: .NETアプリケーションの処理方式 +title: .NET アプリケーションの 処理方式 description: AlesInfiny Maris OSS Edition で構築する .NET アプリケーションの共通的な処理方式を解説します。 --- diff --git a/documents/contents/app-architecture/overview/dotnet-application-processing-system/exception-handling-policy.md b/documents/contents/app-architecture/overview/dotnet-application-processing-system/exception-handling-policy.md index 4156d7790..77077cff5 100644 --- a/documents/contents/app-architecture/overview/dotnet-application-processing-system/exception-handling-policy.md +++ b/documents/contents/app-architecture/overview/dotnet-application-processing-system/exception-handling-policy.md @@ -1,5 +1,5 @@ --- -title: .NETアプリケーションの処理方式 +title: .NET アプリケーションの 処理方式 description: AlesInfiny Maris OSS Edition で構築する .NET アプリケーションの共通的な処理方式を解説します。 --- diff --git a/documents/contents/app-architecture/overview/dotnet-application-processing-system/health-check-necessity.md b/documents/contents/app-architecture/overview/dotnet-application-processing-system/health-check-necessity.md index c981da67a..6d1ecb6e2 100644 --- a/documents/contents/app-architecture/overview/dotnet-application-processing-system/health-check-necessity.md +++ b/documents/contents/app-architecture/overview/dotnet-application-processing-system/health-check-necessity.md @@ -1,5 +1,5 @@ --- -title: .NETアプリケーションの処理方式 +title: .NET アプリケーションの 処理方式 description: AlesInfiny Maris OSS Edition で構築する .NET アプリケーションの共通的な処理方式を解説します。 --- diff --git a/documents/contents/app-architecture/overview/dotnet-application-processing-system/index.md b/documents/contents/app-architecture/overview/dotnet-application-processing-system/index.md index db479324f..d5fab5d85 100644 --- a/documents/contents/app-architecture/overview/dotnet-application-processing-system/index.md +++ b/documents/contents/app-architecture/overview/dotnet-application-processing-system/index.md @@ -1,5 +1,5 @@ --- -title: .NETアプリケーションの処理方式 +title: .NET アプリケーションの 処理方式 description: AlesInfiny Maris OSS Edition で構築する .NET アプリケーションの共通的な処理方式を解説します。 --- diff --git a/documents/contents/app-architecture/overview/dotnet-application-processing-system/input-validation-policy.md b/documents/contents/app-architecture/overview/dotnet-application-processing-system/input-validation-policy.md index e24d3798e..c63e81f99 100644 --- a/documents/contents/app-architecture/overview/dotnet-application-processing-system/input-validation-policy.md +++ b/documents/contents/app-architecture/overview/dotnet-application-processing-system/input-validation-policy.md @@ -1,5 +1,5 @@ --- -title: .NETアプリケーションの処理方式 +title: .NET アプリケーションの 処理方式 description: AlesInfiny Maris OSS Edition で構築する .NET アプリケーションの共通的な処理方式を解説します。 --- diff --git a/documents/contents/app-architecture/overview/dotnet-application-processing-system/logging-policy.md b/documents/contents/app-architecture/overview/dotnet-application-processing-system/logging-policy.md index 850808d15..2ec781809 100644 --- a/documents/contents/app-architecture/overview/dotnet-application-processing-system/logging-policy.md +++ b/documents/contents/app-architecture/overview/dotnet-application-processing-system/logging-policy.md @@ -1,5 +1,5 @@ --- -title: .NETアプリケーションの処理方式 +title: .NET アプリケーションの 処理方式 description: AlesInfiny Maris OSS Edition で構築する .NET アプリケーションの共通的な処理方式を解説します。 --- diff --git a/documents/contents/app-architecture/overview/dotnet-application-processing-system/message-management-policy.md b/documents/contents/app-architecture/overview/dotnet-application-processing-system/message-management-policy.md index 045e4b409..1ad913fea 100644 --- a/documents/contents/app-architecture/overview/dotnet-application-processing-system/message-management-policy.md +++ b/documents/contents/app-architecture/overview/dotnet-application-processing-system/message-management-policy.md @@ -1,5 +1,5 @@ --- -title: .NETアプリケーションの処理方式 +title: .NET アプリケーションの 処理方式 description: AlesInfiny Maris OSS Edition で構築する .NET アプリケーションの共通的な処理方式を解説します。 --- diff --git a/documents/contents/app-architecture/overview/dotnet-application-processing-system/transaction-management-policy.md b/documents/contents/app-architecture/overview/dotnet-application-processing-system/transaction-management-policy.md index 3e77375f6..0ce4aaf78 100644 --- a/documents/contents/app-architecture/overview/dotnet-application-processing-system/transaction-management-policy.md +++ b/documents/contents/app-architecture/overview/dotnet-application-processing-system/transaction-management-policy.md @@ -1,5 +1,5 @@ --- -title: .NETアプリケーションの処理方式 +title: .NET アプリケーションの 処理方式 description: AlesInfiny Maris OSS Edition で構築する .NET アプリケーションの共通的な処理方式を解説します。 --- diff --git a/documents/contents/app-architecture/overview/index.md b/documents/contents/app-architecture/overview/index.md index 23eacd571..8f9b9660f 100644 --- a/documents/contents/app-architecture/overview/index.md +++ b/documents/contents/app-architecture/overview/index.md @@ -1,6 +1,6 @@ --- title: 概要編 -description: AlesInfiny Maris OSS Edition を利用することで構築できるアプリケーションの概要を、アプリケーション形態ごとに説明します。 +description: AlesInfiny Maris OSS Edition を利用することで構築できる アプリケーションの概要を説明します。 --- # 概要編 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/configure-asp-net-core-web-api-project.md b/documents/contents/guidebooks/how-to-develop/dotnet/configure-asp-net-core-web-api-project.md index 62a8a1bd4..191065961 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/configure-asp-net-core-web-api-project.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/configure-asp-net-core-web-api-project.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- # ASP.NET Core Web API プロジェクトの構成 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/configure-asp-net-core-with-vite-project.md b/documents/contents/guidebooks/how-to-develop/dotnet/configure-asp-net-core-with-vite-project.md index 23760efab..b746ed92a 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/configure-asp-net-core-with-vite-project.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/configure-asp-net-core-with-vite-project.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- # ASP.NET Core with Vite プロジェクトの構成 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/configure-integration-test-project.md b/documents/contents/guidebooks/how-to-develop/dotnet/configure-integration-test-project.md index 92e2b0794..a1a49f53b 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/configure-integration-test-project.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/configure-integration-test-project.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- # 結合テストプロジェクトの構成 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/create-project-structure.md b/documents/contents/guidebooks/how-to-develop/dotnet/create-project-structure.md index 1dd99a61d..352088897 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/create-project-structure.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/create-project-structure.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- # プロジェクト構造の作成 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/create-project.md b/documents/contents/guidebooks/how-to-develop/dotnet/create-project.md index 258b7205e..57f841692 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/create-project.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/create-project.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- # プロジェクトの作成 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/create-solution-structure.md b/documents/contents/guidebooks/how-to-develop/dotnet/create-solution-structure.md index 88913f12c..1e76ad33e 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/create-solution-structure.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/create-solution-structure.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- # ソリューション構造の作成 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/health-check-api.md b/documents/contents/guidebooks/how-to-develop/dotnet/health-check-api.md index b02ada910..7245b76a2 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/health-check-api.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/health-check-api.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- # ヘルスチェック API の実装 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/index.md b/documents/contents/guidebooks/how-to-develop/dotnet/index.md index 88e65c5a9..e2b2ed6ba 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/index.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/index.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- # .NET 編 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/preparation.md b/documents/contents/guidebooks/how-to-develop/dotnet/preparation.md index 2459fc85b..0ed9d0b64 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/preparation.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/preparation.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- # 事前準備 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/dotnet/project-settings.md b/documents/contents/guidebooks/how-to-develop/dotnet/project-settings.md index 2ffccfe84..281c99397 100644 --- a/documents/contents/guidebooks/how-to-develop/dotnet/project-settings.md +++ b/documents/contents/guidebooks/how-to-develop/dotnet/project-settings.md @@ -1,6 +1,6 @@ --- title: .NET 編 -description: バックエンドで動作する .NET アプリケーションの開発手順を解説します。 +description: バックエンドで動作する .NET アプリケーションの 開発手順を解説します。 --- diff --git a/documents/contents/guidebooks/how-to-develop/index.md b/documents/contents/guidebooks/how-to-develop/index.md index a76536c6b..23d4627e1 100644 --- a/documents/contents/guidebooks/how-to-develop/index.md +++ b/documents/contents/guidebooks/how-to-develop/index.md @@ -1,6 +1,6 @@ --- -title: 開発手順 -description: AlesInfiny Maris OSS Edition で開発可能なアプリケーションの開発手順を示すガイドラインです。 +title: アプリケーション 開発手順 +description: AlesInfiny Maris OSS Edition で開発可能な アプリケーションの開発手順を示すガイドラインです。 --- # アプリケーション開発手順 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/local-environment/index.md b/documents/contents/guidebooks/how-to-develop/local-environment/index.md index d1c64dea5..010a4edc4 100644 --- a/documents/contents/guidebooks/how-to-develop/local-environment/index.md +++ b/documents/contents/guidebooks/how-to-develop/local-environment/index.md @@ -1,6 +1,6 @@ --- title: 開発環境構築 -description: AlesInfiny Maris OSS Edition のアプリケーション開発で最低限必要な環境の構築方法を解説します。 +description: AlesInfiny Maris OSS Edition のアプリケーション開発で 最低限必要な環境の構築方法を解説します。 --- # ローカル開発環境の構築 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/publication/index.md b/documents/contents/guidebooks/how-to-develop/publication/index.md index 3b91874ad..f59de2802 100644 --- a/documents/contents/guidebooks/how-to-develop/publication/index.md +++ b/documents/contents/guidebooks/how-to-develop/publication/index.md @@ -1,6 +1,6 @@ --- -title: アプリケーションの発行 -description: .NET + Vue.js で構成されたアプリケーションの発行手順について解説します。 +title: アプリケーションの 発行 +description: .NET + Vue.js で構成されたアプリケーションの 発行手順について解説します。 --- # アプリケーションの発行 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/create-api-client-code.md b/documents/contents/guidebooks/how-to-develop/vue-js/create-api-client-code.md index 39cac96ae..2d43ef0f5 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/create-api-client-code.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/create-api-client-code.md @@ -1,6 +1,6 @@ --- title: Vue.js 開発手順 -description: Vue.js を用いたクライアントサイドアプリケーションの開発手順を説明します。 +description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 --- # Open API 仕様書からのクライアントコード生成 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/create-vuejs-blank-project.md b/documents/contents/guidebooks/how-to-develop/vue-js/create-vuejs-blank-project.md index 63e94eb46..c4d101233 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/create-vuejs-blank-project.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/create-vuejs-blank-project.md @@ -1,6 +1,6 @@ --- title: Vue.js 開発手順 -description: Vue.js を用いたクライアントサイドアプリケーションの開発手順を説明します。 +description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 --- # ブランクプロジェクトの作成 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/css.md b/documents/contents/guidebooks/how-to-develop/vue-js/css.md index 057513d28..9557c60cc 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/css.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/css.md @@ -1,6 +1,6 @@ --- title: Vue.js 開発手順 -description: Vue.js を用いたクライアントサイドアプリケーションの開発手順を説明します。 +description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 --- # CSS の設定と CSS フレームワークの適用 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/folder-structure-of-blank-project.md b/documents/contents/guidebooks/how-to-develop/vue-js/folder-structure-of-blank-project.md index d71c0c538..061e2fab5 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/folder-structure-of-blank-project.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/folder-structure-of-blank-project.md @@ -1,6 +1,6 @@ --- title: Vue.js 開発手順 -description: Vue.js を用いたクライアントサイドアプリケーションの開発手順を説明します。 +description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 --- # ブランクプロジェクトのフォルダー構造 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/index.md b/documents/contents/guidebooks/how-to-develop/vue-js/index.md index 40bf4fb57..8a983005a 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/index.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/index.md @@ -1,6 +1,6 @@ --- title: Vue.js 開発手順 -description: Vue.js を用いたクライアントサイドアプリケーションの開発手順を説明します。 +description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 --- # Vue.js 編 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/input-validation.md b/documents/contents/guidebooks/how-to-develop/vue-js/input-validation.md index 712c159cd..98cd890d0 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/input-validation.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/input-validation.md @@ -1,6 +1,6 @@ --- title: Vue.js 開発手順 -description: Vue.js を用いたクライアントサイドアプリケーションの開発手順を説明します。 +description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 --- # 入力値検証 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/optional-packages.md b/documents/contents/guidebooks/how-to-develop/vue-js/optional-packages.md index 4888a06e0..25277ef78 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/optional-packages.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/optional-packages.md @@ -1,6 +1,6 @@ --- title: Vue.js 開発手順 -description: Vue.js を用いたクライアントサイドアプリケーションの開発手順を説明します。 +description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 --- # 開発に使用するパッケージ {#top} diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md b/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md index c51d3b198..916542fcd 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/preparation.md @@ -1,6 +1,6 @@ --- title: Vue.js 開発手順 -description: Vue.js を用いたクライアントサイドアプリケーションの開発手順を説明します。 +description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 --- # 事前準備 {#top} diff --git a/documents/contents/guidebooks/how-to-develop/vue-js/static-verification-and-format.md b/documents/contents/guidebooks/how-to-develop/vue-js/static-verification-and-format.md index 07a890053..78c8e3f1e 100644 --- a/documents/contents/guidebooks/how-to-develop/vue-js/static-verification-and-format.md +++ b/documents/contents/guidebooks/how-to-develop/vue-js/static-verification-and-format.md @@ -1,6 +1,6 @@ --- title: Vue.js 開発手順 -description: Vue.js を用いたクライアントサイドアプリケーションの開発手順を説明します。 +description: Vue.js を用いた クライアントサイドアプリケーションの 開発手順を説明します。 --- diff --git a/documents/contents/guidebooks/migration/dotnetfw-risk/dotnet-runtime-trends.md b/documents/contents/guidebooks/migration/dotnetfw-risk/dotnet-runtime-trends.md index 97543d2b7..20b239e54 100644 --- a/documents/contents/guidebooks/migration/dotnetfw-risk/dotnet-runtime-trends.md +++ b/documents/contents/guidebooks/migration/dotnetfw-risk/dotnet-runtime-trends.md @@ -1,6 +1,6 @@ --- -title: .NET Fw のリスク -description: .NET Framework にとどまり続けることで起こりうるリスクについて説明します。 +title: .NET Framework のリスク +description: .NET Framework にとどまり続けることで起こりうる リスクについて説明します。 --- # .NET ランタイムの最新動向 {#top} diff --git a/documents/contents/guidebooks/migration/dotnetfw-risk/index.md b/documents/contents/guidebooks/migration/dotnetfw-risk/index.md index 492ec1588..eb8896199 100644 --- a/documents/contents/guidebooks/migration/dotnetfw-risk/index.md +++ b/documents/contents/guidebooks/migration/dotnetfw-risk/index.md @@ -1,6 +1,6 @@ --- -title: .NET Fw のリスク -description: .NET Framework にとどまり続けることで起こりうるリスクについて説明します。 +title: .NET Framework のリスク +description: .NET Framework にとどまり続けることで起こりうる リスクについて説明します。 --- # .NET Framework にとどまることのリスク {#top} diff --git a/documents/contents/guidebooks/migration/dotnetfw-risk/migration-to-dotnet.md b/documents/contents/guidebooks/migration/dotnetfw-risk/migration-to-dotnet.md index ef89eade6..2751acb99 100644 --- a/documents/contents/guidebooks/migration/dotnetfw-risk/migration-to-dotnet.md +++ b/documents/contents/guidebooks/migration/dotnetfw-risk/migration-to-dotnet.md @@ -1,6 +1,6 @@ --- -title: .NET Fw のリスク -description: .NET Framework にとどまり続けることで起こりうるリスクについて説明します。 +title: .NET Framework のリスク +description: .NET Framework にとどまり続けることで起こりうる リスクについて説明します。 --- # .NET への移行 {#top} diff --git a/documents/contents/guidebooks/migration/dotnetfw-risk/risk-of-dotnet-framework.md b/documents/contents/guidebooks/migration/dotnetfw-risk/risk-of-dotnet-framework.md index aa2929951..d16e2117d 100644 --- a/documents/contents/guidebooks/migration/dotnetfw-risk/risk-of-dotnet-framework.md +++ b/documents/contents/guidebooks/migration/dotnetfw-risk/risk-of-dotnet-framework.md @@ -1,6 +1,6 @@ --- -title: .NET Fw のリスク -description: .NET Framework にとどまり続けることで起こりうるリスクについて説明します。 +title: .NET Framework のリスク +description: .NET Framework にとどまり続けることで起こりうる リスクについて説明します。 --- # .NET Framework の開発停止によるリスク {#top} diff --git a/documents/contents/index.md b/documents/contents/index.md index 8d14647e0..78f6f4b16 100644 --- a/documents/contents/index.md +++ b/documents/contents/index.md @@ -1,5 +1,5 @@ --- -title: AlesInfiny Maris OSS Edition にようこそ +title: AlesInfiny Maris OSS Edition に ようこそ description: AlesInfiny Maris OSS Edition の概要を説明します。 hide: - navigation diff --git a/documents/contents/samples/azure-ad-b2c/index.md b/documents/contents/samples/azure-ad-b2c/index.md index fb6b66c52..191450bcc 100644 --- a/documents/contents/samples/azure-ad-b2c/index.md +++ b/documents/contents/samples/azure-ad-b2c/index.md @@ -1,6 +1,6 @@ --- -title: Azure AD B2C を利用してユーザーを認証する -description: Azure AD B2C による認証を利用するためのサンプルと、その使い方を解説します。 +title: Azure AD B2C を利用して ユーザーを認証する +description: Azure AD B2C による認証を利用するためのサンプルと、 その使い方を解説します。 --- # Azure AD B2C による認証を利用する {#top} diff --git a/documents/contents/samples/console-app-with-di/index.md b/documents/contents/samples/console-app-with-di/index.md index baf9c5d18..03e60407b 100644 --- a/documents/contents/samples/console-app-with-di/index.md +++ b/documents/contents/samples/console-app-with-di/index.md @@ -1,5 +1,5 @@ --- -title: コンソールアプリでの DI +title: コンソールアプリ での DI description: コンソールアプリケーションで DI を利用するためのサンプルと、その使い方を解説します。 --- diff --git a/documents/contents/samples/index.md b/documents/contents/samples/index.md index 6065f1bc3..fdc173fe9 100644 --- a/documents/contents/samples/index.md +++ b/documents/contents/samples/index.md @@ -1,6 +1,6 @@ --- title: サンプル解説 -description: AlesInfiny Maris OSS Edition の提供するサンプルの解説ドキュメント集。 +description: AlesInfiny Maris OSS Edition の提供するサンプルの 解説ドキュメント集。 --- # サンプル解説 {#top} diff --git a/documents/includes/abbreviations.md b/documents/includes/abbreviations.md index 8adf0f6a0..16d1169ac 100644 --- a/documents/includes/abbreviations.md +++ b/documents/includes/abbreviations.md @@ -1,4 +1,4 @@ - + *[ALM]: Application Lifecycle Management：アプリケーションの構築からサービス終了まで、そのライフサイクルを管理するツールやプロセス。 diff --git a/documents/mkdocs.yml b/documents/mkdocs.yml index 8de3a8a9a..c98f90016 100644 --- a/documents/mkdocs.yml +++ b/documents/mkdocs.yml @@ -178,3 +178,9 @@ extra: extra_css: - stylesheets/overrides.css + +plugins: + - social: + enabled: !ENV [BUILD_DOCUMENTS, false] + cards_layout_options: + font_family: Noto Sans JP diff --git a/documents/readme-images/social-card-example-error.png b/documents/readme-images/social-card-example-error.png new file mode 100644 index 000000000..5fe85422e Binary files /dev/null and b/documents/readme-images/social-card-example-error.png differ diff --git a/documents/readme-images/social-card-example.png b/documents/readme-images/social-card-example.png new file mode 100644 index 000000000..0b6624857 Binary files /dev/null and b/documents/readme-images/social-card-example.png differ diff --git a/package.json b/package.json index 8bd99af87..5b392e898 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "scripts": { "lint": "run-s lint:* --continue-on-error --print-label", - "lint:markdownlint-all": "npx markdownlint --config .markdownlint.yaml --ignore **/node_modules/** .", + "lint:markdownlint-all": "npx markdownlint --config .markdownlint.yaml --rules custom-lint-rules --ignore **/node_modules/** .", "lint:textlint-all": "npx textlint documents samples" }, "devDependencies": { diff --git a/samples/AzureADB2CAuth/README.md b/samples/AzureADB2CAuth/README.md index 52419a27d..f6711ed32 100644 --- a/samples/AzureADB2CAuth/README.md +++ b/samples/AzureADB2CAuth/README.md @@ -1,5 +1,5 @@ - + # Azure AD B2C による認証サンプル diff --git a/samples/ConsoleAppWithDI/solution/README.md b/samples/ConsoleAppWithDI/solution/README.md index ac5476581..44d804464 100644 --- a/samples/ConsoleAppWithDI/solution/README.md +++ b/samples/ConsoleAppWithDI/solution/README.md @@ -1,5 +1,5 @@ - + # コンソールアプリケーションサンプル diff --git a/samples/Dressca/dressca-frontend/README.md b/samples/Dressca/dressca-frontend/README.md index e7e44ef8e..d7ff2fb66 100644 --- a/samples/Dressca/dressca-frontend/README.md +++ b/samples/Dressca/dressca-frontend/README.md @@ -1,4 +1,5 @@ + # dressca-frontend diff --git a/samples/monorepo-frontend/README.md b/samples/monorepo-frontend/README.md index 07742e71b..618c60469 100644 --- a/samples/monorepo-frontend/README.md +++ b/samples/monorepo-frontend/README.md @@ -1,4 +1,6 @@ + + # monorepo Vite & Vue Monorepo with npm Workspaces