GitHubは Markdownという方言を使用しています GitHub 味付けされた Markdown (GFM). It’s mostly standard Markdown with a few extras — fenced code blocks with syntax highlighting, task lists, tables, and automatic link detection. If you’re converting a Word document into a GitHub README or wiki page, here’s what you need to know.
香味のP_BMarkdownとは何か?
GFMは GitHubの延長である. Wordから変換する際に最も重要な追加は,
- 囲まれたコードブロック 言語識別子 (
```python) - テーブル パイプ構文を使用する
- タスクリスト using
- [ ]and- [x] - ストライクスルー using
~~text~~ - オートリンク 裸のURLがクリック可能になる
Word ドキュメントを Word で変換する WordToMD そして GFM対応の出力をデフォルトで取得します
Wordスタイル → GFM要素
| Word要素 | GFM 出力 |
|---|---|
| 第1号目 | # H1 |
| 第2号目 | ## H2 |
| 勇気ある | **bold** |
| イタリック | *italic* |
| テーブル | パイプテーブル |
| ターゲットのリスト | - item |
| 番号付きリスト | 1. item |
| ハイパーリンク | [text](url) |
| モノスペースフォント | `code` |
| ストライクスルー | ~~text~~ |
GitHub-変換後に追加する特定の機能
課題リスト
Wordには,ネイティブタスクリスト要素はありません. チェックボックスを設定すると 文字に変換されます. 変換後に GFM タスクリストとしてフォーマットします.
- [x] Completed item
- [ ] Pending item
- [ ] Another pending itemこれらは GitHub Issues,Pull Requests,および project README ファイルでインタラクティブなチェックボックスとして表示されます.
シンタクスのハイライト付きのフェンスのコードブロック
Wordから単空テキストがインラインコードに変換されます. GitHub の多行コードブロックでは,言語識別子を持つフェンスの構文を使用します.
```javascript
function greet(name) {
return `Hello, ${name}!`;
}
GitHub supports dozens of languages. See [Markdown Code Blocks Guide](/blog/markdown-code-blocks-guide) for the full language list and syntax rules.
### Alerts (GitHub-Specific Callouts)
GitHub renders special blockquote syntax as colored callout boxes:
```markdown
> [!NOTE]
> This is a note callout.
> [!WARNING]
> This is a warning.
> [!TIP]
> This is a helpful tip.Word ドキュメントにカールアウト ボックスやハイライトされたノートがある場合は,最初の変換後にこれを GFM 警報構文に変換します.
Word ドキュメントから README を構成する
典型的なソフトウェア README は,次の構造に従います:
# Project Name
Short description.
## Installation
## Usage
## Configuration
## Contributing
## Licenseもし Word ドキュメントがプロジェクトスペックやドキュメントの草案であるなら,そのセクションを README ヘッダにマップします. 使用する WordToMD 原材料を変換し,再編成して GitHub 特定の要素を追加します.
テーブルは GitHub Markdown
Word テーブルを直接 GFM パイプテーブルに変換します 変換されたテーブルはこうなります.
| Feature | Status | Notes |
|---|---|---|
| Authentication | ✅ Done | JWT-based |
| File upload | 🚧 In progress | S3 target |
| API docs | ❌ Pending | — |GitHub は列の並行もサポートします:
| Left | Center | Right |
|:---|:---:|---:|
| text | text | text |マークダウンの表については, Markdown 表: 完全なガイド.
GitHub リポジトリ内の画像
GitHubは,レポ内の相対パスの画像を表示する:
Word ドキュメントにサポートされている画像が含まれている場合は, Markdown +画像 ZIP画像ファイルに移動します. docs/images/異なるフォルダー構造を使用している場合は,相対的なパスを更新します.
GitHub.comでホストされている画像では,絶対的なURLも使用できます.
GitHub ウィキページ
GitHubウィキは全 GFMスペックをサポートしています. 変換ワークフローは,READMEと同じです.
- Word ドキュメントを変換する WordToMD
- GFM 特定のフォーマットを追加する (タスクリスト,コードフェンス,アラート)
- 新しいウィキページを作成して Markdown を貼る
タイトルIDとアンカーリンク
GitHubはヘッドテキストからアンカーIDを自動生成します タイトル ## Installation ID を取得する #installation. You can link to it from elsewhere in the same document:
See the [Installation section](#installation) below.これは,コンテンツ表を備えた長い README に役立ちます. 変換後,トップにTOCを追加します.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)FAQ
GitHub は Markdown で HTML を表示する? GitHubでは HTMLタグがいくつか使用可能だが,ほとんどのスタイリング属性を削除する. 最適な結果のために Markdown 構文にこだわる.
私の机には列が多くて,モバイルでは狭く見える. どうしたらいいの?
HTML を使用する. <details> 折りたたみ可能な部分の標識
Word を使って GitHub 問題を書くことはできますか? わかった! Word doc を Markdown に変換する WordToMD そして出力を直接 GitHub 問題または Pull Request の記述に貼り付けます
Word 文書セットを GitHub ウィキに変換するには? 各 Word ファイルを個別に変換し,ドキュメントごとに1つのウィキページを作成します. 参照 バッチ変換 Word に Markdown 脚本を書いたことに感謝します.
結論
Word に変換する GitHub マークダウン 単純に 使用 WordToMD ベース Markdown を取得するには,タスクリスト,コードフェンス,コールアウトアラートなどの GFM 特定の機能にレイヤーを付けます. Word 文書のきれいな構造 (内蔵タイトルスタイル,適切なテーブル) 変換出力は GitHub に押し付けられるようになるでしょう.