Typemark Documentation

ブランディング

サイトのアクセントカラー、ロゴ、ファビコンを設定し、ライトモードとダークモードの動作を確認します。

2026年11月19日更新

サイトの見た目は、3つの設定で決まります。プライマリカラー、ロゴ、ファビコンです。最初の2つは Settings > Look and feel で設定し、ファビコンは typemark.json で設定します。

プライマリカラー

プライマリカラーはサイトのアクセントで、リンク、サイドバーの選択中の項目、フォーカスリング、ハイライトに使われます。Settings > Look and feel の Brand colour でスウォッチを選ぶか任意の16進数の値を入力するか、typemark.json で設定します。隣のプレビューには、保存前に新しい色を適用したサイトが表示されます。

"colors": {
  "primary": "#3b82f6"
}

値は16進数で指定してください。プライマリカラーを設定していないサイトでは #4f46e5 が使われます。

リンクなど、テキストに色を使う場合、Typemark は背景に対して少なくとも 4.5:1 のコントラストを保つよう、必要に応じて色を暗くまたは明るくします。これはライトモードとダークモードの両方で行われます。

ロゴ

ロゴはサイトヘッダーの左上に表示され、高さは 28 ピクセル、幅は最大 160 ピクセルです。どちらのテーマでも見えるように、ライトモード用とダークモード用の2つのバージョンを追加してください。

Settings > Look and feel に移動し、Logo と Logo for dark mode の下にファイルをアップロードします。PNG、JPEG、GIF、SVG、WebP が使えます。Typemark はファイルをリポジトリの images/ フォルダに保存し、typemark.json を更新します。

ファイルをリポジトリに追加してから、そのパスを指定します。パスはリポジトリのルートからの相対パスです。完全な https:// URL も使えます。

"logo": {
  "light": "/images/logo-light.svg",
  "dark": "/images/logo-dark.svg"
}
  • バージョンが1つだけ? どちらかのキーを設定すれば、Typemark は両方のテーマでそれを使います。
  • ロゴがない場合? ヘッダーには、プロジェクト名の先頭文字がプライマリカラーで表示され、その後にプロジェクト名が続きます。
  • パスが間違っている場合? 画像が読み込めないと、ヘッダーにはプロジェクト名が表示されます。

SVG はどのサイズでも鮮明です。横長のロゴがヘッダーに最も合います。

ファビコン

ブラウザのタブのアイコンは typemark.json で設定します。正方形の画像を使用してください。

"favicon": "/images/favicon.png"

ライトモードとダークモード

Typemark のサイトには、ライトテーマとダークテーマがあり、ヘッダーのトグルで切り替えられます。読者がテーマを選ぶまでは、サイトは読者のシステム設定に従います。選んだテーマはブラウザに保存されます。

ダークモードでは、ロゴは dark のファイルに切り替わり、コードブロックはダークテーマを使います。

公開準備中のページ

サイトがオフラインの間、訪問者にはロゴとプライマリカラー付きの「Documentation coming soon」ページが表示されます。公開を参照してください。

ページが見つからない

存在しないページを開いた場合(たとえば古いリンクから)、読者にはサイト独自の「That page doesn't exist」ページが表示されます。このページには、サイト名、ロゴ、ファビコン、プライマリカラー、ナビゲーション、フッター、カスタムCSSが含まれ、最初のいくつかのページとドキュメントトップへのリンクがあります。検索エンジンにはインデックスしないよう指示されています。

「Powered by Typemark」を削除する

無料のサイトでは、各ページの下部に「Powered by Typemark」という表示が出ます。Pro および Enterprise では、Settings > Reader features で Hide Typemark branding をオンにするか、features の下で "hide_branding": true を設定してください。