2017-01-06 57 views
3

Markdownファイルは、VCS内にあり、プルリクエストやレビューに参加しており、形式が整っています。そして、ソースコードと同様に、コードフォーマッタのように、特定の長さで挿入された改行が頻繁に見られます。マークダウンと行の折り返し

現在のウィンドウサイズに応じて、多くのエディタが動的に行います。さらに、Markdownは、主にHTMLページ、PDFドキュメント、または他のフォーマットを生成するために使用されます。手作業で挿入された改行は、これらの状況でしばしば混乱したテキストレンダリングにつながります。

だから、特定の行の長さでマークダウンを折り返して何らかのアンチパターンがあるのか​​、それとも何か不足していますか?

編集:この全体のトピックはcontroversialのようです。現在CommonMark仕様(v0.26)が幾分フェンスに座っている:

二つ以上のスペースが付いていないか、バックスラッシュは次のように解析される(ないコードスパンまたはHTMLタグ内の)正規改行ソフトブレーク。 (softbreakが終了ラインとして又は空間のいずれかHTMLにレンダリングすることができる。結果はブラウザで同じであろう。ここでの例では、終了ラインが使用される。)

[...]

準拠パーサは、改行またはスペースとしてHTML内のソフト改行をレンダリングすることがあります。

レンダラーは、ソフト改行をハード改行としてレンダリングするオプションも提供します。

しかし、戻って2004年にJohn Gruber said

「テキストの一つ以上の連続した行」の意味するところは、ルールが値下げは「ハード・ラップ」のテキスト段落をサポートしていることです。これは段落内のすべての改行文字を<br />タグに変換する他の大部分のテキスト - HTMLフォーマッタ(Movable Typeの "改行改行"オプションを含む)とは大きく異なります。

Markdownを使用して<br />ブレークタグを挿入する場合は、2つ以上のスペースを含む行を終了し、returnと入力します。

はい、<br />を作成するのに少し時間がかかりますが、単純な「すべての改行は<br />です」というルールはMarkdownでは機能しません。 Markdownの電子メールスタイルのブロック引用と複数段落のリスト項目は、ハードブレークで書式を設定すると、最もよく機能し、見栄えがよくなります。

答えて

1

ほとんどのマークダウンレンダラーは一行の改行を無視するため、合意した長さの周りにテキストを折り返してもレンダリング結果には影響しません。しかし、コードを潜在的に保守しやすくする可能性があります。これはアンチパターンではないだけでなく、コーディングの基準(頭の上の例:libstoragemgmt-doc)でも必要なプロジェクトもあります。

+0

GitHubは本当に一行改行を無視しているようですが([このGist](https://gist.github.com/beatngu13/754ceec042709e23d7945d3a953c2461))、それらはPandocによって無視されません(例コマンド 'pandoc -self -contained --from markdown_github')。しかし、おそらくこれのための旗があります。 – beatngu13

関連する問題