Markdown 拡張

対応状況: 標準。 VitePress は Markdown を拡張し、情報の種類、コードの差分、タブ、数式を読みやすく表現できます。

NOTE

VitePress の GitHub スタイル Alert は短い補足に使えます。

TIP

手順の要点には TIP を使います。

IMPORTANT

base を含む URL でプレビューすることが重要です。

WARNING

Markdown の脚注 [^1] は VitePress の標準拡張ではありません。このサンプルでは markdown-it-footnote プラグインを追加して有効化しています。

CAUTION

未検証の HTML や Vue テンプレートをそのまま入力しないでください。

Shiki とコード注釈

const locale = 'ja'
console.info(`現在のロケール: ${locale}`)

const oldPath = '/en/'
const currentPath = '/ja/'

locale.ts

export const locale = 'ja-JP'

LocaleLabel.vue

<template><span>日本語</span></template>

カスタムコンテナー

tip、info、warning、danger、details のコンテナーは、長めの補足を構造化する VitePress の記法です。

MathJax

インライン数式は $E=m{c}^2$、ブロック数式は次のように記述できます。

$$\sum _{i=1}^{n}i=\frac{n(n+1)}{2}$$

脚注はこの構成では markdown-it-footnote プラグインで有効化しています。これは VitePress の標準機能ではありません。数式は設定済みの MathJax によるもので、脚注とは別の追加機能として判断してください。