Skip to content
This repository has been archived by the owner on Sep 9, 2021. It is now read-only.

Latest commit

 

History

History
67 lines (49 loc) · 4.45 KB

TEXT.md

File metadata and controls

67 lines (49 loc) · 4.45 KB
Raw

Правила форматирования текста

Терминология

  • Строка — тип данных
  • Строчка — линия в файле
  • Директория (каталог), но НЕ папка

Выделение

  • Одиночные бектики только для кода, например, const a = 5;.
  • Для жирного и курсива предпочтительно использовать символ *, а не _.
  • Для обозначения комбинации клавиш использовать парный тег <kbd></kbd>. Например Ctrl+P

Дефис и тире

Употребление тире и дефисов легко запомнить, если следовать правилу: тире — длинная черта, которая обычно используется в пределах предложения, а не слов

Слова — лишь гнёзда, их значения — крылатые создания в полёте. (c) Руми

дефис — короткая черта, которая обычно используется в пределах одного слова.

«Конёк-Горбунок» — сказка в стихах Петра Ершова, написанная в 1830-х годах.

Буква "ё"

Всегда используем букву «ё» там, где это требуется, например: «всё или все», «её или её» и т.д.

Заголовки

В тексте используем заголовки двух уровней:

  • ## (H2, два символа решётки) — заголовок верхнего уровня
  • ### (H3, три символа решётки) — заголовок нижнего уровня

Дополнительный уровень вложенности (H5, пять символов решётки) вводится только в самом крайнем случае (обусловленном сложной структурой текста).

Написание заимствованных слов, сложных слов, названий сервисов и сайтов

По правилам написания заимствованных слов нет единого мнения даже у профессиональных филологов. Например, филологи активно спорят, как правильно писать — блогер или блоггер. Для соблюдения принципа единообразия в текстах лучше использовать консенсусные варианты написания:

  • ВКонтакте или ВК (не Вконтакте).
  • Фейсбук, Facebook (не Фэйсбук).
  • Фронтенд (не фронтэнд и не фронт-енд или фронт-энд). Руководствуемся словарём веб-стандартов.
  • Бэкенд (не бэкэнд, не бекенд и не бек-энд). Руководствуемся словарём веб-стандартов.
  • Фреймворк (не фрэймворк).
  • YouTube (не Youtube, не ютуб), но ютуб-канал.
  • Флекс, флекс-контейнер (не флэкс).
  • JavaScript или JS (не Javascript).
  • Node.js (не node.js, NodeJS).
  • CodePen (не Codepen, не кодпен).
  • SEO (не СЕО, когда речь идёт о поисковой оптимизации). Но можно писать сеошник.
  • Лендинг (не лэндинг).
  • Слово интернет пишется с маленькой буквы (посмотри в интернете).
  • Веб-сайт (не web-сайт).
  • Онлайн (не он-лайн).
  • Офлайн (не оф-лайн, не офф-лайн).
  • URL (не урл).
  • Деструктуризация (не дестракчеринг).
  • Колбек (не коллбек, не колбэк и не коллбэк).
  • Рантайм (не runtime, не среда исполнения).
  • Изменяемость и неизменяемость (не мутабельность и не иммутабельность).
  • Markdown (не Маркдаун).