deeplinks

deeplinks.js

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

Люди могут выбрать текст на сайте, как обычно, и когда они это делают, идентификатор фрагмента (вещь, которая происходит после # в URL). Если они хотят поделиться выбранным текстом, они просто копируют URL и отправляют его кому -то. Когда этот человек посещает URL, тот же текст, который был изначально выбран, будет выбран и просмотр в поле зрения.

Это описание может сделать его немного сложным, но на самом деле оно довольно просто и интуитивно понятно, когда вы играете с ним - проверьте это! Если вы заинтересованы в том, чтобы узнать подробности того, как это работает под капотом, ознакомьтесь с docs/design/ .

Цели

• Подключить и играть. Скопируйте файлы, Drop <script type="module" src="/deeplinks/deeplinks.js"></script> на вашем веб -сайте, и это работает.
• Крепкий. Обновления не будут нарушать ссылки на старые URL.
• Короткие ссылки. Длинные URL -адреса уродливы и часто изуродованы приложениями обмена сообщениями. URL -адреса должны быть короткими и не содержать символов, которые могут быть изуродованы приложениями неправильного поведения.
• Тонкий. Это не должно вставать на пути читателя. Это не нарушает нормальные ссылки идентификатора фрагментов.
• Достаточно маленький. Сейчас это около 1,7 КБ GZED (1,6 КБ, Бротли), и не должно расти слишком много.
• Быстрый. Это не сложно, но это стоит сделать явным.

Не предстоящие

• Обработка часто меняющегося содержания, например вики. Это должно быть устойчивым к случайным небольшим изменениям, но если вы хотите по -настоящему надежного глубокого связывания, вам действительно нужна поддержка из авторизации (CRDT и т. Д.).
• Работая на каждом использовании. У меня есть конкретные вещи, которые я хочу в таком сценарии, а у других людей будут другие вещи, которые они хотят. Эти люди должны строить свои собственные подобные сценарии - разнообразие - это хорошо! Например, это намеренно не реализует интерфейс фрагмента текста WICG, хотя возможно, что в будущем это может быть стандартизировано в такой форме, которая мне нравится.

Установка

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

Как только ты уверен:

• Загрузите самый последний релиз со страницы релизов.
• Извлеките zip -файл где -нибудь на вашем сайте.
• Включите сценарий в любом месте вашего HTML:

   < script type =" module " src =" /deeplinks/deeplinks.js " > </ script >

  Это предполагает, что вы извлекли релиз в каталог под названием deeplinks - вам нужно изменить src , если вы поместите его в другом месте. Убедитесь, что вы включите type="module" , он не сработает иначе! Вы должны включить его только на страницы, которые не будут часто меняться - особенно, не включайте его на страницы страниц, где, например, контент меняется при публикации новых сообщений.
• Проверьте, что это работает.
• Если вы чувствуете себя хорошо, заполните эту форму ссылкой на ваш сайт! (Или просто напишите мне, если вам не нравятся формы Google)