組み込み機能#

Copy as MarkdownView Markdown

Ox Content は、よく使うドキュメントの挙動を既定で載せ、非標準の Markdown や HTML 拡張はオプトインにします。

下の既定は @ox-content/vite-plugin と一致します。速い静的ベースライン向けです。パース、静的埋め込み、ソース docs、検索インデックスは変換時またはビルド時に走り、追加構文と実行時挙動は明示的にオンにします。

false または省略はオフ、true は既定でオン、オブジェクトはオンにしたうえで指定したフィールドだけ上書きします。

このドキュメントサイト自体が Ox Content でできています。下の機能ガイドは説明するだけでなく、機能をオンにして 実例をインラインで描画します。日本語ガイドは英語と同じ情報を載せます。

機能ガイド#

既定とオプトイン#

タブと YouTube 埋め込みにオプションはありません。SSG と dev preview では常に処理されます。埋め込み を見てください。

設定例#

import { defineConfig } from "vite-plus";
import { oxContent } from "@ox-content/vite-plugin";

export default defineConfig({
  plugins: [
    oxContent({
      highlight: true,
      emojiShortcodes: true,
      codeAnnotations: {
        notation: "both",
      },
      embeds: {
        pm: { sync: true },
        twitter: { fetch: true },
        bluesky: true,
      },
    }),
  ],
});

どのオプションも同じ約束です。false は機能を切り、true は既定でオン、オブジェクトはオンにしたうえで指定したフィールドだけ上書きします。

コピーできる執筆例はリポジトリの examples/builtin-features/content/ にあります。事例 のページは、いくつかの機能を実行可能なプロジェクトで見せます。