README.md — обязательный элемент любого Git‑репозитория.
Да, современные нейросети отлично справляются с генерацией документации в Markdown, но базовый синтаксис всё же стоит держать в голове. Это как таблица умножения, основа, без которой некомфортно.
В 2004 году, Джон Грубер и Аарон Свартц придумали Markdown. Название не случайно:
markup — это «полноценная» разметка (как в HTML или XML);
markdown — «упрощённая разметка», лёгкая и интуитивная.
Markdown создан, чтобы быть простым. Ниже — краткая шпаргалка с примерами.
Уровни заголовков:
# Уровень 1
## Уровень 2
### Уровень 3
Цитата:
> blockquote
Нумерованный список:
1. First item
2. Second item
3. Third item
Код:
`code`
Горизонтальная линия:
---
Ссылка:
[Markdown Guide](https://www.markdownguide.org)
Изображение:
или
Можно еще здесь скачать полный текст шпаргалки.
#linux #markdown #gitops #git