Шпаргалка по работе с Markdown в Gitlab

Я использую в своей повседневной работе Gitlab и иногда приходится оформлять документацию или README с использованием синтаксиса Markdown. Для тех, кто не знает, что это такое, я приведу цитату из Википедии:

Определение Markdown из Википедии:

Markdown — облегчённый язык разметки, созданный с целью написания наиболее читаемого и удобного для правки текста, но пригодного для преобразования в языки для продвинутых публикаций (HTML, Rich Text и других).

Собственно, сам язык разметки это простой текст с некоторыми символами, вроде # или *. Решил сделать небольшую шпаргалку по элементам синтаксиса, чтобы не гуглить, если что-то забыл.

Заголовки

# Это заголовок с тегом <h1>
## Это заголовок с тегом <h2>
###### Это заголовок с тегом <h6>

Это заголовок с тегом <h1>

Это заголовок с тегом <h2>

Это заголовок с тегом <h6>

Выделение текста

*Это наклонный текст*
_Это также наклонный текст_
**Этот текст будет выделен жирным**
__Этот текст также будет выделен жирным__
*Можно **комбинировать** этот синтаксис*


Это наклонный текст
Это также наклонный текст


Этот текст будет выделен жирным
Этот текст также будет выделен жирным


Можно комбинировать этот синтаксис

Цитаты

Одна из цитат физика Ричарда Фейнмана:

> Ты все время говоришь себе: «Я могу это 
> сделать, но не буду», — но это не более
> чем другой способ сказать, что ты не
> можешь.

Одна из цитат физика Ричарда Фейнмана:

Ты все время говоришь себе: «Я могу это сделать, но не буду», — но это не более чем другой способ сказать, что ты не можешь.

Списки

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

* Пункт 1
* Пункт 2
* Пункт 2a
* Пункт 2b

Упорядоченный

1. Пункт 1
2. Пункт 2
* Пункт 2a
* Пункт 2b


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

  • Пункт 1
  • Пункт 2
    • Пункт 2a
    • Пункт 2b

Упорядоченный

  1. Пункт 1
  2. Пункт 2
    • Пункт 2a
    • Пункт 2b

Изображения

![Gitlab logo](https://upload.wikimedia.org/wikipedia/commons/thumb/1/18/GitLab_Logo.svg/1200px-GitLab_Logo.svg.png)
Формат: ![alt text](url)
gitlab logo markdown

Ссылки

[Gitlab](https://about.gitlab.com)

Обратный слэш

Markdown позволяет использовать обратный слэш для добавления символов, которые используются для форматирования в Markdown.

\*текст между двух звездочками\*


*текст между двух звездочек*

Обратный слэш используется для печати следующих символов: \ ` * _ [] {} () # + – . !

Markdown, специфичный для Gitlab

Упоминание пользователя

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

Emoji

Конечно, есть поддержка эмодзи. Использовать эту функцию просто:

:+1: :camel: :cactus: :rocket: :unicorn: 
Эмодзи в gitlab с использованием markdown

Блоки кода

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

```javascript
function sum (arr) {
return arr.reduce(function(a,b) {
return a + b
}, 0)
}
module.exports.sum = sum
```
function sum (arr) {     
    return arr.reduce(function(a,b) {
    return a + b
  }, 0)
} 
module.exports.sum = sum

Список задач

- [x] выполненная задача
- [ ] не выполненная задача
- [x] есть поддержка **форматирования**, [ссылок]() и <del>тега</del>
- [x] также поддерживаются списки
Список задач в gitlab с помощью markdown

Ссылки на созданный запрос

Любое число, которое указывает на Issue или Pull Request будет автоматически преобразовано в ссылку, например #3, будет ссылкой на issue номер 3.

Таблицы

Формировать таблицы с помощью Markdown в Gitlab также довольно просто, вот простейший пример таблицы:

 Первый столбец | Второй столбец 
----------------|------------------
Содержимое ячейки 1 | Содержимое ячейки 2
Содержимое ячейки 3 | Содержимое ячейки 4

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *