Оформление README файла репозитория на github
Приветствую, это полный гайд по оформлению REAMDE файла репозитория на github.
Начнём с самого простого, и закончим понастоящему класными решениями.
Начнём с некоторой теории. README.md файл может принимать html и markdown разметку сразу.
Приступим.
Заголовки
Для создания заголовка нужно поставить знак # и через пробел написать название заголовка. Чем больше вы используете #, тем меньше будет заголовок. Это можно использовать как подзаголовки.
# О проекте
## Что из себя представляет проект
какой-то текст
## Философия
какой-то текст
Стили текста
Для придачи стиля стексту, текст нужно занести либо в блок html, либо добавить слева и справа особые символы.
**жирный**
_курсив_
~~зачёркнутый~~
<sub>подпись</sub>2
<sup>супер подпись</sup>2
<ins>подчёркнутый</ins>
Цитирование
Цитирование делится на цитирование кода и текста.
Для цитирования текста, нужно поставить перед ним >
Цитирование текста -
> цитата
Для цитирования кода нужно перед кодом и после кода поставить ```
```
print("Hello world")
```
Цитирование через табуляцию
Добавив табуляцию перед текстом, вы вынесите его в отдельный блок
табуляция
Работает так же как и при цитировании кода.
Списки
Списки делятся на нумерованные и без номера. Кроме того они могут иметь подсписки. Для создания подсписка нужно сделать табуляцию.
для создания списков сделайте следующие конструкции -
# Нумерованные
1. Что-то
1. элемент подсписка
2. элемент подсписка
2. Что-то
1. элемент подсписка
2. элемент подсписка
# Не нумерованные
- Что-то
- элемент подсписка
- элемент подсписка
- Что-то
- элемент подсписка
- элемент подсписка
В подсписках нумерация будет ломаться, так что лучше ей не пользоваться.
Ссылки
Вы можете сделать кликабельный текст. Для этого вам нужно сделать следующую конструкцию.
[Текст](ссылка)
если вместо ссылки вы впишите # и название заголовка, то текст будет переводить вас на конкретный заголовок.
[About](#about)
если есть пробелы, нужно заменить их на -
Задачи
для создания задачи сделайте подобную конструкцию
- [ ] задача не выполненная
- [x] задача выполненная
Оповерщения
Последнее о чём я хочу вам рассказать - это оповещения.
Типы оповещений
[!NOTE]
[!TIP]
[!IMPORTANT]
[!WARNING]
[!CAUTION]
По началу идут самые незначительные, а ниже, соответственно более значимые.
Делаются они вот так -
> [!NOTE]
> малополезно
> [!TIP]
> Полезно
> [!IMPORTANT]
> Важно
> [!WARNING]
> Предупреждение
> [!CAUTION]
> Осторожно
Надеюсь, вам был полезен этот пост. Пишите своё мнение на счёт этого, если есть вопросы, постараюсь ответить.
Есть ещё телеграмм канал, можете там же спросить что-то. Посчу туда всякое.
Информацию я брал с этой англоязычной документации гитхаб.
















