I am using markdown in order to create a table. My Description column contains very long texts and therefor it looks very bad on the markdown file when I wrap lines:
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.
I want to wrap lines since it is more readable for me.
Is there a way to make the table more readable for the editor?
Answer
There's another option. Since the philosophy is that Markdown is supposed to be lightweight, not a markup language, and intended for natural human consumption (in contrast to SGML/HTML-style formats), I believe it's fine and natural to fall back to ASCII art for special cases.
For this particular task, character art is natural. Thus, just indent your table with four spaces, format it nicely for readability, and Markdown will just treat it as pre-formatted text, and both sides can stop fighting each other.
For example:
| 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. |
|-------------|---------------------------------------------------------------|
... and done.