nushell/docs/commands/to_html.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

39 lines
892 B
Markdown

---
title: to html
layout: command
version: 0.59.0
---
Convert table into simple HTML
## Signature
```> to html --html_color --no_color --dark --partial --theme --list```
## Parameters
- `--html_color`: change ansi colors to html colors
- `--no_color`: remove all ansi colors in output
- `--dark`: indicate your background color is a darker color
- `--partial`: only output the html for the content itself
- `--theme {string}`: the name of the theme to use (github, blulocolight, ...)
- `--list`: list the names of all available themes
## Examples
Outputs an HTML string representing the contents of this table
```shell
> [[foo bar]; [1 2]] | to html
```
Optionally, only output the html for the content itself
```shell
> [[foo bar]; [1 2]] | to html --partial
```
Optionally, output the string with a dark background
```shell
> [[foo bar]; [1 2]] | to html --dark
```