# Пользовательские макрокоды Hugo LLMS index: [llms.txt](/llms.txt) --- На этой странице объясняются пользовательские макрокоды Hugo, которые можно использовать в Markdown-файлах документации Kubernetes. Узнать подробнее про макрокоды можно в [документации Hugo](https://gohugo.io/content-management/shortcodes). ## Состояние функциональности В Markdown странице (файл с расширением `.md`) вы можете добавить макрокод, чтобы отобразить версию и состояние документированной функциональной возможности. ### Демонстрация состояния функциональности Ниже показан фрагмент кода для вывода состояния функциональности, который сообщает о функциональности в стабильной версии Kubernetes 1.10. ``` {{< feature-state for_k8s_version="v1.10" state="stable" >}} ``` Результат:

СТАТУС ФИЧИ: Kubernetes v1.10 [stable]

Допустимые значения для `state`: * alpha * beta * deprecated * stable ### Код состояния функциональности По умолчанию отображается версия Kubernetes, соответствующая версии страницы или сайта. Это значение можно переопределить, передав параметр макрокода for_k8s_version. ``` {{< feature-state for_k8s_version="v1.10" state="stable" >}} ``` Результат:

СТАТУС ФИЧИ: Kubernetes v1.10 [stable]

#### Функциональность в альфа-версии ``` {{< feature-state state="alpha" >}} ``` Результат:

СТАТУС ФИЧИ: Kubernetes v1.36 [alpha]

#### Функциональность в бета-версии ``` {{< feature-state state="beta" >}} ``` Результат:

СТАТУС ФИЧИ: Kubernetes v1.36 [beta]

#### Функциональность в стабильной версии ``` {{< feature-state state="stable" >}} ``` Результат:

СТАТУС ФИЧИ: Kubernetes v1.36 [stable]

#### Устаревшая функциональность ``` {{< feature-state state="deprecated" >}} ``` Результат:

СТАТУС ФИЧИ: Kubernetes v1.36 [deprecated]

## Глоссарий Вы можете сослаться на термины из [глоссария](/docs/reference/glossary/) в виде всплывающей (при наведении мыши) подсказки, что удобно при чтении документации через интернет. Исходные файлы терминов глоссария хранятся в отдельной директории по URL-адресу [https://github.com/kubernetes/website/tree/master/content/en/docs/reference/glossary](https://github.com/kubernetes/website/tree/master/content/en/docs/reference/glossary). ### Демонстрация глоссария Например, следующий фрагмент кода в Markdown будет отображен в виде всплывающей подсказки — : ```liquid {{< glossary_tooltip text="cluster" term_id="cluster" >}} ``` ## Заголовки таблиц Для улучшения доступности таблиц для программ для чтения с экрана, добавьте заголовок к таблице. Чтобы добавить [заголовок](https://www.w3schools.com/tags/tag_caption.asp) таблицы, поместите таблицу в макрокод `table` и определите значение заголовка в параметре` caption`.

Примечание:

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

Пример: ```go-html-template {{< table caption="Конфигурационные параметры" >}} Параметр | Описание | Значение по умолчанию :---------|:------------|:------- `timeout` | Тайм-аут для запросов | `30s` `logLevel` | Уровень логирования | `INFO` {{< /table >}} ``` Результат: {{< table caption="Конфигурационные параметры" >}} Параметр | Описание | Значение по умолчанию :---------|:------------|:------- `timeout` | Тайм-аут для запросов | `30s` `logLevel` | Уровень логирования | `INFO` {{< /table >}} Если вы изучите HTML-код таблицы, вы заметите следующий ниже элемент сразу после открывающего элемента ``: ```html ``` ## Вкладки Страница в формате Markdown (файл с расширением `.md`) на этом сайте может содержать набор вкладок для отображения нескольких разновидностей определённого решения. Макрокод `tabs` принимает следующие параметры: * `name`: имя, отображаемое на вкладке. * `codelang`: если вы указываете встроенный контент для макрокода `tab`, вы можете сообщить Hugo, какой язык использовать для подсветки синтаксиса. * `include`: включаемый файл в вкладку. Если вкладка находится в [узле пакета (leaf bundle)](https://gohugo.io/content-management/page-bundles/#leaf-bundles) Hugo, то файл (может быть любым MIME-типом, который поддерживает Hugo) ищется в самом пакете. Если нет, то включаемое содержимое ищется относительно текущей страницы. Обратите внимание, что при использовании `include` вам следует использовать самозакрывающийся синтаксис. Например, {{}}. Язык может быть указан в `codelang`, в противном случае язык определяется из имени файла. * Если содержимое вкладки это Markdown, вам нужно использовать символ `%`. Например, `{{% tab name="Вкладка 1" %}}This is **markdown**{{% /tab %}}` * Вы можете совместно использовать перечисленные выше параметры. Ниже приведена демонстрация шорткода вкладок. Ниже приведены примеры вкладок.

Примечание:

Имя вкладки в элементе tabs должно быть уникальным на странице.

### Демонстрация вкладок: подсветка синтаксиса в блоках кода ```go-text-template {{< tabs name="tab_with_code" >}} {{{< tab name="Вкладка 1" codelang="bash" >}} echo "Это вкладка 1." {{< /tab >}} {{< tab name="Вкладка 2" codelang="go" >}} println "Это вкладка 2." {{< /tab >}}} {{< /tabs >}} ``` Результат:

Вкладка 1
Вкладка 2


echo "Это вкладка 1."


println "Это вкладка 2."

### Демонстрация вкладок: встроенный Markdown и HTML ```go-html-template {{< tabs name="tab_with_md" >}} {{% tab name="Markdown" %}} Это **разметка Markdown.** {{< note >}} Также можно использовать макрокоды. {{< /note >}} {{% /tab %}} {{< tab name="HTML" >}}

Обычный HTML

Это обычный HTML.

{{< /tab >}} {{< /tabs >}} ``` Результат:

Markdown
HTML

Это разметка Markdown.

Примечание:

Также можно использовать макрокоды.

Обычный HTML

Это обычный HTML.

### Демонстрация вкладок: включение файлов ```go-text-template {{< tabs name="tab_with_file_include" >}} {{< tab name="Content File #1" include="example1" />}} {{< tab name="Content File #2" include="example2" />}} {{< tab name="JSON File" include="podtemplate" />}} {{< /tabs >}} ``` Результат:

Это пример содержимого в файле внутри пакета узла includes.

Примечание:

Подключаемые файлы также могут содержать макрокоды.

Это другой пример содержимого в файле внутри пакета узла includes.

  {
    "apiVersion": "v1",
    "kind": "PodTemplate",
    "metadata": {
      "name": "nginx"
    },
    "template": {
      "metadata": {
        "labels": {
          "name": "nginx"
        },
        "generateName": "nginx-"
      },
      "spec": {
         "containers": [{
           "name": "nginx",
           "image": "dockerfile/nginx",
           "ports": [{"containerPort": 80}]
         }]
      }
    }
  }

## Что дальше * Подробнее про [Hugo](https://gohugo.io/). * Подробнее про [написание новой темы](/ru/docs/contribute/style/write-new-topic/). * Подробнее про [использование шаблонов страниц](/ru/docs/contribute/style/page-templates/). * Подробнее про [создание пулреквеста](/ru/docs/contribute/start/#отправка-пулреквеста).