Базовый синтаксис записи и форматирования – Руководство пользователя GitHub Enterprise Server 39 Документация

В данной статье рассматривается базовый синтаксис записи и форматирования текста в GitHub Enterprise Server 39. GitHub Enterprise Server 39 предоставляет расширенные возможности для ведения проектов и совместной работы над кодом. Документация поможет вам разобраться, как правильно оформлять тексты и как использовать различные теги для стилизации контента.

GitHub Flavored Markdown (GFM) — это разновидность языка разметки Markdown, который используется на GitHub. Он предоставляет дополнительные возможности и расширенный синтаксис, позволяющий более гибко форматировать текст и вставлять элементы интерфейса GitHub, такие как ссылки на коммиты или задачи в блоках кода или в списках.

GitHub Flavored Markdown (GFM) позволяет вам облагородить текстовые файлы с минимальным числом усилий. Он прост в изучении и использовании, позволяет контролировать визуальное отображение документов и облегчает чтение и взаимодействие с ними. Подробную информацию о GFM вы найдете в документации.

Научиться использовать основные возможности форматирования и разметки текста поможет вам более эффективно организовать работу над проектами и улучшит взаимодействие с коллегами разработчиками.

Основы форматирования

GitHub позволяет форматировать тексты и комментарии, добавлять заголовки, списки и многое другое. Некоторые основные инструменты форматирования включают:

• Жирный: для выделения текста в жирный можно использовать двойные звездочки или двойное подчеркивание. Например, **жирный текст** или __жирный текст__.
• Курсив: для выделения текста курсивом можно использовать одиночные звездочки или одиночное подчеркивание. Например, *курсивный текст* или _курсивный текст_.
• Код: для отображения кода можно использовать обратные кавычки. Например, `console.log(‘Привет, мир!’);`
• Ссылки: для создания ссылок на другие страницы или внутренние якоря можно использовать тег <a>. Например, <a href="https://github.com">Ссылка</a>.
• Зачеркнутый текст: для зачеркивания текста можно использовать тег <del>. Например, <del>зачеркнутый текст</del>.

Это лишь некоторые из возможностей форматирования текста в GitHub. Данные инструменты помогают сделать ваш код и комментарии более читаемыми и понятными для других пользователей.

Теги и их применение

Некоторые основные теги и их применение:

• <h1> – <h6>: Эти теги используются для создания заголовков разного уровня. <h1> обычно используется для наиболее важных заголовков, а уровень заголовка увеличивается по мере увеличения номера тега (<h2> – для второго уровня, <h3> – для третьего и т.д.).
• <p>: Тег <p> используется для обозначения абзаца текста. Все текстовые данные, заключенные в этот тег, будут отображаться в виде абзацев.
• <ul>: Тег <ul> используется для создания неупорядоченного списка, где каждый элемент списка обозначается тегом <li>. Этот тег используется, когда порядок элементов не имеет значения.
• <ol>: Тег <ol> используется для создания упорядоченного списка, где каждый элемент списка обозначается тегом <li>. Этот тег используется, когда порядок элементов имеет значение.
• <li>: Тег <li> используется для обозначения элемента списка внутри тегов <ul> или <ol>.

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

Примеры форматирования

Используя GitHub Flavored Markdown, вы можете форматировать тексты и размечать их в вашем репозитории на GitHub. Вот некоторые примеры о том, как вы можете применить различные стили и форматы в ваших документах:

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

Стилизация текста

GitHub Enterprise Server 39 позволяет стилизировать текст с помощью различных тегов HTML.

Вот некоторые из наиболее распространенных тегов для стилизации текста:

• <b>: делает текст жирным
• <i>: делает текст курсивом
• <u>: подчеркивает текст
• <s>: зачеркивает текст

Кроме того, вы можете использовать различные комбинации этих тегов для создания более сложных стилей. Например, <b><u> сделает текст жирным и подчеркнутым.

Вы также можете изменять размер текста, используя теги <h1>, <h2>, <h3> и так далее. Ниже приведен пример:

<h1>Это заголовок первого уровня</h1>
<h2>Это заголовок второго уровня</h2>
<h3>Это заголовок третьего уровня</h3>

Для создания нумерованного или маркированного списка вы можете использовать теги <ol> и <ul>. Каждый элемент списка может быть отформатирован с помощью тега <li>. Вот примеры:

<ul>
<li>Пункт списка 1</li>
<li>Пункт списка 2</li>
<li>Пункт списка 3</li>
</ul>
<ol>
<li>Пункт списка 1</li>
<li>Пункт списка 2</li>
<li>Пункт списка 3</li>
</ol>

Это лишь некоторые из возможностей стилизации текста в GitHub Enterprise Server 39. Вы можете экспериментировать с различными тегами и их комбинациями, чтобы создавать уникальные стили для вашего текста.

Команды форматирования

Для форматирования текста в документации GitHub Enterprise Server 39 используются различные команды. В этом разделе мы рассмотрим основные из них.

Команда	Описание	Пример
*текст*	Выделение текста жирным шрифтом	Пример текста
_текст_	Выделение текста курсивом	Пример текста
`текст`	Выделение текста моноширинным шрифтом	Пример текста
[текст](URL)	Вставка ссылки	Пример ссылки
	Вставка изображения

Помимо этих команд, можно использовать и другие, такие как команда для создания списков, команда для вставки цитат и т.д. Более подробную информацию вы можете найти в официальной документации GitHub Enterprise Server 39.

Заголовки

Пример использования:

<h1>Это заголовок первого уровня</h1>
<h2>Это заголовок второго уровня</h2>
<h3>Это заголовок третьего уровня</h3>
<h4>Это заголовок четвертого уровня</h4>
<h5>Это заголовок пятого уровня</h5>
<h6>Это заголовок шестого уровня</h6>

Заголовки также могут быть стилизованы при помощи CSS, чтобы соответствовать дизайну вашего сайта.

Рекомендуется использовать заголовки в правильном порядке – начиная с заголовка первого уровня, затем второго и так далее. Важно помнить, что заголовок первого уровня может использоваться только один раз на странице.

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

Списки

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

Неупорядоченный список представляет собой список, в котором элементы не имеют порядкового номера или буллитов перед ними. Для создания неупорядоченного списка используется тег <ul>. Каждый элемент списка должен быть обернут в тег <li>.

Пример:

<ul>
<li>Первый элемент</li>
<li>Второй элемент</li>
<li>Третий элемент</li>
</ul>

Упорядоченный список

Упорядоченный список представляет собой список, в котором каждый элемент имеет порядковый номер перед ним. Для создания упорядоченного списка используется тег <ol>. Каждый элемент списка также должен быть обернут в тег <li>.

Пример:

<ol>
<li>Первый элемент</li>
<li>Второй элемент</li>
<li>Третий элемент</li>
</ol>

Иногда упорядоченные списки, вместо стандартных порядковых номеров, могут использовать другие символы или римские цифры. Это можно установить с помощью атрибута type для тега <ol>.

Пример с использованием типа “a” (символы латинского алфавита):

<ol type="a">
<li>Первый элемент</li>
<li>Второй элемент</li>
<li>Третий элемент</li>
</ol>

Теги <ul> и <ol> могут быть вложенными, то есть содержать другие списки внутри себя.

Список определений

Список определений представляет собой список, состоящий из терминов и их определений. Каждый термин обертывается в тег <dt>, а его определение – в тег <dd>.

Пример:

<dl>
<dt>Термин 1</dt>
<dd>Определение 1</dd>
<dt>Термин 2</dt>
<dd>Определение 2</dd>
<dt>Термин 3</dt>
<dd>Определение 3</dd>
</dl>

Теги <dl>, <dt> и <dd> могут содержать другие теги и элементы HTML, чтобы форматировать текст или добавить ссылки и изображения.

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