markdown共有ツール

Markdown表示サンプル集

markdown共有ツールの本番表示と同じ描画処理を使った、運営作成の固定サンプルです。ユーザー文書や最近の投稿は掲載していません。公開前に対応記法と見え方を確認し、原文をコピーして自分の文書作成にも利用できます。

1. 表・タスクリスト・コード

GitHub Flavored Markdownのタスクリスト、表、ファイル名付きのコードブロックを含む基本例です。コードはファイル名の帯のボタンでコピーできます。横幅が狭い画面では表とコードを横スクロールできます。

dev-setup.md

開発環境の準備#

新しく参加した人向けに、開発を始めるまでの手順をまとめました。上から順に進めれば、30分ほどで終わります。

準備の進み具合#

  • リポジトリへの招待を受け取る
  • エディターを入れる
  • 手元でアプリを起動する

使うツールと、動作を確かめたバージョンは次のとおりです。

ツールバージョン使いみち
Node.js22アプリの実行
Git2.45 以上変更の記録

アプリの起動#

依存関係を入れてから、開発用のサーバーを起動します。表示されたURLをブラウザで開けば完了です。

setup.sh
npm install
npm run dev

2. Mermaidフローチャート

mermaid指定のコードブロックを図として表示します。構文エラーがある場合は、公開前のプレビューで確認できます。

support-flow.md

問い合わせ対応の流れ#

問い合わせを受けたら、まずその場で答えられるかを確かめます。すぐに答えられないものは担当者が調べ、その日のうちに返事をします。

図を描画しています…

回答した内容は、よくある質問に追記して次の対応に生かします。

3. インライン数式・ブロック数式

ドル記号で囲んだ数式をKaTeXで表示します。短い式は文中に、長い式は独立したブロックとして配置できます。

statistics-notes.md

標準偏差のメモ#

テストの点数がどれくらい散らばっているかは、標準偏差で表せます。nn 人の点数を x1,x2,…,xnx_1, x_2, \dots, x_n、平均を xˉ\bar{x} とすると、標準偏差 σ\sigma は次の式で求めます。

σ=1n∑i=1n(xi−xˉ)2\sigma = \sqrt{\frac{1}{n} \sum_{i=1}^{n} (x_i - \bar{x})^2}

値が小さいほど、点数が平均の近くに集まっていることを表します。

4. 注記・折りたたみ

GitHub・Obsidianの注記と、HackMD・Zenn・Qiita・Docusaurusの ::: の枠・折りたたみを表示します。書き出したMarkdownも、そのまま貼り付けて共有できます。

study-session.md

社内勉強会のお知らせ#

11月の勉強会では、Markdownで手順書を書くコツを紹介します。参加は自由で、資料はこのページで共有します。

Note

当日の録画は、終了後にこのページへ追記します。

Warning

社外の方を招く場合は、事前に担当者へ知らせてください。

持ち物

ノートPCがあると、その場で手を動かしながら試せます。

初めてでも参加できますか?

はい。見出しと箇条書きの書き方から説明します。

前回の勉強会の資料は、すべて公開しました。

会場の席には限りがあります。オンラインでも参加できます。

当日の進行
  1. Markdownの基本(15分)
  2. 手順書を書いてみる(30分)
  3. 質問の時間(15分)

5. Obsidianの記法

プロパティの内部リンクとタグ、同じ文書の見出しへの [[#見出し|表示名]]、==ハイライト==、引用の最後の「――発言者」を表示します。別のノートへのリンクは、開けない目印付きの文字になります。

writing-workshop.md
プロパティ2件
tags
#文章講座#ふりかえり
source
講座の文字起こし

文章講座のふりかえり#

読みたいところから: 要点 / 次に試すこと / 文章術のメモ

講座の要点#

わかりやすい文章は、一文に一つのことだけを書く ところから始まる、というのが講座の中心でした。長い文を短く区切るだけで、読み手の負担はかなり減ります。

文章は、読む人の時間を借りて書くものです。

――講師の言葉

次に試すこと#

  • 一文を60字以内に収める
  • 結論を最初の段落に書く

6. デザインのテンプレート

公開前に、7種類のテンプレートから共有ページのデザインを選べます。下のテンプレートを選ぶと、同じMarkdownの見た目がその場で切り替わります。

デザインのテンプレート

選ぶと下のプレビューがその見た目に変わります。文字の書体・見出し・表・注記の形ごと切り替わります。

読みやすい手順書の書き方#

手順書は、急いでいる人が途中から読むことの多い文書です。最初に結論を書き、一つの手順には一つの操作だけ を書くと、読み手が迷いにくくなります。

書き方による違い#

書き方読み手の受け取り方
手順を文章でつなげるどこまで進んだか分からなくなる
番号付きの箇条書きにする今どこにいるかが一目で分かる
迷ったら声に出して読む

声に出して詰まるところは、読み手も同じところで止まります。

次に書くときの順番#

  1. 目的を一文で書く
  2. 手順を番号付きの箇条書きにする
  3. 終わったときの状態を最後に書く
template.md
## 目的
この手順で何ができるようになるかを一文で書く。

自分のMarkdownで試す

  1. 近いサンプルの原文をコピーします。
  2. アップロード画面へ貼り付け、自分の内容へ書き換えます。
  3. プレビューで見出し、表、コード、図、数式を確認し、デザインのテンプレートを選びます。
  4. 必要に応じて期限とパスワードを設定し、共有URLを作成します。

Mermaidと数式の詳しい書き方はMermaidと数式をMarkdownで共有する方法、対応形式と上限はヘルプ / FAQを参照してください。

サンプルを使って共有ページを作る

最終確認日: / 作成・確認: markdown共有ツール運営