nushell/docs/commands/to_md.md
JT 8c0a2d3c15
Auto-generate markdown command docs (#4451)
* Finish updating

* a couple improvements

* Update renames

* cleanup examples
2022-02-13 21:22:51 -05:00

641 B

title layout version
to md command 0.59.0

Convert table into simple Markdown

Signature

> to md --pretty --per-element

Parameters

  • --pretty: Formats the Markdown table to vertically align items
  • --per-element: treat each row as markdown syntax element

Examples

Outputs an MD string representing the contents of this table

> [[foo bar]; [1 2]] | to md

Optionally, output a formatted markdown string

> [[foo bar]; [1 2]] | to md --pretty

Treat each row as a markdown element

> [{"H1": "Welcome to Nushell" } [[foo bar]; [1 2]]] | to md --per-element --pretty