web-dev-qa-db-ja.com

長い行のマークダウンテーブル

テーブルを作成するためにマークダウンを使用しています。 [説明]列には非常に長いテキストが含まれているため、行を折り返すと、マークダウンファイルで非常に見栄えが悪くなります。

Argument            | Description |
--------            | ----------- |
appDir              | The top level directory that contains your app. If this
option is used then it assumed your scripts are in |a subdirectory under this path. This option is not required. If it is not specified, then baseUrl below is the anchor point for finding things. If this option is specified, then all the files from the app directory will be copied to the dir: output area, and baseUrl will assume to be a relative path under this directory.  
baseUrl             | By default, all modules are located relative to this path. If baseUrl is not explicitly set, then all modules are loaded relative to the directory that holds the build file. If appDir is set, then baseUrl should be specified as relative to the appDir.
dir                 | The directory path to save the output. If not specified, then the path will default to be a directory called "build" as a sibling to the build file. All relative paths are relative to the build file. 
modules             | List the modules that will be optimized. All their immediate and deep dependencies will be included in the module's file when the build is done. If that module or any of its dependencies includes i18n bundles, only the root bundles will be included unless the locale: section is set above. 

読みやすいので折り返したい。
エディターにとってテーブルを読みやすくする方法はありますか?

26
Naor

@Naorは正しいと思います。HTMLを使用して改行を作成する必要がありますが、これは回答には示されていません。表示された完全なテーブルコードは必ずしも必要ではありません。改行を行うには、2つのスペースまたは<br />タグのみが必要です。 Markdown仕様から

Markdownは、「ハードラップ」されたテキスト段落をサポートしています。これは、段落内のすべての改行文字を<br />タグに変換する他のほとんどのテキストからHTMLへのフォーマッター(Movable Typeの[Convert Line Breaks]オプションを含む)とは大きく異なります。

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

SOフレーバーマークダウンではHTMLブレークタグをエスケープする必要があるため、テキストにコードラッパーを追加する必要があることに注意してください。つまり、<br />が機能することがわかります。

しかし、私と同じようにもう少し複雑なことをしたい場合は、次のようにHTMLでさまざまなプロパティを設定できます。

<table width="300">
  <tr>
    <td> This is some text </td>
    <td> This is some somewhat longer block of text </td>
    <td> This is some very long block of text repeated to make it even longer. This is some very long block of text repeated to make it even longer. This is some very long block of text repeated to make it even longer.  </td>
  </tr>
</table>

style="width:75%"<td>sに追加しても、影響はありません。

* GitHub風味のMarkdownを使用してテーブル内にコードを書くときに同様の問題が発生しているため、これに遭遇したことに注意してください。これは非常に苦痛です。しかし、私はこれが私が与える例に色を付けるはずなので、これに注意します。私が「機能する」または「機能しない」と言うことはすべて、その環境からのものです。

編集:テーブル内にcodeブロックがある場合、これは無関係であることに注意してください。ただし、これはMarkdownの問題ではありません。HTML<code></code>ブロックはテーブルを引き延ばします。

5
Sam

別のオプションがあります。 Markdownはマークアップ言語ではなく軽量であり、人間の自然な消費を目的としている(SGML/HTMLスタイルのフォーマットとは対照的)ことを理念としているため、ASCII特殊な場合のアート。

この特定のタスクでは、キャラクターアートは自然です。したがって、4つのスペースでテーブルをインデントし、読みやすくするために適切にフォーマットします。Markdownはそれを事前フォーマット済みテキストとして扱うだけで、両側が互いに争うことを止めることができます。

例えば:

|  Sequence   | Result                                                        |
|-------------|---------------------------------------------------------------|
| `a?c`       | Matches `abc`, `axc`, and `aac`. Does not match `ac`, `abbc`, | 
|             | or `a/c`.                                                     |
|-------------|---------------------------------------------------------------|
| `a*c`       | Matches "ac", "abc" and "azzzzzzzc". Does not match "a/c".    |
|-------------|---------------------------------------------------------------|
| `foo...bar` | Matches "foobar", "fooxbar", and "fooz/blaz/rebar". Does not  |
|             | match "fo/obar", "fobar" or "food/bark".                      |
|-------------|---------------------------------------------------------------|
| `....obj`   | Matches all files anywhere in the current hierarchy that end  |
|             | in ".obj". Note that the first three periods are interpreted  |
|             | as "...", and the fourth one is interpreted as a literal "."  |
|             | character.                                                    |
|-------------|---------------------------------------------------------------|

...そして完了。

9
Steve Hollasch

残念ながら、これにはHTMLを使用する必要があります

<table>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>appDir</td>
<td>The top level directory that contains your app. If this option is used then
it assumed your scripts are in</td>
</tr>
<tr>
<td>baseUrl</td>
<td>By default, all modules are located relative to this path. If baseUrl is not
explicitly set, then all modules are loaded relative to the directory that holds
the build file. If appDir is set, then baseUrl should be specified as relative
to the appDir.</td>
</tr>
<tr>
<td>dir</td>
<td>The directory path to save the output. If not specified, then the path will
default to be a directory called "build" as a sibling to the build file. All
relative paths are relative to the build file.</td>
</tr>
<tr>
<td>modules</td>
<td>List the modules that will be optimized. All their immediate and deep
dependencies will be included in the module's file when the build is done. If
that module or any of its dependencies includes i18n bundles, only the root
bundles will be included unless the locale: section is set above.</td>
</tr>
</table>
2
Steven Penny

こんにちは私は同じことを考えていました。私はこれをドキュメンテーションファイルのために必要とし、これは私がこれを処理する方法です:

| key | description                        |
| --- | ---                                |
| foo | bla bla blabla bla blabla bla bla  |
|     | bla bla blabla bla bla bla bla bla |
| bar | something else bla                 |

マークダウンが「ハードラップされた」言語であると想定しているため、上記の問題のサムに同意します。そのため、これは不正行為です(有効なマークダウンではないと思います)。しかし、たとえばいくつかのGithubプロジェクトではREADME.mdファイルリストアイテムを次のようにラップしている人を見ました。

 * foo
 * bla bla bla bla bla bla bla bla bla bla 
   bla bla bla bla bla bla bla bla bla

また、私の大学は http://www.tablesgenerator.com/markdown_tables がテーブルを同様にラッピングしていたと指摘しました(トムに感謝)

したがって、解析されない(Githubのドキュメントなど)何かを実行している場合は、私の例を使用しても問題ないと思いますが、Markdown to HTMLパーサーまたはCucumberテストテーブルを実行している場合は、ラップしないでください。

しかし、私は間違っているかもしれません

1
equivalent8