| icon | tags | |
|---|---|---|
file-code |
|
Фрагмент кода позволяет вам включать содержимое другого текстового файла или его часть в блок кода на другой странице.
https://softonit.ru/FAQ/courses/?COURSE_ID=1&LESSON_ID=911
Синтаксис для компонента "Сниппеты кода" выглядит следующим образом:
``` :::code source="<путь-к-файлу>" ::: ```
В следующем примере мы ссылаемся на локальный файл ../static/sample.js и выводим первые две строки из файла.
+++ Демо ``` :::code source="../static/sample.js" range="1-2" ::: ``` +++ Исходный код ``` :::code source="../static/sample.js" range="1-2" ::: ```
source - это локальный путь к файлу.
:::code source="<путь-к-файлу>" :::
Обычно файл source должен находиться внутри того же репозитория. По крайней мере, файл должен быть доступен во время сборки проекта Retype. Если вы собираетесь локально, source может находиться в любом месте, доступном в локальной файловой системе. Однако, если вы используете действие GitHub Retype, файл должен находиться в том же репо или быть доступным для действия.
В следующем демонстрационном примере мы ссылаемся на файл sample.js и включаем весь его контент в блок кода:
+++ Демо :::code source="../static/sample.js" ::: +++ Источник
:::code source="../static/sample.js" :::
+++
Может быть настроен range - диапазон строк для включения из файла source, вместо включения всего содержимого файла. Если range не настроен, будет включено всё содержимое файла.
:::code source="<путь-к-файлу>" range="<диапазон>" :::
range принимает список номеров строк, разделенных запятыми, или диапазон, разделенный тире, например, 2-24, чтобы включить только строки с #2 по #24 из файла.
range="2" // Одна строка
range="2-24" // Диапазон строк
range="2,12-24,26" // Сочетание диапазонов
В следующем демонстрационном примере мы ссылаемся на файл sample.js и включаем первые две строки этого файла в блок кода.
+++ Демо :::code source="../static/sample.js" range="1-2" ::: +++ Источник
:::code source="../static/sample.js" range="1-2" :::
+++
Если код из блока range имеет отступ, то левый отступ будет удален из вывода файла, чтобы блок кода был выровнен слева.
Может быть указан необязательный title.
:::code language="<язык-ссылка>" title="<заголовок>" :::
Добавим title к нашему Сниппету кода ../static/sample.js. Внутри файла .md конфигурация будет выглядеть следующим образом...
+++ Демо :::code source="../static/sample.js" range="1-2" title="../static/sample.js" ::: +++ Источник
:::code source="../static/sample.js" range="1-2" title="../static/sample.js" :::
+++
В последних блоках кода можно настроить тип языка, что позволяет подсветку синтаксиса кода внутри блока кода.
Свойство language может быть установлено с помощью любого значимого языка, поддерживаемого блоками кода в Retype.
:::code source="<путь-к-файлу>" language="<язык>" :::
По умолчанию Retype попытается определить language на основе расширения файла source и автоматически установит свойство language. Например, если файл source - это файл JavaScript .js, Retype установит language Сниппета кода в js.
Если свойство language установлено явно, Retype будет использовать это значение. Если Retype не может определить language, не будет установлена ссылка на язык, и блок кода будет отображаться без подсветки синтаксиса.
Для файлов C# с расширением .cs можно настроить необязательное имя region вместо range, которое создаст копию всех строк между именованными директивами #region и #endregion. Строки, содержащие директивы #region и #endregion, не должны быть включены в новый блок кода.
:::code source="<путь-к-файлу>" region="<имя-региона>" :::
Это пример Markdown-разметки для вашего текста, который объясняет использование `language