{"route":"/en-US-v0.13.1/reference/text/raw/","title":"Raw Text / Code","description":"Documentation for the `raw` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"syntax","name":"Syntax","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-text","name":"text","children":[]},{"id":"parameters-block","name":"block","children":[]},{"id":"parameters-lang","name":"lang","children":[]},{"id":"parameters-align","name":"align","children":[]},{"id":"parameters-syntaxes","name":"syntaxes","children":[]},{"id":"parameters-theme","name":"theme","children":[]},{"id":"parameters-tab-size","name":"tab-size","children":[]}]},{"id":"definitions","name":"Definitions","children":[{"id":"definitions-line","name":"Raw Text / Code Line","children":[{"id":"definitions-line-number","name":"number","children":[]},{"id":"definitions-line-count","name":"count","children":[]},{"id":"definitions-line-text","name":"text","children":[]},{"id":"definitions-line-body","name":"body","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"raw","title":"Raw Text / Code","keywords":[],"oneliner":"Raw text with optional syntax highlighting.","element":true,"contextual":false,"deprecation":null,"details":"

Raw text with optional syntax highlighting.

\n

Displays the text verbatim and in a monospace font. This is typically used\nto embed computer code into your document.

\n

Example

\n
Adding `rbx` to `rcx` gives\nthe desired result.\n\nWhat is ```rust fn main()``` in Rust\nwould be ```c int main()``` in C.\n\n```rust\nfn main() {\n    println!("Hello World!");\n}\n```\n\nThis has ``` `backticks` ``` in it\n(but the spaces are trimmed). And\n``` here``` the leading space is\nalso trimmed.\n
\"Preview\"
\n

You can also construct a raw element programmatically from a string (and\nprovide the language tag via the optional lang argument).

\n
#raw("fn " + "main() {}", lang: "rust")\n
\"Preview\"
\n

Syntax

\n

This function also has dedicated syntax. You can enclose text in 1 or 3+\nbackticks (`) to make it raw. Two backticks produce empty raw text.\nThis works both in markup and code.

\n

When you use three or more backticks, you can additionally specify a\nlanguage tag for syntax highlighting directly after the opening backticks.\nWithin raw blocks, everything (except for the language tag, if applicable)\nis rendered as is, in particular, there are no escape sequences.

\n

The language tag is an identifier that directly follows the opening\nbackticks only if there are three or more backticks. If your text starts\nwith something that looks like an identifier, but no syntax highlighting is\nneeded, start the text with a single space (which will be trimmed) or use\nthe single backtick syntax. If your text should start or end with a\nbacktick, put a space before or after it (it will be trimmed).

","example":null,"self":false,"params":[{"name":"text","details":"

The raw text.

\n

You can also use raw blocks creatively to create custom syntaxes for\nyour automations.

","example":"
// Parse numbers in raw blocks with the\n// `mydsl` tag and sum them up.\n#show raw.where(lang: "mydsl"): it => {\n  let sum = 0\n  for part in it.text.split("+") {\n    sum += int(part.trim())\n  }\n  sum\n}\n\n```mydsl\n1 + 2 + 3 + 4 + 5\n```\n
\"Preview\"
","types":["str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"block","details":"

Whether the raw text is displayed as a separate block.

\n

In markup mode, using one-backtick notation makes this false.\nUsing three-backtick notation makes it true if the enclosed content\ncontains at least one line break.

","example":"
// Display inline code in a small box\n// that retains the correct baseline.\n#show raw.where(block: false): box.with(\n  fill: luma(240),\n  inset: (x: 3pt, y: 0pt),\n  outset: (y: 3pt),\n  radius: 2pt,\n)\n\n// Display block code in a larger block\n// with more padding.\n#show raw.where(block: true): block.with(\n  fill: luma(240),\n  inset: 10pt,\n  radius: 4pt,\n)\n\nWith `rg`, you can search through your files quickly.\nThis example searches the current directory recursively\nfor the text `Hello World`:\n\n```bash\nrg "Hello World"\n```\n
\"Preview\"
","types":["bool"],"strings":[],"default":"false","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"lang","details":"

The language to syntax-highlight in.

\n

Apart from typical language tags known from Markdown, this supports the\n"typ", "typc", and "typm" tags for\nTypst markup,\nTypst code, and\nTypst math, respectively.

","example":"
```typ\nThis is *Typst!*\n```\n\nThis is ```typ also *Typst*```, but inline!\n
\"Preview\"
","types":["none","str"],"strings":[],"default":"none","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"align","details":"

The horizontal alignment that each line in a raw block should have.\nThis option is ignored if this is not a raw block (if specified\nblock: false or single backticks were used in markup mode).

\n

By default, this is set to start, meaning that raw text is\naligned towards the start of the text direction inside the block\nby default, regardless of the current context's alignment (allowing\nyou to center the raw block itself without centering the text inside\nit, for example).

","example":"
#set raw(align: center)\n\n```typc\nlet f(x) = x\ncode = "centered"\n```\n
\"Preview\"
","types":["alignment"],"strings":[],"default":"start","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"syntaxes","details":"

Additional syntax definitions to load. The syntax definitions should be\nin the sublime-syntax file format.

\n

You can pass any of the following values:

\n","example":"
#set raw(syntaxes: "SExpressions.sublime-syntax")\n\n```sexp\n(defun factorial (x)\n  (if (zerop x)\n    ; with a comment\n    1\n    (* x (factorial (- x 1)))))\n```\n
\"Preview\"
","types":["str","bytes","array"],"strings":[],"default":"()","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"theme","details":"

The theme to use for syntax highlighting. Themes should be in the\ntmTheme file format.

\n

You can pass any of the following values:

\n\n

Applying a theme only affects the color of specifically highlighted\ntext. It does not consider the theme's foreground and background\nproperties, so that you retain control over the color of raw text. You\ncan apply the foreground color yourself with the text function and\nthe background with a filled block. You could also use\nthe xml function to extract these properties from the theme.

","example":"
#set raw(theme: "halcyon.tmTheme")\n#show raw: it => block(\n  fill: rgb("#1d2433"),\n  inset: 8pt,\n  radius: 5pt,\n  text(fill: rgb("#a2aabc"), it)\n)\n\n```typ\n= Chapter 1\n#let hi = "Hello World"\n```\n
\"Preview\"
","types":["none","auto","str","bytes"],"strings":[],"default":"auto","positional":false,"named":true,"required":false,"variadic":false,"settable":true},{"name":"tab-size","details":"

The size for a tab stop in spaces. A tab is replaced with enough spaces to\nalign with the next multiple of the size.

","example":"
#set raw(tab-size: 8)\n```tsv\nYear\tMonth\tDay\n2000\t2\t3\n2001\t2\t1\n2002\t3\t10\n```\n
\"Preview\"
","types":["int"],"strings":[],"default":"2","positional":false,"named":true,"required":false,"variadic":false,"settable":true}],"returns":["content"],"scope":[{"path":["raw"],"name":"line","title":"Raw Text / Code Line","keywords":[],"oneliner":"A highlighted line of raw text.","element":true,"contextual":false,"deprecation":null,"details":"

A highlighted line of raw text.

\n

This is a helper element that is synthesized by raw elements.

\n

It allows you to access various properties of the line, such as the line\nnumber, the raw non-highlighted text, the highlighted text, and whether it\nis the first or last line of the raw block.

","example":null,"self":false,"params":[{"name":"number","details":"

The line number of the raw line inside of the raw block, starts at 1.

","example":null,"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"count","details":"

The total number of lines in the raw block.

","example":null,"types":["int"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"text","details":"

The line of raw text.

","example":null,"types":["str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"body","details":"

The highlighted raw text.

","example":null,"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[]}]}}}