# storyFrameToMarkdown

Source: /tuil/docs/reference/packages/story/api/story-frame-to-markdown
Locale: en

function exported by @mwillbanks/tuil-story.



{/* Generated by tooling/docs/generate-reference.ts. */}

## function [#function]

Public function exported by `@mwillbanks/tuil-story`.

```ts
export function storyFrameToMarkdown(frame: StorySnapshot): string;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member  | Type            | Required | Description                                    | Related types                                                        |
| ------- | --------------- | -------- | ---------------------------------------------- | -------------------------------------------------------------------- |
| `frame` | `StorySnapshot` | Yes      | Supplies the `frame` value as `StorySnapshot`. | [`StorySnapshot`](/tuil/docs/reference/packages/story/api/story-snapshot) |

## Returns [#returns]

`string` — Returns a value that satisfies `string`.

Related types: —

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`StorySnapshot`](/tuil/docs/reference/packages/story/api/story-snapshot)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/story/src/index.tsx)

## Package [#package]

[@mwillbanks/tuil-story](/tuil/docs/reference/packages/story)