Разметка файлов .md
В книге проекта или на вики-страницах GitFlic есть возможность форматирования контента с помощью разметки Markdown.
Разметка обычного текста
**или__выделяет текст полужирным*или_выделяет текст курсивом<u></u>подчеркивает текст\*экранирует* символ перед собой~~перечеркивает тексттекст<sup> </sup>создаетнадстрочный индекс<sub> </sub>создаетподстрочный индекс
***___перед\после текста создает разделительную горизонтальную линию
Разметка контента
# Заголовки
Заголовки обозначаются с помощью символов #. Несколько символов подряд делают заголовок меньше – например, после заголовка # можно разместить подзаголовки ##, ### и т.д.
В качестве альтернативы может использоваться:
- строка вида ======== вместо #
- строка вида -------- вместо ##
Заголовок первого уровня
==========================
И заголовок второго уровня
--------------------------
{# Якорные ссылки }
Добавив в строку заголовка, справа, конструкцию {#имя_якоря}, в дальнейшем вы сможете создать ссылку именно на этот раздел страницы.
TOC - оглавление
[TOC] (Table of contents) формирует содержание документа на основе заголовков в документе. Вместо указателя создаются якорные ссылки по заголовкам в файле. Пример работы в начале статьи.
- Списки
Создать ненумерованный список можно с помощью символов -, + или * перед началом строки. Такие списки поддерживают табуляцию:
- Пункт 1при нажатии
- Пункт 2
+ Пункт 2.1
- Пункт 2.1.1
+ Пункт 3
- Пункт 1
- Пункт 2
+ Пункт 2.1
- Пункт 2.1.1
+ Пункт 3
Нумерованные списки выглядят следующим образом:
- Пункт 1
- Пункт 2
- Пункт 2.1
- Пункт 2.1.1
- Пункт 2.1
1. Пункт 1
2. Пункт 2
1. Пункт 2.1
1. Пункт 2.1.1
Создать список задач можно используются - [ ] для невыполненных и - [X] выполненных пунктов
- [x] задача 1
- [ ] задача 2
- [ ] задача 3
- [x] задача 1
- [ ] задача 2
- [ ] задача 3
> Цитирование
Добавить цитату или просто выделить текст можно с помощью символа > перед началом строки:
Человек бессмертен благодаря познанию.
> Человек бессмертен благодаря познанию.
| Таблицы |
Расположить содержимое в виде таблицы можно специальной структурой символов | и -.
Пример таблицы:
| Символ | Назначение |
|---|---|
| | | Разделение столбцов |
| - | Отделение строки заголовков |
|
Фрагменты кода
Однострочный фрагмент кода можно выделить с помощью одинарного ` или двойного ``.
Многострочный фрагмент с функцией быстрого копирования можно добавить, используя ```:
Этот многострочный фрагмент
Можно скопировать кнопкой
При необходимости можно указать язык программирования или дополнительные сведения:
``` Markdown
Ваш текст
```
Сноски
Для создание сноски нужно сделать метку после предложения к которому относится сноска, и метку перед текстом который будет в сноске
Простая сноска[^1].
их может быть несколько[^2].
[^1]: первая простая сноска
[^2]: Чтобы добавить переносы строк внутри сноски, добавьте 2 пробела в конец строки.
вот и вторая строка
Простая сноска1.
их может быть несколько2.
Изображения
Для того чтобы добавить изображение из проекта, можно использовать конструкцию:
Или изображение с внешнего источника:
Гиперссылки
Есть возможность добавления гиперссылок: - на внешний ресурс: GitFlic,
[GitFlic](https://gitflic.ru)
- на внутреннюю страницу: краткое руководство
[краткое руководство](../../common/guide)
- на отмеченный раздел внутренней страницы: якорные ссылки
[якорные ссылки](../markdown#anchor)