Skip to content

Voold/README

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 

Repository files navigation

Оформление README.md

Запомни, чтобы не забыть


  1. Оформление заголовков
# H1 — заголовок первого уровня, самый большой
## H2 — заголовок второго уровня, поменьше
### H3
#### H4
##### H5
###### H6 — заголовок шестого уровня, самый маленький 

  1. Создание черты
#### Заголовок 4

Текст над чертой

---

Текст под чертой

  1. Перенос строк
Текст до переноса⋅⋅  
Текст после переноса <br>
Текст после второго переноса

Чтобы начать новый параграф, в конце предыдущей строки должно стоять два символа переноса. Для этого нужно нажать Enter два раза.


  1. Выделение текста
Курсив — это *звёздочки* или _подчёркивания_.
Полужирный шрифт — двойные **звёздочки** или двойные __подчёркивания__.
Можно совместить выделение **звёздочки и _подчёркивания_**.
~~Зачёркнутый текст.~~

  1. Списки
1. Первый пункт нумерованного списка.
2. Второй пункт.

* первый пункт ненумерованного списка;
* второй пункт ненумерованного списка

- первый пункт ненумерованного списка;
- второй пункт ненумерованного списка

  1. Ссылки
[Яндекс](https://www.yandex.ru)

Также можно добавить ссылке тайтл (от англ title — «название», «заголовок»). Тайтл — это всплывающая подсказка, которая появляется при наведении мыши на ссылку. Тайтл нужно заключить в кавычки и указать внутри скобок после адреса.
[Яндекс](https://www.yandex.ru "Я Yandex!")

  1. Код
    Чтобы оформить текст как код, нужно окружить его тройками косых кавычек — грависов. После первой тройки грависов указывают язык программирования, на котором написан код. В маркдауне есть поддержка синтаксиса почти всех популярных языков и инструментов.
  ```bash ls - la ```
  ```html <h1>А я просто текст</h1> ``` 

  1. mermaid

Чтобы получить mermaid-схему в README.md, нужно добавить блок кода типа mermaid.

mermaid %% описание схемы(Комментарий)

graph LR;
  untracked -- "git add" --> staged;
  staged    -- "???"     --> tracked/comitted;

%% стрелка без текста для примера: 
  A --> B;
Loading

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published