ドキュメントのガイドライン

347字程度約1分

ヒント

このドキュメントの目的は、ドキュメント作成者がテーマが提供する機能をより良く活用し、読みやすさを向上させることを指導することです。

私たちのドキュメントは vuepress に基づいて構築されており、vuepress-theme-plume テーマが使用されています。詳細な説明については公式ドキュメントをご覧いただけます。ここでは一部の一般的な機能について紹介します。

ローカルデプロイ

~~Dockerのコンテナではありません~~

このテーマでは、ヒント、ノート、情報、注意、警告、詳細などのカスタムコンテナをサポートしており、これらの機能を利用して特定のコンテンツを強調することができます。

コンテナの使用方法：

::: [コンテナの種類] [コンテナのタイトル（オプション）]
書きたい内容
:::

受け入れられるコンテナの内容とデフォルトのタイトルは次のとおりです：

ヒント

これはヒントのコンテナです

注

これはノートのコンテナです

このテーマではアイコンがサポートされており、次の場所でアイコンを使用できます:

ドキュメントの frontmatter で、icon を使用してドキュメントのアイコンを設定できます。

このアイコンはドキュメントのタイトルの隣に表示されます。

このドキュメントの frontmatter 設定

---
icon: jam:write-f
---

Markdown 内で <HopeIcon /> コンポーネントを使用してアイコンを追加できます。このコンポーネントには以下の属性があります：

例

<HopeIcon icon="ic:round-home" color="#1f1e33"/>

<HopeIcon icon="/images/maa-logo_512x512.png" size="4rem" />

このドキュメントで使用されているアイコンは iconify から取得されており、お好みのアイコンを検索するには、提供されているアイコン検索画面で検索し、そのキーワードをコピーしてください。

Frontmatter は Markdown ドキュメントの先頭に --- で囲まれたセクションであり、内部では YAML 構文が使用されます。Frontmatter を使用することで、文書の編集日時、使用されるアイコン、カテゴリ、タグなどを識別することができます。

サンプル

---
date: 1919-08-10
icon: jam:write-f
order: 1
---

# ドキュメントのタイトル

...

各フィールドの意味は次のとおりです：