Базовый синтаксис записи и форматирования в GitHub Enterprise Server 37 Docs

Базовый синтаксис записи и форматирования в GitHub Enterprise Server 37 Docs
На чтение
28 мин.
Просмотров
22
Дата обновления
27.02.2025
#COURSE##INNER#

GitHub Enterprise Server 37 Docs позволяет пользователям создавать и редактировать содержимое с использованием простого и интуитивно понятного синтаксиса разметки. Этот базовый синтаксис позволяет вам форматировать текст, вставлять ссылки, изображения и другие элементы для создания более сложных документов.

Синтаксис GItHub Enterprise Server 37 Docs основан на Markdown, который является легким и удобочитаемым языком разметки. Он позволяет вам быстро создавать структурированные документы, обеспечивая при этом простоту и понятность кода. Вам даже не нужно знать HTML или CSS, чтобы использовать его.

Чтобы сделать текст жирным, вы можете использовать тег или для курсива. Чтобы создать список, просто используйте тире или числа перед каждым элементом. Если вам нужно вставить ссылку, используйте обычный синтаксис [текст ссылки](URL). Если вы хотите цитировать кусок текста, вы можете использовать тег

.

Базовый синтаксис GitHub Enterprise Server 3.7 Docs

В этом разделе мы рассмотрим базовый синтаксис записи и форматирования текста в документации GitHub Enterprise Server 3.7 Docs.

  • Выделение текста жирным шрифтом: используйте две звездочки или два подчеркивания вокруг текста (*жирный* или __жирный__).
  • Выделение текста курсивом: используйте одну звездочку или одно подчеркивание вокруг текста (_курсив_ или *курсив*).
  • Создание ссылок: используйте квадратные скобки для текста ссылки, а затем круглые скобки с URL ссылки ([текст ссылки](URL)).
  • Вставка кода: используйте символы обратных кавычек (\`) перед и после кода (`вставка кода`).
  • Списки: используйте теги
      ,
        и
      1. для создания маркированных и нумерованных списков.

    Это лишь некоторые из основных возможностей синтаксиса GitHub Enterprise Server 3.7 Docs. Вы можете ознакомиться с полным списком возможностей в документации.

    Используя эти инструменты, вы сможете создавать красиво оформленную и легко читаемую документацию в GitHub Enterprise Server 3.7 Docs.

    Теги в GitHub

    В GitHub есть несколько основных тегов, которые можно использовать при форматировании и оформлении текста. Вот некоторые из них:

    Тег Описание Пример использования

    Определяет абзац текста.

    Это абзац текста.

    Используется для отображения кода или команд. git clone https://github.com/repository.git
    Выделяет текст в курсиве. Этот текст выделен курсивом.
    Выделяет текст жирным шрифтом. Этот текст выделен жирным шрифтом.
    Создает ссылку на другую страницу или ресурс. Ссылка

    Это только некоторые из тегов, которые можно использовать в GitHub. Вы можете использовать их для структурирования, форматирования и оформления текста в ваших документах.

    Создание заголовков

    В GitHub Enterprise Server 3.7 Docs использование заголовков помогает организовать информацию и сделать текст более структурированным.

    Для создания заголовка в HTML используется тег

    до
    . Чем меньше число после "h", тем меньше будет размер заголовка. Например,

    создаст самый большой заголовок, а
    - самый маленький.

    Пример:

    Это заголовок первого уровня

    Это заголовок второго уровня

    Это заголовок третьего уровня

    Это заголовок четвертого уровня

    Это заголовок пятого уровня
    Это заголовок шестого уровня

    Эти теги не только устанавливают размер заголовка, но также автоматически создают отступы сверху и снизу текста, чтобы выделить его.

    Форматирование текста

    GitHub Enterprise Server 37 Docs позволяет форматировать текст в комментариях, проблемах, запросах на получение данных и других местах с помощью простого синтаксиса.

    Жирный текст

    Вы можете сделать текст жирным, обернув его в двойные звездочки или два нижних подчеркивания: **текст** или __текст__.

    Курсивный текст

    Для выделения текста курсивом используйте одиночные звездочки или одно нижнее подчеркивание: *текст* или _текст_.

    Жирный и курсивный текст

    Если вы хотите сделать текст жирным и курсивным, можно использовать тройные звездочки или три нижних подчеркивания: ***текст*** или ___текст___.

    Зачеркнутый текст

    Для создания зачеркнутого текста нужно использовать две тильды: ~~текст~~.

    Текст с ссылкой

    Чтобы создать текст с ссылкой, используйте квадратные скобки для обозначения текста, который должен отображаться, и круглые скобки для указания URL-адреса, на который должна вести ссылка: [текст ссылки](URL).

    Пример:

    [GitHub](https://github.com)

    Списки

    Список элементов можно создать, начав каждую строку с звездочки (*) или дефиса (-):

    - пункт 1

    - пункт 2

    - пункт 3

    или

    * пункт 1

    * пункт 2

    * пункт 3

    Вложенные элементы списка можно создавать с помощью отступов:

    * пункт 1

    * вложенный пункт 1.1

    * вложенный пункт 1.2

    * пункт 2

    * пункт 3

    или

    - пункт 1

    - вложенный пункт 1.1

    - вложенный пункт 1.2

    - пункт 2

    - пункт 3

    Это основные элементы форматирования текста в GitHub Enterprise Server 37 Docs. Используйте их, чтобы делать текст более понятным и выразительным.

    Разметка содержимого

    В GitHub Enterprise Server 37 Docs вы можете использовать различные теги HTML, чтобы структурировать и форматировать ваше содержимое:

    • Заголовки (h1, h2, h3, и т.д.) используются для обозначения различных уровней заголовков в документе.
    • Абзацы (p) используются для разделения текста на отдельные абзацы.
    • Списки могут быть неупорядоченными (ul) или упорядоченными (ol) и используются для представления элементов в виде списка.
    • Элементы списка (li) используются для каждого отдельного элемента в списке.
    • Ссылки (a) используются для создания гиперссылок на другие страницы или ресурсы.
    • Изображения (img) используются для вставки изображений в документ.

    При использовании этих тегов и других HTML-элементов вы можете создавать содержимое с четкой структурой и ясным форматированием, чтобы сделать его более удобным для чтения и понимания.

    Знание базовой разметки HTML позволяет легко создавать и форматировать содержимое в GitHub Enterprise Server 37 Docs, и сделать его более интерактивным и привлекательным для вашей аудитории.

    Ссылки и изображения

    В GitHub Enterprise Server 37 Docs есть несколько способов добавить ссылки и изображения к вашим документам.

    Для добавления ссылок вы можете использовать следующий синтаксис:

    • Встроенная ссылка: [Текст ссылки](URL-адрес)
    • Ссылка на изображение: ![Альтернативный текст](URL-изображения)

    Примеры:

    • [GitHub](https://github.com) - ссылка на GitHub
    • ![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png) - изображение логотипа GitHub

    Вы также можете добавлять ссылки и изображения с использованием HTML-тегов:

    Примеры:

    • GitHub - ссылка на GitHub
    • GitHub Logo - изображение логотипа GitHub

    Используйте ссылки и изображения, чтобы делиться информацией и улучшать читабельность ваших документов в GitHub Enterprise Server 37 Docs.

    Списки и таблицы

    Списки

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

    Неупорядоченные списки

    Для создания неупорядоченных списков используется тег