Code fragments

A code fragment can be added to the text or placed in a separate block.

In text

To add a code fragment to the text, use the ` character.

`Фрагмент кода` в тексте.

Result:

Code fragment in text.

If the text contains double curly braces but does not imply variable substitution, add not_var before the construct.

The prefix not_var works only for code fragments consisting of characters .-|(),_, a-z, A-Z, 0-9 and spaces.

As a separate block

To format a code fragment as a separate block, separate it from the rest of the text on both sides with ``` characters.

For syntax highlighting, specify the language in which the code is written in the opening line. For example:

```sql
  price= '2000'
  size= '24'  
  color= 'primary'
  variant= 'detailed' 
```

You can find the full list of available languages in GitHub.

Including code from a file

Use the {% code %} directive to include a local file as a code block:

{% code "./examples/main.ts" lang="typescript" %}

A path without a leading / is resolved relative to the Markdown file containing the directive. A path with a leading / is resolved relative to the documentation input root. The lang parameter sets the code block language for syntax highlighting. Without this parameter, the block language is empty.

By default, the common indentation is removed from all non-empty lines. Add keep-indents to preserve the original indentation:

{% code "./examples/main.ts" keep-indents %}

Use the lines parameter to include part of a file by providing two substring markers separated by -. The lines containing the markers are excluded:

{% code "./examples/main.ts" lines="[BEGIN example]-[END example]" %}

If the start or end marker is missing, the CLI emits a warning and uses the beginning or end of the file, respectively. If the end marker occurs before the start marker, the CLI emits a warning and creates an empty code block.

The directive reads only local files inside the documentation input directory. External HTTP and Git sources, automatic named-region selection, and jsonpath are not processed by the OSS CLI. A missing file or a path outside the input directory causes a build error.

Displaying line numbers

If you need to enable line numbers in a code block, use the keyword showLineNumbers.

Usage example:

```sql showLineNumbers
  price = '2000'
  size = '24'  
  color = 'primary'
  variant = 'detailed' 
```

Result:

1  price = '2000'
2  size = '24'
3  color = 'primary'
4  variant = 'detailed'

Line wrapping by default

To enable soft wrap by default in a code block, use the keyword wrap.

Usage example:

``` wrap
Очень длинная строка в блоке кода, которая точно не поместится в длину, если её искусственно не свернуть
```

Result:

Очень длинная строка в блоке кода, которая точно не поместится в длину, если её искусственно не свернуть

Command line prefix

Use the parameter prompt="<value>" to exclude the command line prefix ($, #, >>>, mysql>, etc.) from selection and copying via the widget.

Usage example:

```bash prompt="$"
$ npm install
$ npm run build
```

Result:

$ npm install
$ npm run build