Skip to content

Commit

Permalink
Add indent configuration option to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrmurach committed Aug 31, 2020
1 parent 7fbf1be commit a9c8d35
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Or install it yourself as:
* [2.2 :theme](#22-theme)
* [2.3 :width](#23-width)
* [2.4 :symbols](#24-symbols)
* [2.5 :indent](#25-indent)
* [3. Command line tool](#3-command-line-tool)

## 1. Usage
Expand Down Expand Up @@ -284,6 +285,14 @@ TTY::Markdown.parse(markdown_string, symbols: {base: :ascii})
TTY::Markdown.parse(markdown_string, symbols: {override: {bullet: "x"}})
```

### 2.5 `:indent`

By default any content apart from the main `h1` header is indented with `2` spaces. Use `:indent` to provide custom indent or no indent at all:

```ruby
TTY::Markdown.parse(markdown_string, indent: 0)
```

### 3. Command line tool

You can install [tty-markdown-cli](https://github.com/piotrmurach/tty-markdown-cli) to use `tty-markdown` executable in terminal:
Expand Down

0 comments on commit a9c8d35

Please sign in to comment.