forked from drowl87/hextra_mirror
197 lines
6.1 KiB
Markdown
197 lines
6.1 KiB
Markdown
---
|
|
title: Markdown
|
|
weight: 2
|
|
---
|
|
|
|
Hugoは、テキストのフォーマットやリストの作成などに[Markdown](https://ja.wikipedia.org/wiki/Markdown)構文をサポートしています。このページでは、最も一般的なMarkdown構文の例をいくつか紹介します。
|
|
|
|
<!--more-->
|
|
|
|
## Markdownの例
|
|
|
|
### テキストのスタイル
|
|
|
|
| スタイル | 構文 | 例 | 出力 |
|
|
| -------- | -------- | ------ | ------ |
|
|
| 太字 | `**太字テキスト**` | `**太字テキスト**` | **太字テキスト** |
|
|
| 斜体 | `*斜体テキスト*` | `*斜体テキスト*` | *斜体テキスト* |
|
|
| 取り消し線 | `~~取り消し線テキスト~~` | `~~取り消し線テキスト~~` | ~~取り消し線テキスト~~ |
|
|
| 下付き文字 | `<sub></sub>` | `これは<sub>下付き文字</sub>です` | これは<sub>下付き文字</sub>です |
|
|
| 上付き文字 | `<sup></sup>` | `これは<sup>上付き文字</sup>です` | これは<sup>上付き文字</sup>です |
|
|
|
|
### ブロッククォート
|
|
|
|
引用元付きのブロッククォート
|
|
|
|
> メモリを共有してコミュニケーションするのではなく、コミュニケーションしてメモリを共有せよ。<br>
|
|
> — <cite>ロブ・パイク[^1]</cite>
|
|
|
|
[^1]: 上記の引用は、2015年11月18日のGopherfestでのロブ・パイクの[講演](https://www.youtube.com/watch?v=PAAkCSZUG1c)から抜粋したものです。
|
|
|
|
```markdown {filename=Markdown}
|
|
> メモリを共有してコミュニケーションするのではなく、コミュニケーションしてメモリを共有せよ。<br>
|
|
> — <cite>ロブ・パイク[^1]</cite>
|
|
|
|
[^1]: 上記の引用は、2015年11月18日のGopherfestでのロブ・パイクの[講演](https://www.youtube.com/watch?v=PAAkCSZUG1c)から抜粋したものです。
|
|
```
|
|
|
|
### アラート
|
|
|
|
{{< new-feature version="v0.9.0" >}}
|
|
|
|
アラートは、ブロッククォート構文に基づくMarkdown拡張で、重要な情報を強調するために使用できます。
|
|
[GitHubスタイルのアラート](https://docs.github.com/ja/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)がサポートされています。
|
|
Hextraの最新バージョンと[Hugo v0.134.0](https://github.com/gohugoio/hugo/releases/tag/v0.134.0)以降を使用していることを確認してください。
|
|
|
|
> [!NOTE]
|
|
> ユーザーが知っておくべき有用な情報で、内容をざっと見る際にも役立ちます。
|
|
|
|
> [!TIP]
|
|
> 物事をより良く、または簡単に行うための役立つアドバイス。
|
|
|
|
> [!IMPORTANT]
|
|
> ユーザーが目標を達成するために知っておくべき重要な情報。
|
|
|
|
> [!WARNING]
|
|
> 問題を避けるために即座にユーザーの注意を引く必要がある緊急の情報。
|
|
|
|
> [!CAUTION]
|
|
> 特定のアクションのリスクやネガティブな結果についてのアドバイス。
|
|
|
|
```markdown {filename=Markdown}
|
|
> [!NOTE]
|
|
> ユーザーが知っておくべき有用な情報で、内容をざっと見る際にも役立ちます。
|
|
|
|
> [!TIP]
|
|
> 物事をより良く、または簡単に行うための役立つアドバイス。
|
|
|
|
> [!IMPORTANT]
|
|
> ユーザーが目標を達成するために知っておくべき重要な情報。
|
|
|
|
> [!WARNING]
|
|
> 問題を避けるために即座にユーザーの注意を引く必要がある緊急の情報。
|
|
|
|
> [!CAUTION]
|
|
> 特定のアクションのリスクやネガティブな結果についてのアドバイス。
|
|
```
|
|
|
|
### テーブル
|
|
|
|
テーブルはMarkdownのコア仕様には含まれていませんが、Hugoはデフォルトでサポートしています。
|
|
|
|
| 名前 | 年齢 |
|
|
|--------|------|
|
|
| ボブ | 27 |
|
|
| アリス | 23 |
|
|
|
|
```markdown {filename=Markdown}
|
|
| 名前 | 年齢 |
|
|
|--------|------|
|
|
| ボブ | 27 |
|
|
| アリス | 23 |
|
|
```
|
|
|
|
#### テーブル内のインラインMarkdown
|
|
|
|
| 斜体 | 太字 | コード |
|
|
| -------- | -------- | ------ |
|
|
| *斜体* | **太字** | `コード` |
|
|
|
|
```markdown {filename=Markdown}
|
|
| 斜体 | 太字 | コード |
|
|
| -------- | -------- | ------ |
|
|
| *斜体* | **太字** | `コード` |
|
|
```
|
|
|
|
### コードブロック
|
|
|
|
{{< cards >}}
|
|
{{< card link="../../guide/syntax-highlighting" title="シンタックスハイライト" icon="sparkles" >}}
|
|
{{< /cards >}}
|
|
|
|
### リスト
|
|
|
|
#### 順序付きリスト
|
|
|
|
1. 最初の項目
|
|
2. 2番目の項目
|
|
3. 3番目の項目
|
|
|
|
```markdown {filename=Markdown}
|
|
1. 最初の項目
|
|
2. 2番目の項目
|
|
3. 3番目の項目
|
|
```
|
|
|
|
#### 順序なしリスト
|
|
|
|
* リスト項目
|
|
* 別の項目
|
|
* さらに別の項目
|
|
|
|
```markdown {filename=Markdown}
|
|
* リスト項目
|
|
* 別の項目
|
|
* さらに別の項目
|
|
```
|
|
|
|
#### ネストされたリスト
|
|
|
|
* 果物
|
|
* りんご
|
|
* オレンジ
|
|
* バナナ
|
|
* 乳製品
|
|
* 牛乳
|
|
* チーズ
|
|
|
|
```markdown {filename=Markdown}
|
|
* 果物
|
|
* りんご
|
|
* オレンジ
|
|
* バナナ
|
|
* 乳製品
|
|
* 牛乳
|
|
* チーズ
|
|
```
|
|
|
|
### 画像
|
|
|
|
|
|
|
|
```markdown {filename=Markdown}
|
|
|
|
```
|
|
|
|
キャプション付き:
|
|
|
|
|
|
|
|
```markdown {filename=Markdown}
|
|
|
|
```
|
|
|
|
## 設定
|
|
|
|
HugoはMarkdownの解析に[Goldmark](https://github.com/yuin/goldmark)を使用しています。
|
|
Markdownのレンダリングは、`hugo.yaml`の`markup.goldmark`で設定できます。
|
|
以下はHextraのデフォルト設定です:
|
|
|
|
```yaml {filename="hugo.yaml"}
|
|
markup:
|
|
goldmark:
|
|
renderer:
|
|
unsafe: true
|
|
highlight:
|
|
noClasses: false
|
|
```
|
|
|
|
その他の設定オプションについては、Hugoのドキュメント[Configure Markup](https://gohugo.io/getting-started/configuration-markup/)を参照してください。
|
|
|
|
## 学習リソース
|
|
|
|
* [Markdownガイド](https://www.markdownguide.org/)
|
|
* [Markdownチートシート](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
|
|
* [Markdownチュートリアル](https://www.markdowntutorial.com/)
|
|
* [Markdownリファレンス](https://commonmark.org/help/)
|