Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Обновляет стайлгайд по оформлению списков #5275

Merged
merged 2 commits into from
Apr 10, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions docs/styleguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,37 +383,40 @@ console.log(empty.length)

#### Списки

Оформляйте списки при помощи цифры с точкой или наборного знака (в маркдауне это дефис). Если у вас список из коротких односоставных однотипных пунктов, можно разделять их точкой с запятой. В этом случае первый пункт пишется с прописной (большой) буквы, последующие со строчной, в конце последнего пункта ставится точка.
Оформляйте списки при помощи цифры с точкой или наборного знака (в маркдауне это дефис). В нумерованном списке каждый пункт начинайте с большой буквы, в конце ставьте точку. В маркированном перечне начинайте пункты с маленькой буквы, а завершайте точкой с запятой. В конце последнего пункта ставится точка.

```md
1. Один;
1. два;
1. три.
1. Первый.
1. Второй.
1. Третий.

- Один;
- два;
— три.
- пункт маркированного списка;
- пункт маркированного списка;
- пункт маркированного списка.
```

Если перед таким списком у вас идёт обобщающее предложение с двоеточием, первый пункт тоже можно начинать со строчной буквы.
Если пункты маркированного списка совсем просты, можно разделить их запятой:

Селекторы бывают:
```md
- пункт,
- пункт,
- пункт.
```

1. тегами;
1. классами;
1. идентификаторами.
👆 Обратите внимание, что мы используем «ленивые» нумерованные списки, начиная каждый пункт с единицы. Маркдаун сам проставит нужную нумерацию.

Если у вас список из длинных пунктов (особенно если в пункте не одно предложение), каждый пункт пишется с прописной (большой) буквы, а в конце пункта ставится точка:
Знаки препинания на конце не требуются, если вы приводите список ссылок. В данном случае мы рассматриваем каждую ссылку как заголовок, а на конце заголовка точка не ставится:
skorobaeus marked this conversation as resolved.
Show resolved Hide resolved

```md
1. Проценты. Размер в процентах будет рассчитываться от размеров элемента.
1. Ключевое слово `auto`. Размер изображения остаётся неизменным. Кстати, это ключевое слово является значением по умолчанию.
- [Асинхронность в JS](/js/async-in-js/)
- [Как реально работают flex-shrink и flex-grow](/css/flex-grow-shrink/)
- [Как ребейзить ветку и не думать ни о чём](/recipes/git-rebase-onto/)
```

👆 Обратите внимание, что мы используем «ленивые» нумерованные списки, начиная каждый пункт с единицы. Маркдаун сам проставит нужную нумерацию.

Списки в подбор (как в этом предложении) оформляются а) при помощи буквы русского алфавита со скобкой; б) начинаются со строчной (маленькой) буквы; в) разделяются точкой с запятой.

👆 Если пункты списка содержат фрагменты кода, замените такой список на текст с подзаговками.

#### Буква ё

Используйте букву Ё. Мы её любим ❤️
Expand Down
Loading