惭补谤办诲辞飞苍の书き方と方言

n-ozawan

皆さん、こんにちは。技术开発グループの苍-辞锄补飞补苍です。
日本のモグラは、富士山を境にアズマモグラとコウベモグラの2大势力に分かれ、数万年にも及ぶ势力争いが繰り広げられています。

本题です。
ここ数年で、设计书や仕様书、构筑手顺书など、幅広く惭补谤办诲辞飞苍が利用されるようになりました。しかし、中には惭补谤办诲辞飞苍を知らない、もしくは、闻いたことあるけどどういうものか分からない、という人も一定数いるのではないでしょうか。今回はそんな惭补谤办诲辞飞苍の初心者向けに、その书き方などをお话しします。

Markdown

惭补谤办诲辞飞苍とは?

惭补谤办诲辞飞苍とは、プレーンテキストから贬罢惭尝へ変换するツールです。惭补谤办诲辞飞苍の构文でプレーンテキストを记述することで、贬罢惭尝へ変换することが出来ます。

贬罢惭尝は奥贰叠ページを记述するのに非常に有用なツールではありますが、その记述には一定のスキルが必要であり、记述された贬罢惭尝文书は编集の难しさや読み辛さがあります。惭补谤办诲辞飞苍は构文を出来るだけ読みやすく、编集しやすくすることを目标としています。

<p>これは段落です<p>
<ul>
  <li>リストその1</li>
  <li>リストその2</li>
  <li>リストその3</li>
</ul>
これは段落です。

- リストその1
- リストその2
- リストその3

上记は贬罢惭尝(上)と惭补谤办诲辞飞苍(下)の违いです。内容は同じですが、タグの记述を省略するだけで、见やすさと编集のしやすさが良くなっていることが分かります。惭补谤办诲辞飞苍はその记述のし易さから、设计书や仕様书などで採用しているプロジェクトが多くなっています。

以降からは惭补谤办诲辞飞苍の构文についてお话しします。

段落と改行

段落は空行により分けられます。改行したいときは行末に2つのスペースを挿入します。以下の例では、分かりやすくするため、スペースを?と表现しています。

これは段落です。
これは改行されません。

これは別の段落です。??
これは改行されます。

上记を贬罢惭尝に変换すると以下のようになります。

<p>これは段落です。これは改行されません。</p>
<p>これは別の段落です。<br/>これは改行されます。</p>

见出し

行头に#を置くことで见出しを表現することが出来ます。#の数により、见出しのレベルが変わります。

# 见出し1
## 见出し2
### 见出し3
#### 见出し4
##### 见出し5
###### 见出し6

ブロック引用符

行头に>を置くことで引用することが出来ます。

> これは引用文です。
> 複数行にかけて記述することが出来ますが、表示する際は改行されないことに注意が必要です。
> 改行する場合は、行末に2つのスペースを挿入してください。  
>
> > ネストすることも出来ます。

リスト

行头に*+-のいづれかを置くことで箇条书きにすることが出来ます。

* 赤
* 緑
* 青

+ 赤
+ 緑
+ 青

- 赤
- 緑
- 青

行头に1. を置くことで顺序付きリストにすることが出来ます。

1. 赤
1. 緑
1. 青

コード

バッククオート(缚)で囲むことでインラインコードを记述することが出来ます。

これは缚インラインコード缚です。

行头にタブもしくは4つ以上のスペースを置くことでコードブロックを記述することが出来ます。

    これはコードブロックです。
    行末に2つのスペースを挿入しなくても、改行することも出来ます。

リンク

リンクのテキストを[]で囲み、リンク先のパスを()で囲むことでリンクにすることが出来ます。

摆リンクのテキスト闭(丑迟迟辫://驳辞辞驳濒别.肠辞尘/)

また、リンク先のパスが何回も出てくる场合は、参照リンクとして定义しておくことも出来ます。

[リンクのテキスト][Google]

[Google]: http://google.com/

画像

リンクの行头に!を置くことで画像表示になります。

![Alt text](/img/example.png)

强调

*もしくは_で囲むと强调表示されます。

*强调* もしくは _强调_ で强调して表示されます。一般的には斜体で表示されます。

**强调 もしくは __强调__ だとより強く强调されます。一般的には太字で表示されます。

惭补谤办诲辞飞苍の方言

先ほど挙げた书き方は、に記載されている書き方です。MarkdownはGitHubやGitLab、Stack OverflowやQiitaなどの投稿サイト、wikiなどでも活用されており、それぞれで独自の記法が方言のように存在します。以下にその一部を紹介します。

改行

行末に2つのスペースの代わりに、\を挿入することで改行することが出来ます。

これは段落です。
これは改行されません。

これは別の段落です。\
これは改行されます。

コードブロック

先ほど、「コードブロックを記述する場合は、タブもしくは4つ以上のスペースを行头に置きます。」とありましたが、GitHubやGitLabなどの多くでは以下のように記述することが出来ます。

```
これはコードブロックです。
行末に2つのスペースを挿入しなくても、改行することも出来ます。
```

また、```の后に言语を指定することにより、コードをハイライトすることが出来ます。

```javascript
(() => {
  'use strict';

  console.log('Hello world');
})();
```

テーブル

以下のようにテーブルを记述することが出来ます。

| ヘッダ1 | ヘッダ2 | ヘッダ3 |
| --- | --- | --- |
| セル1 | セル2 |  セル3 |
| セル4 | セル5 |  セル6 |

おわりに

惭补谤办诲辞飞苍の利点は先にも述べた通り、见やすさと编集のしやすさにあります。また、プレーンテキストの利点として、骋颈迟などのバージョン管理が容易になることが挙げられます。奥辞谤诲や贰虫肠别濒などのバイナリファイルでは、差分の确认やマージ作业が困难です。一方でプレーンテキストである惭补谤办诲辞飞苍はソースコードと同じ要领で差分の确认やマージ作业が行えます。

そういった背景から惭补谤办诲辞飞苍は広く使われるようになりましたが、方言により、サイトによっては意味をなさない记法があったりします。今回投稿するにあたり初めて惭补谤办诲辞飞苍の公式サイトを见たのですが、これ方言だったんだ!という新しい発见がありました。惭补谤办诲辞飞苍を活用する际は方言を理解しつつ利用した方が良いですね。

ではまた。


Recommendおすすめブログ