Блоки кода

Вы можете писать фрагменты кода, блоки кода и другой текст моноширинным шрифтом с помощью стандартного форматирования Markdown. Zulip также поддерживает подсветку синтаксиса и позволяет настраивать пользовательские Интерактивные среды.

Вставить разметку кода

В окне ввода Zulip есть умная кнопка Код (), которая вставляет подходящую разметку в зависимости от контекста:

• Если текст не выделен, вставляется разметка блока кода (```).
• Если выделенный текст в одной строке, вставляется inline-разметка (`).
• Если выделенный текст в нескольких строках, вставляется разметка блока кода (```).

Примеры

Что вы вводите

Inline code span: `let x = 5`

Code block:
```
def f(x):
   return x+1
```

Syntax highlighting:
```python
def fib(n):
    # TODO: base case
    return fib(n-1) + fib(n-2)
```

Как это выглядит

Код Markdown

Тегирование языка

Если пометить блок кода языком, включается подсветка синтаксиса и (если настроено) Интерактивные среды. Zulip поддерживает подсветку синтаксиса для сотен языков.

Блок кода можно пометить, написав название языка после “забора” (```), который открывает блок кода. Автодополнение поможет ввести название. Полный список значений, поддерживающих подсветку, соответствует значениям Short names из документации лексеров Pygments.

``` python
print("Hello world!")
```

Язык по умолчанию для блоков кода

Администраторы организации могут настроить язык по умолчанию для блоков кода, который будет использоваться, если у блока кода нет тега.

Если язык по умолчанию настроен, можно использовать ```text чтобы показывать блоки кода без подсветки синтаксиса (например, при вставке текста ошибки).

Code playgrounds

Code playgrounds это интерактивные in-browser среды разработки, которые удобно использовать для редактирования и отладки кода. Их можно настроить для любого языка программирования. В блоках кода Zulip, помеченных языком, при наведении появляется кнопка, позволяющая открыть код на сайте playground.

Добавить пользовательский code playground

Например, чтобы настроить playground для Rust, можно указать Rust и st-lang.org/?code={code}.

Когда блок кода помечен как rust (явно или через язык по умолчанию в организации), у пользователей появится опция открыть этот блок кода в настроенном playground.

Примеры URL-шаблонов playground

Вот несколько URL-шаблонов для популярных языков:

• Java: scircles.cemc.uwaterloo.ca/java_visualize/#code={code}`
• JavaScript: script.html#code={code}
• Python: `
• C: `
• C++: `
• Rust: st-lang.org/?code={code}

Технические детали

• Можно настроить несколько playground для одного языка; тогда пользователь сможет выбрать, какой открыть.
• Поле Язык это “человекочитаемое” имя языка из Pygments. Тег языка в блоке кода сопоставляется с такими именами внутри Zulip; например, py3 и py сопоставляются с Python. Можно использовать автодополнение (появляется при вводе или клике по полю Language), чтобы найти имя Pygments.
• Ссылки для открытия playground всегда формируются подстановкой URL-encoded содержимого блока кода в переменную code в URL-шаблоне. URL-шаблон должен содержать ровно одну переменную с именем code.
• Playground-сайты не всегда четко документируют формат URL; иногда достаточно взять префикс из адресной строки браузера.
• Можно использовать пользовательское “имя языка” для простых интеграций. Например, блок кода с “языком” send_tweet можно связать с “playground”, который отправляет содержимое блока как твит.

Если возникнут сложности с настройкой code playground, напишите нам с деталями, и мы постараемся помочь.

Похожие статьи

• Форматирование сообщений
• LaTeX
• Спойлеры
• Цитировать или переслать сообщение