Skip to content

Latest commit

 

History

History
192 lines (124 loc) · 4.23 KB

ja-quick-start-for-markdown-users.md

File metadata and controls

192 lines (124 loc) · 4.23 KB

Markdownユーザー向けのクイックスタート

DjotはMarkdownとよく似ています。
移行に際し注意すべき主な相違点を記します。

空行

djotでは、ブロックレベル要素の周りに空行が必要です。すなわち以下は

これはテキストです。
## 次の見出し

以下のように書きます。

これはテキストです。

## 次の見出し

以下は

これはテキストです。
```lua
local foo = bar.baz または false
```

このように書く必要があります。

これはテキストです。

```lua
local foo = bar.baz または false
```

以下は

テキスト
> ブロッククオート

の代わりに

テキスト

> ブロッククオート

これも

区切りの前
****
区切りの後

こう書かなければならない

区切りの前

****

区切りの後

リスト

特殊なケース、たとえサブリストであってもリストの前には必ず空行が必要です。Markdownでは次のように書くことができます

- one
  - two
  - three

はい、以下のように書く必要があります。

- one

  - two
  - three

見出し

Setextスタイル(下線を用います)に見出しはなく、あるのは(#)を用いるATXスタイルのみです。

見出しの内容は数行にわたって書くことができ、その前に # があってもなくてもかまいません:

## これは一行(になるよ)
## level-2 見出しになるよ

### これも一行(になるよ)
level-3 小見出しになるよ

*訳者より: プレビューのイメージが難しければ djot playground でコードを貼り付けプレビューするとわかりやすいです。

結果として、見出しの後には常に空行が必要です。

見出し末尾の # は内容の一部として読み取られ無視されません。

コードブロック

インデント式のコードブロックはなく```で囲むだけです。

引用

> の後に改行が続く場合を除き、 > の後にはスペースが必要です。

ハイライト(強調)

通常の強調にはシングルの _ 区切り文字、強い強調にはシングルの * 区切り文字を用います(挟みます)。

リンク

Markdownのようにリンクにタイトルを追加する特別な構文はありません:

[link](http://example.com "私のウェブサイトへ")

リンクにタイトル属性を付けたい場合は、一般的な属性構文を使います:

[link](http://example.com){title="私のウェブサイトへ"}.

ハード(強制)改行

Markdownでは、行を2つのスペースで終わらせることで、ハード改行を作成することができます。djotでは改行の前にバックスラッシュ \ を使用します。

ここで\
改行します

Raw HTML

Markdownでは、raw HTMLを"そのまま"挿入することができます。 djotでは、raw HTMLとしてマークする必要があります:

これがraw HTMLです: <a id="foo">{=html}

これがraw HTMLブロックです:


``` =html
<table>
<tr><td>foo</td></tr>
</table>
```

テーブル

パイプテーブルは、多くのMarkdownの実装とは異なり、常に各行の最初と最後にパイプ文字を必要とします。 つまり、これはテーブルではありません:

a|b
-|-
1|2

が、これはテーブルです。

| a | b |
| - | - |
| 1 | 2 |

始めるにはこれで十分です!

ここでは、Markdownユーザをつまずかせる可能性のある事柄に焦点を当てました。 これらを頭に入れておけば、これ以上ドキュメントを見ることなくdjotを使い始めることができるはずです。

しかし、djotではできるがMarkdownではできないことについては、まだ何も議論していません。

利用可能な新しい構文については、構文説明を参照してください。