Skip to content

瀏覽數:0

よく使う書き方

.md ファイルのヘッダー説明

---
title: あなたのタイトル
description: このファイルの説明
aside: false | true   //右側のナビゲーション列を表示するかどうか
outline: [2, 3]       //ナビゲーション列が取得するタイトルの深さ
sidebar: false | true  //左側のサイドバーを表示するかどうか
borderless: true | false  //枠線があるかどうか
tags:
  - tag1
  - tag2
  - tag3
---

# {{ $frontmatter.title }}

まずページを作成する場合、docs フォルダの下に新しい .md ファイルを作成してください。
必要に応じて対応するフォルダに配置してください(不明な場合は /readme.md フォルダ構成説明を参照してください)。
/docs/event フォルダの外では、イベント用の英語命名に困難な場合を除き、
他のファイル名は純英数字と - で構成する必要があります。
例えば、

example-page.md

このファイル名は wiki では外部に表示されません。

  • title
    タイトルを入力します(中国語、英語、数字でもかまいません)。このタイトルは外部に表示されます。
    ランタイム API で自動的に取得され、# よく使う書き方 の位置に表示されます。

  • description
    このページの内容を説明します(外部には表示されません)。

  • tag
    記事の特徴を指定するためのものです。複数のカテゴリを設定でき、3 つ以上でも構いません。
    一般的に tag は目標が不確定なときに検索を補助するためのものなので、長すぎないことをお勧めします。

  • aside: false
    デフォルトは true です。false に設定すると、右側のタイトルナビゲーションが消えます。
    ページが十分に大きくないと感じるときに、この行を追加できます。

  • outline: [2, 3]
    右側のタイトルナビゲーションが取得するタイトル区間を決定します。
    デフォルトは 2 で、プレフィックスが ## のタイトルだけをナビゲーションに抽出します。
    この例は [2, 3] のように設定されているため、### のタイトルを ## の下に配置します。
    このページにはこのオプションが有効になっており、右側のナビゲーションを参照してください。

  • sidebar: false
    デフォルトは true です。false に設定すると、左側のサイドバーが消えます。
    ページが十分に大きくないと感じるときに、この行を追加できます。

  • borderless: true カスタマイズ
    デフォルトは false です。true に設定すると、記事の幅が無制限スタイルで表示されます。
    上記の asidesidebar と組み合わせると、コンテンツを最大限拡張できます。
    コンテンツが変わる場合、幅も動的に変わります。

💡提示

上記以外のヘッダー属性については、公式ドキュメントをご覧ください。

.md ファイルのヘッダー例

---
title: 人物列傳-唐默鈴(小師妹)
description: 小師妹の人物ストーリー、小師妹の画像、特徴、癖などを紹介します。
aside: false // 右側のナビゲーション列を閉じる
outline: [2, 3] // ナビゲーション列が閉じられているため、この行は無効です
sidebar: true // 左側のサイドバーを開く。このページにサイドバーがある場合は表示されます
borderless: true // コンテンツの幅に枠線なし(ナビゲーション列とサイドバーでブロックされます)
tags:
  - 唐門
  - 可攻略女角
  - girl0
  - 矮
  - 内向
  - 天下第一
  - 公式デフォルトヒロイン
---

# {{ $frontmatter.title }}

Markdown 記事で一般的に使用される構文

📃內容

ここにはよく使用される構文のみをリストアップしています。より多くの構文については 公式ドキュメント を参照してください。

改行

文の最後に 2 つのスペースを入力すれば、markdown の改行効果になります。
(それでもだめな場合は、HTML の改行効果を検討してください:<br>)


これは最初の行です
これは 2 番目の行です


ソースコード
markdown
これは最初の行です  
これは 2 番目の行です

ハイパーリンク


wikilink
龍湘 (リュウショウ)
内部リンク
龍湘
外部リンク
https://www.google.com


ソースコード
markdown
wikilink  
[[龍湘 (リュウショウ)]]  
内部リンク  
[龍湘](/ja/people/characters/girl8)  
外部リンク  
[https://www.google.com](https://www.google.com)

注釈:wikilink について


タイトル

タイトルには ##、###の 2 種類のみを使用し、それぞれ H2、H3 レベルのタイトルを表します。
前に空行と改行が必要で、タイトルの後に 1 スペースが必要です。そうしないと通常のテキストとみなされます。

markdown
## 二級タイトル

### 三級タイトル

テキストブロック(コピー機能付き)

テキストブロックとバッククォートは高い関連性があります。
コピー可能なテキストブロックの場合、先頭と末尾に 3 つのバッククォート(```) が付加されます。
markdown はコピー機能を明示するためのものであり、追加を推奨します。


markdown
テキストブロック(コピー機能付き)

ソースコード
markdown
<pre><code>```markdown
  テキストブロック(コピー機能付き)
```</code></pre>

インラインテキストブロック(コピー機能なし)


hello インラインテキストブロック test


ソースコード
markdown
`インラインテキストブロック`

画像


趙活の画像、フルパス龍湘アバター、相対パス


ソースコード
markdown
![趙活の画像、フルパス](https://i.imgur.com/WlPuE8U.png)
![龍湘アバター、相対パス](/images/characters/girl_8/icon_girl8.webp)

💡提示

注:ローカルの画像が docs/public の下にある場合は、相対パスを使用してください。

⚠️警告

正しい位置に画像をアップロードしたことが確認できたのに表示されない場合は、通常はパスに問題があります。
アップロード先の画像パスを提供して、正常にアップロードされたかどうかを確認してから質問してください。



ID名前
1スマイル A
2スマイル B
ソースコード

.md ファイルで HTML5 の構文を使用できます
たとえば、Markdown の表は次のようになります。

| ID | 名前  |
|----|-----|
| 1  | スマイル A |
| 2  | スマイル B |

この表を以下の HTML に置き換えることができます。

<table>
    <tr>
        <td>ID</td>
        <td>名前</td>
    </tr>
    <tr>
        <td>1</td>
        <td>スマイル A</td>
    </tr>
    <tr>
        <td>2</td>
        <td>スマイル B</td>
    </tr>
</table>

データ量が増えると、Markdown の元の表形式と比較して HTML の表形式は保守が簡単になります。

vitepress のカスタム markdown

メッセージボックス

Markdown
::: info
これはメッセージボックスです
:::

::: tip
これはヒントボックスです
:::

::: tip 名前変更
これはタイトルを変更したヒントボックスです
ここにリストされているすべてのボックスはタイトルを変更できます!
:::

::: warning
これは警告ボックスです
:::

::: danger
これは危険ボックスです
:::

::: details
これは折りたたみ可能なボックスです
:::

効果:

📃內容

これはメッセージボックスです

💡提示

これはヒントボックスです

名前変更

これはタイトルを変更したヒントボックスです
ここにリストされているすべてのボックスはタイトルを変更できます!

⚠️警告

これは警告ボックスです

☢️危險

これは危険ボックスです

📖詳細內容

これは折りたたみ可能なボックスです

外部ツール

Contributors

The avatar of contributor named as Claude Fable 5 Claude Fable 5
The avatar of contributor named as NEXTAltair NEXTAltair

Changelog