Skip to main content

MarkdownRender

Renders the markdown. See MarkdownParser for parsing.

warning

This API surface has not been touched for a while and may not be suitable for production.

Functions​

new​

</>
MarkdownRender.new(
gui: GuiObject,
width: number--

Width to render at

) → MarkdownRender

Creates a new markdown render

Render​

</>
MarkdownRender:Render(
data: table--

Data from MarkdownParser.

) → ()

Renders the data in the given gui

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new markdown render",
            "params": [
                {
                    "name": "gui",
                    "desc": "",
                    "lua_type": "GuiObject"
                },
                {
                    "name": "width",
                    "desc": "Width to render at",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "MarkdownRender"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 30,
                "path": "src/markdownrender/src/Shared/MarkdownRender.lua"
            }
        },
        {
            "name": "Render",
            "desc": "Renders the data in the given gui",
            "params": [
                {
                    "name": "data",
                    "desc": "Data from MarkdownParser.",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 50,
                "path": "src/markdownrender/src/Shared/MarkdownRender.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "MarkdownRender",
    "desc": "Renders the markdown. See [MarkdownParser] for parsing.\n\n:::warning\nThis API surface has not been touched for a while and may not be suitable for production.\n:::",
    "source": {
        "line": 10,
        "path": "src/markdownrender/src/Shared/MarkdownRender.lua"
    }
}