src.elv.sh@v0.21.0-dev.0.20240515223629-06979efb9a2a/pkg/mods/md/md.d.elv (about)

     1  #//each:eval use md
     2  
     3  #doc:added-in 0.21
     4  # Renders `$markdown` in the terminal.
     5  #
     6  # The `&width` option specifies the width to wrap the output to. If it is 0 (the
     7  # default) or negative, `show` queries the terminal width of the standard output
     8  # and use it as the width, falling back to 80 if the query fails (for example
     9  # when the standard output is not a terminal).
    10  #
    11  # Examples:
    12  #
    13  # ```elvish-transcript
    14  # ~> md:show "#h1 heading\n- List\n- Item"
    15  # #h1 heading
    16  #
    17  # • List
    18  #
    19  # • Item
    20  # ```
    21  #
    22  # See also [`doc:show`]().
    23  fn show {|&width=0| markdown}