Configuration¶

    # Report

    See [**example**](https://example.com).
    ```

=== "djot"

````djot

    # Report

    See [*example*](https://example.com).
    ```

=== "plain"
```text
Report

    See example.
    ```

`markdown` and `djot` both preserve structure and link targets. `djot` uses single-asterisk strong emphasis; `markdown` uses double asterisks. `plain` strips all formatting, link targets, and list markers, returning readable text only.

## Builder Examples

=== "Rust"
```rust
use html_to_markdown_rs::{convert, ConversionOptions, HeadingStyle};

    let options = ConversionOptions::builder()
        .heading_style(HeadingStyle::Atx)
        .code_block_style("backticks")
        .wrap(true)
        .wrap_width(80)
        .extract_metadata(true)
        .build();

    let result = convert(html, Some(options))?;
    ```

=== "Python"
```python
from html_to_markdown import ConversionOptions, convert

    options = ConversionOptions(
        heading_style="atx",
        code_block_style="backticks",
        wrap=True,
        wrap_width=80,
        extract_metadata=True,
    )
    result = convert(html, options)
    ```

=== "TypeScript"
```typescript
import { convert, ConversionOptions } from '@kreuzberg/html-to-markdown';

    const options: ConversionOptions = {
      headingStyle: 'atx',
      codeBlockStyle: 'backticks',
      wrap: true,
      wrapWidth: 80,
      extractMetadata: true,
    };

    const result = convert(html, options);
    ```

=== "Go"
`go
    opts := htmltomarkdown.ConversionOptions{
        HeadingStyle:    "atx",
        CodeBlockStyle:  "backticks",
        Wrap:            true,
        WrapWidth:       80,
        ExtractMetadata: true,
    }
    result, err := htmltomarkdown.Convert(html, opts)`

=== "Ruby"
`ruby
    result = HtmlToMarkdown.convert(
      html,
      heading_style: :atx,
      code_block_style: :fenced,
      wrap: true,
      wrap_width: 80,
      extract_metadata: true,
    )`

=== "PHP"
`php
    $options = new ConversionOptions(
        headingStyle: 'Atx',
        codeBlockStyle: 'Backticks',
        wrap: true,
        wrapWidth: 80,
        extractMetadata: true,
    );
    $result = $converter->convert($html, $options);`

=== "Java"
`java
    ConversionOptions options = ConversionOptions.builder()
        .headingStyle("atx")
        .codeBlockStyle("backticks")
        .wrap(true)
        .wrapWidth(80)
        .extractMetadata(true)
        .build();
    ConversionResult result = HtmlToMarkdown.convert(html, options);`

=== "C#"
`csharp
    var options = new ConversionOptions
    {
        HeadingStyle = "atx",
        CodeBlockStyle = "backticks",
        Wrap = true,
        WrapWidth = 80,
        ExtractMetadata = true,
    };
    var result = HtmlToMarkdownConverter.Convert(html, options);`

=== "Elixir"
`elixir
    opts = %HtmlToMarkdown.Options{
      heading_style: :atx,
      code_block_style: :backticks,
      wrap: true,
      wrap_width: 80,
      extract_metadata: true,
    }
    {:ok, result} = HtmlToMarkdown.convert(html, opts)`

=== "R"
`r
    opts <- conversion_options(
      heading_style = "atx",
      code_block_style = "backticks",
      wrap = TRUE,
      wrap_width = 80L,
      extract_metadata = TRUE
    )
    result <- convert(html, opts)`

---

!!! question "Found a bug or mistake on this page?"
If something here is wrong or out of date, [open an issue](https://github.com/kreuzberg-dev/html-to-markdown/issues/new?labels=documentation) on GitHub or [contribute a fix](https://github.com/kreuzberg-dev/html-to-markdown/blob/main/CONTRIBUTING.md) via pull request.

````