# Markdown

## Get markdown.

`client.BrowserRendering.Markdown.New(ctx, params) (*string, error)`

**post** `/accounts/{account_id}/browser-rendering/markdown`

Gets markdown of a webpage from provided URL or HTML. Control page loading with `gotoOptions` and `waitFor*` options.

### Parameters

- `params MarkdownNewParams`

  - `AccountID param.Field[string]`

    Path param: Account ID.

  - `URL param.Field[string]`

    Body param: URL to navigate to, eg. `https://example.com`.

  - `CacheTTL param.Field[float64]`

    Query param: Cache TTL default is 5s. Set to 0 to disable.

  - `ActionTimeout param.Field[float64]`

    Body param: The maximum duration allowed for the browser action to complete after the page has loaded (such as taking screenshots, extracting content, or generating PDFs). If this time limit is exceeded, the action stops and returns a timeout error.

  - `AddScriptTag param.Field[[]MarkdownNewParamsVariant0AddScriptTag]`

    Body param: Adds a `<script>` tag into the page with the desired URL or content.

    - `ID string`

    - `Content string`

    - `Type string`

    - `URL string`

  - `AddStyleTag param.Field[[]MarkdownNewParamsVariant0AddStyleTag]`

    Body param: Adds a `<link rel="stylesheet">` tag into the page with the desired URL or a `<style type="text/css">` tag with the content.

    - `Content string`

    - `URL string`

  - `AllowRequestPattern param.Field[[]string]`

    Body param: Only allow requests that match the provided regex patterns, eg. '/^.*.(css)'.

  - `AllowResourceTypes param.Field[[]MarkdownNewParamsVariant0AllowResourceType]`

    Body param: Only allow requests that match the provided resource types, eg. 'image' or 'script'.

    - `const MarkdownNewParamsVariant0AllowResourceTypeDocument MarkdownNewParamsVariant0AllowResourceType = "document"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeStylesheet MarkdownNewParamsVariant0AllowResourceType = "stylesheet"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeImage MarkdownNewParamsVariant0AllowResourceType = "image"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeMedia MarkdownNewParamsVariant0AllowResourceType = "media"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeFont MarkdownNewParamsVariant0AllowResourceType = "font"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeScript MarkdownNewParamsVariant0AllowResourceType = "script"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeTexttrack MarkdownNewParamsVariant0AllowResourceType = "texttrack"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeXHR MarkdownNewParamsVariant0AllowResourceType = "xhr"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeFetch MarkdownNewParamsVariant0AllowResourceType = "fetch"`

    - `const MarkdownNewParamsVariant0AllowResourceTypePrefetch MarkdownNewParamsVariant0AllowResourceType = "prefetch"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeEventsource MarkdownNewParamsVariant0AllowResourceType = "eventsource"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeWebsocket MarkdownNewParamsVariant0AllowResourceType = "websocket"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeManifest MarkdownNewParamsVariant0AllowResourceType = "manifest"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeSignedexchange MarkdownNewParamsVariant0AllowResourceType = "signedexchange"`

    - `const MarkdownNewParamsVariant0AllowResourceTypePing MarkdownNewParamsVariant0AllowResourceType = "ping"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeCspviolationreport MarkdownNewParamsVariant0AllowResourceType = "cspviolationreport"`

    - `const MarkdownNewParamsVariant0AllowResourceTypePreflight MarkdownNewParamsVariant0AllowResourceType = "preflight"`

    - `const MarkdownNewParamsVariant0AllowResourceTypeOther MarkdownNewParamsVariant0AllowResourceType = "other"`

  - `Authenticate param.Field[MarkdownNewParamsVariant0Authenticate]`

    Body param: Provide credentials for HTTP authentication.

    - `Password string`

    - `Username string`

  - `BestAttempt param.Field[bool]`

    Body param: Attempt to proceed when 'awaited' events fail or timeout.

  - `Cookies param.Field[[]MarkdownNewParamsVariant0Cookie]`

    Body param: Check [options](https://pptr.dev/api/puppeteer.page.setcookie).

    - `Name string`

      Cookie name.

    - `Value string`

    - `Domain string`

    - `Expires float64`

    - `HTTPOnly bool`

    - `PartitionKey string`

    - `Path string`

    - `Priority MarkdownNewParamsVariant0CookiesPriority`

      - `const MarkdownNewParamsVariant0CookiesPriorityLow MarkdownNewParamsVariant0CookiesPriority = "Low"`

      - `const MarkdownNewParamsVariant0CookiesPriorityMedium MarkdownNewParamsVariant0CookiesPriority = "Medium"`

      - `const MarkdownNewParamsVariant0CookiesPriorityHigh MarkdownNewParamsVariant0CookiesPriority = "High"`

    - `SameParty bool`

    - `SameSite MarkdownNewParamsVariant0CookiesSameSite`

      - `const MarkdownNewParamsVariant0CookiesSameSiteStrict MarkdownNewParamsVariant0CookiesSameSite = "Strict"`

      - `const MarkdownNewParamsVariant0CookiesSameSiteLax MarkdownNewParamsVariant0CookiesSameSite = "Lax"`

      - `const MarkdownNewParamsVariant0CookiesSameSiteNone MarkdownNewParamsVariant0CookiesSameSite = "None"`

    - `Secure bool`

    - `SourcePort float64`

    - `SourceScheme MarkdownNewParamsVariant0CookiesSourceScheme`

      - `const MarkdownNewParamsVariant0CookiesSourceSchemeUnset MarkdownNewParamsVariant0CookiesSourceScheme = "Unset"`

      - `const MarkdownNewParamsVariant0CookiesSourceSchemeNonSecure MarkdownNewParamsVariant0CookiesSourceScheme = "NonSecure"`

      - `const MarkdownNewParamsVariant0CookiesSourceSchemeSecure MarkdownNewParamsVariant0CookiesSourceScheme = "Secure"`

    - `URL string`

  - `EmulateMediaType param.Field[string]`

    Body param

  - `GotoOptions param.Field[MarkdownNewParamsVariant0GotoOptions]`

    Body param: Check [options](https://pptr.dev/api/puppeteer.gotooptions).

    - `Referer string`

    - `ReferrerPolicy string`

    - `Timeout float64`

    - `WaitUntil MarkdownNewParamsVariant0GotoOptionsWaitUntilUnion`

      - `MarkdownNewParamsVariant0GotoOptionsWaitUntilString`

        - `const MarkdownNewParamsVariant0GotoOptionsWaitUntilStringLoad MarkdownNewParamsVariant0GotoOptionsWaitUntilString = "load"`

        - `const MarkdownNewParamsVariant0GotoOptionsWaitUntilStringDomcontentloaded MarkdownNewParamsVariant0GotoOptionsWaitUntilString = "domcontentloaded"`

        - `const MarkdownNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle0 MarkdownNewParamsVariant0GotoOptionsWaitUntilString = "networkidle0"`

        - `const MarkdownNewParamsVariant0GotoOptionsWaitUntilStringNetworkidle2 MarkdownNewParamsVariant0GotoOptionsWaitUntilString = "networkidle2"`

      - `MarkdownNewParamsVariant0GotoOptionsWaitUntilArray`

        - `const MarkdownNewParamsVariant0GotoOptionsWaitUntilArrayLoad MarkdownNewParamsVariant0GotoOptionsWaitUntilArray = "load"`

        - `const MarkdownNewParamsVariant0GotoOptionsWaitUntilArrayDomcontentloaded MarkdownNewParamsVariant0GotoOptionsWaitUntilArray = "domcontentloaded"`

        - `const MarkdownNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle0 MarkdownNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle0"`

        - `const MarkdownNewParamsVariant0GotoOptionsWaitUntilArrayNetworkidle2 MarkdownNewParamsVariant0GotoOptionsWaitUntilArray = "networkidle2"`

  - `RejectRequestPattern param.Field[[]string]`

    Body param: Block undesired requests that match the provided regex patterns, eg. '/^.*.(css)'.

  - `RejectResourceTypes param.Field[[]MarkdownNewParamsVariant0RejectResourceType]`

    Body param: Block undesired requests that match the provided resource types, eg. 'image' or 'script'.

    - `const MarkdownNewParamsVariant0RejectResourceTypeDocument MarkdownNewParamsVariant0RejectResourceType = "document"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeStylesheet MarkdownNewParamsVariant0RejectResourceType = "stylesheet"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeImage MarkdownNewParamsVariant0RejectResourceType = "image"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeMedia MarkdownNewParamsVariant0RejectResourceType = "media"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeFont MarkdownNewParamsVariant0RejectResourceType = "font"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeScript MarkdownNewParamsVariant0RejectResourceType = "script"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeTexttrack MarkdownNewParamsVariant0RejectResourceType = "texttrack"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeXHR MarkdownNewParamsVariant0RejectResourceType = "xhr"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeFetch MarkdownNewParamsVariant0RejectResourceType = "fetch"`

    - `const MarkdownNewParamsVariant0RejectResourceTypePrefetch MarkdownNewParamsVariant0RejectResourceType = "prefetch"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeEventsource MarkdownNewParamsVariant0RejectResourceType = "eventsource"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeWebsocket MarkdownNewParamsVariant0RejectResourceType = "websocket"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeManifest MarkdownNewParamsVariant0RejectResourceType = "manifest"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeSignedexchange MarkdownNewParamsVariant0RejectResourceType = "signedexchange"`

    - `const MarkdownNewParamsVariant0RejectResourceTypePing MarkdownNewParamsVariant0RejectResourceType = "ping"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeCspviolationreport MarkdownNewParamsVariant0RejectResourceType = "cspviolationreport"`

    - `const MarkdownNewParamsVariant0RejectResourceTypePreflight MarkdownNewParamsVariant0RejectResourceType = "preflight"`

    - `const MarkdownNewParamsVariant0RejectResourceTypeOther MarkdownNewParamsVariant0RejectResourceType = "other"`

  - `SetExtraHTTPHeaders param.Field[map[string, string]]`

    Body param

  - `SetJavaScriptEnabled param.Field[bool]`

    Body param

  - `UserAgent param.Field[string]`

    Body param

  - `Viewport param.Field[MarkdownNewParamsVariant0Viewport]`

    Body param: Check [options](https://pptr.dev/api/puppeteer.page.setviewport).

    - `Height float64`

    - `Width float64`

    - `DeviceScaleFactor float64`

    - `HasTouch bool`

    - `IsLandscape bool`

    - `IsMobile bool`

  - `WaitForSelector param.Field[MarkdownNewParamsVariant0WaitForSelector]`

    Body param: Wait for the selector to appear in page. Check [options](https://pptr.dev/api/puppeteer.page.waitforselector).

    - `Selector string`

    - `Hidden MarkdownNewParamsVariant0WaitForSelectorHidden`

      - `const MarkdownNewParamsVariant0WaitForSelectorHiddenTrue MarkdownNewParamsVariant0WaitForSelectorHidden = true`

    - `Timeout float64`

    - `Visible MarkdownNewParamsVariant0WaitForSelectorVisible`

      - `const MarkdownNewParamsVariant0WaitForSelectorVisibleTrue MarkdownNewParamsVariant0WaitForSelectorVisible = true`

  - `WaitForTimeout param.Field[float64]`

    Body param: Waits for a specified timeout before continuing.

### Returns

- `type MarkdownNewResponseEnvelopeResult string`

  Markdown content.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/browser_rendering"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  markdown, err := client.BrowserRendering.Markdown.New(context.TODO(), browser_rendering.MarkdownNewParams{
    AccountID: cloudflare.F("account_id"),
    Body: browser_rendering.MarkdownNewParamsBodyObject{
      URL: cloudflare.F("https://www.example.com/"),
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", markdown)
}
```

#### Response

```json
{
  "success": true,
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": "result"
}
```