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

Добавляет доку про атрибут rel #5536

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

mafin1799
Copy link

@mafin1799 mafin1799 commented Oct 24, 2024

Описание

Closes #

Чек-лист

  • Текст оформлен согласно руководству по стилю
  • Ссылки на внутренние материалы начинаются со слеша и заканчиваются слэшем либо якорем на заголовок (/css/color/, /tools/json/, /tools/gulp/#kak-ponyat)
  • Ссылки на картинки, видео и демки относительные (images/example.png, demos/example/, ../demos/example/)

@github-actions github-actions bot added html Контент по HTML дока Справочный материал labels Oct 24, 2024
@solarrust solarrust changed the title Article/rel Добавляет доку про атрибут rel Oct 24, 2024
@solarrust solarrust linked an issue Oct 24, 2024 that may be closed by this pull request
@mafin1799
Copy link
Author

@solarrust
Привет
Превью готово.

@solarrust
Copy link
Member

Привет!

Большая получилась дока, подробная. Это очень хорошо =)
Я прошлась первый раз по тексту, вычистила тройные бэктики у инлайнового кода, добавила пустые строки, заменила списки на ленивые.

Следующим подходом планирую немного упростить структуру, уменьшить количество уровней заголовков. Призову ещё @TatianaFokina и @skorobaeus на помощь.

Вместе сделаем прекрасную доку =)

Copy link

Превью контента из 4332ba9 опубликовано.

@mafin1799
Copy link
Author

mafin1799 commented Oct 31, 2024

Привет!

Какие еще улучшения можно внести?

В спецификации WHATWG есть условный блок "other" — возможно, его стоит добавить.
https://html.spec.whatwg.org/multipage/links.html#other-link-types

Примеры сейчас взяты из WHATWG, и, возможно, этого достаточно для понимания. Но стоит ли добавить ссылки на сайты, где это используется на практике, чтобы увидеть, как это работает в реальных условиях?

<link rel="stylesheet" href="styles.css">
```

## Зачем нужен атрибут `rel`?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Кажется, можно убрать заголовок «Зачем нужен атрибут rel?», а список причин перенести в «Кратко» с уточнением, что вот для чего нужен атрибут. Можно даже ненумерованным списком делать, тут не важна последовательность действий.


Используется с тегами [`<link>`](/html/link/), [`<a>`](/html/a/) и [`<area>`](/html/area/).

#### С тегом `<link>` для альтернативных стилей
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Предлагаю убрать все заголовки четвёртого уровня подразделе «rel="alternate"». Ты уже в тексте упоминаешь, что за кейсы описываешь.

<a href="document.pdf" rel="alternate" type="application/pdf">Скачать PDF</a>
```

### `rel="author"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Тут тоже можно остановится на подразделе «rel="author"», а все подзаголовки в нём убрать.


> Ссылка на автора может часто представлять собой адрес электронной почты, начинающийся с `mailto:`.

### `rel="bookmark"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Аналогично и с подразделом «rel="bookmark"»: заголовки четвёртого уровня можно безболезненно удалить.


Атрибут `rel="canonical"` используется с тегом `<link>`.

#### Для указания канонического URL
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

«Для указания канонического URL» предлагаю удалить.


Атрибут `rel="canonical"` указывает, что URL, указанный в атрибуте `href`, является предпочтительным URL для текущего документа. Это помогает поисковым системам уменьшить количество дублирующегося контента, как описано в стандарте RFC 6596.

#### Основные моменты
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Этот заголовок лучше сделать простым параграфом. Либо так и оставить про основные моменты. либо расширить до чего-то вроде: «Основные моменты работы с каноническим URL».

<link rel="canonical" href="https://example.com/preferred-url">
```

#### Рекомендации из стандарта
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

«Рекомендации из стандарта» тоже хорошо бы сделать параграфом и уточнить, что это рекомендации по работе с каноническим URL.


Что делает dns-prefetch? Он сигнализирует браузеру, что ресурсы на указанном домене, скорее всего, понадобятся, и заранее разрешает их адреса, тем самым уменьшая задержки при загрузке. Путем предварительного разрешения DNS, браузер сокращает время ожидания для последующих запросов на загрузку ресурсов, что улучшает производительность.

#### Когда браузер обрабатывает dns-prefetch
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

«Когда браузер обрабатывает dns-prefetch» лучше сделать параграфом.

1. Когда элемент `<link>` уже подключен к контексту просмотра.
1. Когда атрибут `href` изменяется у элемента `<link>`.

#### Алгоритм обработки браузером
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

«Алгоритм обработки браузером» лучше сделать параграфом.


Этот элемент говорит браузеру заранее разрешить DNS для _example.com_, что может ускорить загрузку любых ресурсов, которые могут быть запрошены с этого домена.

### `rel="expect"`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Аналогично и дальше. Принцип такой: если подпункт получается очень кратким, скорее всего что-то пошло не так. Либо это случай, когда лучше всё оставить обычным текстом, либо подзаголовок можно безболезненно удалить.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
html Контент по HTML дока Справочный материал
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Атрибут rel
3 participants