Typemark Documentation

主要な概念

Typemarkの基本要素を理解しましょう:プロジェクト、ページ、typemark.json、リポジトリモード、公開、ロール。

2026年11月19日更新

プロジェクト

プロジェクトとは、1つのドキュメントサイトのことです。各プロジェクトには次のものが含まれます。

  • Gitリポジトリ。Typemarkでホストするか、GitHubと同期します
  • {slug}.typemark.devというアドレス。独自ドメインを追加することもできます
  • ページ。typemark.jsonのナビゲーションに従って整理されます
  • 専用のチーム。メンバーごとにロールがあります

ダッシュボードのサイドバー上部にあるプロジェクトメニューから、プロジェクトを切り替えられます。各プロジェクトは概要画面から始まります。この画面には、ドキュメント全体に対する変更をAIに依頼するためのボックス、対応が必要な項目(読者が回答を見つけられなかった質問、失敗した公開、ビルドの警告)、公開履歴、サイトのアドレスと設定、そしてAIツールがドキュメントを読むためのURLが表示されます。ProプランとEnterpriseプランでは、概要に加えて、過去7日間にドキュメントを読んだ人数、ページから回答されたAskAIの質問数、閲覧数の多いページも表示されます。

ページ

ページとは、プロジェクトのリポジトリにある.mdxファイルのことです。ファイルのパスがそのままURLになります。

ファイルURL
introduction.mdx/introduction
guides/authentication.mdx/guides/authentication
api-reference/users.mdx/api-reference/users

複数の言語を使用するサイトでは、各翻訳を言語コードと同名のフォルダに置きます。fr/introduction.mdxはintroduction.mdxのフランス語版であり、URLは/fr/introductionになります。

各ページはフロントマターで始まります。フロントマターとは、ファイルの先頭にあるYAML形式のメタデータです。

---
title: "Authentication"
description: "How to authenticate API requests."
icon: "lock-closed"
---

本文はMDXで記述します。MDXはMarkdownに<Callout>、<Tabs>、<Card>などのコンポーネントを組み合わせたものです。ビジュアルエディタでは、ページ上部のタイトルと説明を直接編集できます。その他のフロントマターのフィールドはソースモードで編集します。

typemark.json

すべてのプロジェクトには、リポジトリのルートにtypemark.jsonファイルがあります。このファイルでは次の内容を制御します。

  • ナビゲーション:サイドバーの構造(タブ、グループ、ページの順序)
  • ブランディング:メインカラー、ロゴ
  • 機能:検索、テーマ切り替え、目次など
{
  "name": "Acme Docs",
  "colors": { "primary": "#3b82f6" },
  "navigation": {
    "tabs": [
      {
        "tab": "Documentation",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["introduction", "quickstart"]
          }
        ]
      }
    ]
  },
  "features": {
    "search": true,
    "table_of_contents": true,
    "copy_code_button": true
  }
}

手動で編集する必要はほとんどありません。エディタのサイドバーでページの順序を変更したり、設定を変更したりすると、自動的に更新されます。完全なリファレンスはtypemark.jsonを参照してください。

リポジトリモード

プロジェクトの概要画面には、コンテンツの保存場所がソースの下に表示されます。

Typemarkでホスト(デフォルト)

リポジトリはTypemarkがホストします。Webエディタで編集でき、GitHubアカウントは必要ありません。

  • プロジェクト作成時に自動で設定されます
  • 保存のたびにGitのコミットが作成されるため、履歴は常に残ります

GitHub

プロジェクトはGitHubリポジトリと双方向に同期されます。

  • GitHubにプッシュすると、Typemarkが変更を取り込み、再ビルドします
  • Typemarkで保存すると、変更はGitHubにプッシュされます
  • Webエディタ、ローカルエディタ、またはその両方を使用できます

サイトのステータスと公開モード

各プロジェクトには、公開に関する2つの設定があります。

  • サイトのステータス(公開中またはオフライン):アドレスでドキュメントを表示するか、「近日公開」ページを表示するかを決めます。新規プロジェクトは、コンテンツを準備できるようオフラインで始まります。
  • 公開モード(自動公開または手動公開):保存内容をすぐに公開するか、公開をクリックするまで待つかを決めます。デフォルトは自動公開です。

どちらも設定 > 公開にあります。詳細は公開を参照してください。

ロール

プロジェクトのメンバーにはすべてロールがあります。オーナー、エディター、閲覧者のいずれかです。エディターはページを作成・整理できます。閲覧者は閲覧のみ可能で、何も変更できません。設定、公開、チームの管理はオーナーだけが行えます。詳細はチームメンバーを参照してください。

プランの機能はプロジェクトのオーナーのプランに従います。オーナーがProまたはEnterpriseプランの場合、プロジェクトの全メンバーがそのプランの機能を利用できます。

ビルド

エディタからでもGitHubへのプッシュからでも、コンテンツが変更されると、Typemarkは次の処理を行います。

  1. ナビゲーションと設定をtypemark.jsonから読み込みます
  2. ページをMDXからHTMLにコンパイルします
  3. コードブロックにシンタックスハイライトを適用します
  4. 検索インデックスを更新します

保存はすぐに完了し、ページはバックグラウンドでビルドされます。ビルド中はエディタにビルド中と表示され、問題が発生するとビルド失敗と表示されます。最近の公開履歴は、プロジェクトの概要画面に一覧表示されます。