ヘルプ / FAQ
markdown共有ツールの使い方と、共有前に確認しておきたい点をまとめています。
サービスについて
markdown共有ツールとは何ですか？
Markdownファイルや貼り付けた本文と画像から、ブラウザで読める共有ページを作るサービスです。 読む人はMarkdownビューアを用意する必要はありません。
アカウントは必要ですか？
共有URLの作成と閲覧にアカウントは必要ありません。パスワード付きの共有では、共有者から受け取ったパスワードが必要です。Googleでログインすると、それまでにこのブラウザで作成した共有もアカウントにまとめ、別の端末からも一覧・削除できます。
共有ガイド
基本の手順はMarkdownファイルをURLで共有する方法、画像フォルダを含む場合は画像付きMarkdownをZIPで共有する方法を確認してください。ガイドの一覧はMarkdown共有ガイドにまとめています。
アップロード
共有までの流れを教えてください。
Markdownファイルを追加するか本文を貼り付け、必要に応じて画像も追加します。 内容を確認したあと、表示期限やパスワードの有無を設定して共有URLを作成します。
どんなファイルをアップロードできますか？
Markdown、JPEG、PNG、WebP、GIF、ZIPに対応します。ZIPは、Markdownと画像をまとめてアップロードしたい場合に使えます。
ファイルを用意せず本文を貼り付けられますか？
できます。アップロード画面の入力欄へ、Markdown本文を直接書くか貼り付けてください。入力欄は見出しや表、図、数式などを書きながら公開後に近い見た目で表示し、「プレビュー」に切り替えると公開後と同じ表示を確かめられます。本文は公開前まで編集できます。
1日に作れる共有の数に上限はありますか？
あります。同じ回線（IPアドレス）から1日に追加できる共有は10件まで、送れる画像の合計は20MBまでで、日本時間の0時に戻ります。公開APIでの作成も合わせて数えます。会社や学校など、同じ回線を複数人で使っている場合は、ほかの人の追加も合わせて数えます。8件目からは、アップロード画面と公開後の画面に、今日あと何件追加できるかを表示します。
API
プログラムやCLIから共有URLを作れますか？
できます。公開APIへMarkdown本文を送信すると、完成した共有URLをJSONで受け取れます。curlの例、設定項目、エラー仕様はAPIドキュメントを確認してください。
画像
画像が足りない場合はどうなりますか？
共有ページ内では、見つからない画像の位置に欠落表示が出ます。Markdown本文や他の画像はそのまま共有できます。
Mermaidや数式は表示できますか？
```mermaid のコードブロックは図として表示し、$...$ や$$...$$ で書いた数式はKaTeXで表示します。描画に失敗した場合はコードブロックとして表示します。
GitHubやObsidian、HackMDの注記は表示できますか？
できます。1行目が > [!NOTE]、[!TIP]、[!IMPORTANT]、[!WARNING]、[!CAUTION] の引用を、種類ごとの色とアイコンの注記として表示します。 Obsidianの [!abstract]、[!info]、[!todo]、[!success]、[!question]、[!failure]、[!danger]、[!bug]、[!example]、[!quote] と別名にも対応し、> [!note] 見出しのように目印の後ろに書いた文字は注記の見出しになります。[!faq]- のように -を付けると閉じた状態、+ を付けると開いた状態の折りたたみになります。
::: で囲む枠は、HackMDの :::info、:::success、:::warning、:::danger、Zennの :::message（alert で赤）、Qiitaの:::note info・warn・alert、Docusaurus・VitePressの:::tip 見出し などを色付きの枠、:::spoiler と :::detailsを折りたたみとして表示します。目次の位置を示す [TOC]は、閲覧画面の目次メニューで見出しをたどれるため、本文からは取り除きます。
Obsidianの内部リンクやハイライトは表示できますか？
できます。[[#見出し|表示名]] のような同じ文書の見出しへのリンクは、ページ内の見出しへ移動するリンクになります。 別のノートへのリンク（[[ノート名]]）は共有に含まれず開けないため、リンクと見分けられる目印付きの文字で表示します。 画像の埋め込み ![[画像.png]] は、一緒に追加した画像の中から同じファイル名の画像を探して表示し、![[画像.png|300]] で表示の幅を指定できます。画像へのリンク（[[画像.png]]や [説明](images/画像.png)）は、一緒に追加した画像をページを移らずに拡大表示で開きます。==文字== はマーカーを引いたハイライトになります。
画像の説明文やコードのファイル名は表示できますか？
できます。段落に1枚だけの画像は中央に置き、直後の斜体だけの段落（*図1｜説明*）か、画像の title（）を説明文として画像の下に添えます。 コードブロックは ```ts:app.ts（Qiita・Zenn）や ```ts title="app.ts"のファイル名、または言語名を見出しの帯に表示し、コピーのボタンを付けます。引用の最後の――発言者 のようなダッシュで始まる行は、引用元として右寄せで表示します。
スライドとして表示できますか？
できます。先頭のfrontmatterに type: slide を書くと、HackMDと同じく ---だけの行（縦方向の ---- も含む）でスライドに分け、1枚ずつ表示します。矢印キーやスワイプで送れ、対応するブラウザでは全画面表示もできます。 「文書として表示」を押すと、通常の文書表示に切り替えられます。
共有と期限
共有ページのデザインは選べますか？
公開前プレビューのすぐ上で、7種類のデザインのテンプレートから選べます。色だけでなく、書体・見出し・表・注記の形ごと切り替わります。
- スタンダード: GitHubに近い標準の見た目（既定）
- ビジネス: 紺の帯の見出しと濃い見出し行の表。報告書・提案書向け
- マガジン: 明朝体の両端揃えと、細い罫で区切る見出し。読み物向け
- 論文: 見出しへの章番号の自動付与、段落の1字下げ、横罫だけの表
- テクニカル: 見出しの
##記号と暗いコード枠。技術文書向け - ノート: 罫の少ない軽い紙面と、淡い色の注記。メモや議事録向け
- ポップ: 太い見出しと黄色の帯、番号の目立つ手順。告知・研修資料向け
どのテンプレートも、端末のダークモードとスマホの画面幅に合わせて表示します。公開APIでは themeで指定できます（APIドキュメント）。表示サンプルで、それぞれの見た目を確かめられます。
表示期限は選べますか？
無期限、3日、7日、30日、60日、100日から選択できます。デフォルトは無期限です。 無期限は閲覧期限を設けない設定ですが、永久保存を保証するものではありません。
期限が切れるとどうなりますか？
期限を設定した共有では、本文、画像、ダウンロード、共有プレビューを表示できなくなります。期限切れ後の物理削除は定期処理で行いますが、 閲覧は期限判定で停止します。
作成した共有を削除できますか？
できます。作成した共有から、このブラウザで作成した共有を一覧・削除できます。削除した共有は閲覧できなくなり、元に戻せません。 一覧と削除に必要な情報は作成したブラウザに保存されるため、別の端末や、ブラウザのデータを消去した後は削除できません。Googleでログインすると、このブラウザで作成した共有もアカウントにまとめられ、同じアカウントでログインすれば別の端末からも一覧・削除できます。共用のパソコンでは、そのブラウザで他の人が作成した共有もまとめられるため、ログインは自分の端末で行ってください。APIで作成した共有は一覧に表示されませんが、作成時に返る削除用トークンを使ってAPIから削除できます（APIドキュメント）。
QRコードで共有できますか？
共有URLの作成後にQRコードを表示できます。対面、紙、スライドなどで配布したい場合に使えます。
安全性
パスワードを設定できますか？
できます。パスワード付きの共有では、本文、画像、ダウンロードが保護されます。 ただし、パスワード保護は閲覧制御であり、エンドツーエンド暗号化ではありません。 通報への対応など運用上必要な場合は、運営者が内容を確認することがあります。
公開後に本文を編集できますか？
できます。作成した共有に表示される共有は、「編集」から同じURLのまま本文を更新できます。 更新すると共有ページに「更新・変更履歴」のリンクが付き、共有URLを知っている人は誰でも更新前の本文と変更前後の差分を見られます。 消したい内容を含む場合は、更新ではなく削除してください。期限延長やパスワードの変更、画像の追加はできません。APIで作成した共有は更新できません。
どんな用途には向きませんか？
個人情報、秘密情報、契約書、認証情報、アクセスキー、長期保管が必要なファイル、大容量ファイルの共有には向きません。
削除依頼・問題報告
問題のある共有を見つけた場合はどうすればよいですか？
削除依頼・問題報告から連絡してください。権利侵害、個人情報、フィッシング、マルウェア、危険なリンクなどが疑われる場合は、 内容を確認し、必要に応じて停止または削除します。