deeplinks

deeplinks.js

Mit deeplinks.js können Menschen problemlos direkt auf jede Textauswahl auf Ihrer Website verknüpfen. Hier ist ein Beispiel dafür, wie einer dieser Links aussieht. Es ist hauptsächlich für Blogs und andere solche Websites gedacht, aber es ist relativ agnostisch für die Umgebung, in der es läuft.

Personen können Text auf der Website wie normalerweise auswählen, und wenn dies der Fall ist, ändert sich die Fragment -Kennung (das, was nach der # in der URL kommt). Wenn sie den von ihnen ausgewählten Text teilen möchten, kopieren sie einfach die URL und senden ihn an jemanden. Wenn diese Person die URL besucht, wird derselbe Text, der ursprünglich ausgewählt wurde, ausgewählt und in Sichtweise gescrollt.

Diese Beschreibung mag es ein wenig kompliziert klingen lassen, aber sie ist eigentlich ziemlich einfach und intuitiv, wenn Sie damit spielen - schau es dir an! Wenn Sie daran interessiert sind, die Details darüber zu kennen, wie es unter der Motorhaube funktioniert, lesen Sie docs/design/ .

Ziele

• Plug-and-Play. Kopieren Sie die Dateien, drop <script type="module" src="/deeplinks/deeplinks.js"></script> in Ihrer Website und es funktioniert.
• Robust. Updates brechen keine Links zu älteren URLs.
• Kurze Links. Lange URLs sind hässlich und werden häufig von Messaging -Apps verstümmelt. URLs sollten kurz sein und keine Charaktere enthalten, die wahrscheinlich durch schlecht benommene Apps verstümmelt werden.
• Subtil. Es sollte nicht im Weg des Lesers stehen. Es brechen keine normalen Fragment-Identifikator-Links.
• Einigermaßen klein. Es ist momentan ungefähr 1,7 KB Gziped (1,6 KB Brotli) und sollte nicht zu viel mehr wachsen.
• Schnell. Das ist nicht schwer, aber es lohnt sich, explizit zu machen.

Nichtgänger

• Umgang mit häufig verändernden Inhalten wie Wikis. Es sollte robust für gelegentliche kleine Änderungen sein, aber wenn Sie eine wirklich robuste Tiefenverknüpfung wünschen, benötigen Sie wirklich Unterstützung in der Authoring -Umgebung (CRDTS usw.).
• Für jede Usecase arbeiten. Ich habe bestimmte Dinge, die ich in einem Skript wie diesem möchte, und andere Menschen werden andere Dinge haben, die sie wollen. Diese Menschen sollten ihre eigenen ähnlichen Skripte aufbauen - Vielfalt ist gut! Dies implementiert beispielsweise die WICG -Textfragmentschnittstelle absichtlich nicht, obwohl dies in Zukunft möglich ist, wenn dies in einer Form standardisiert ist, die mir gefällt.

Installation

Überlegen Sie zunächst, ob Sie das wirklich tun möchten. Wenn Sie dies tun, erstellen Sie neue URLs, die brechen, wenn Sie das Skript von Ihrer Website entfernen. Das Brechen von URLs macht mich traurig, also sollten Sie darüber nachdenken, ob Sie wirklich verpflichtet sind oder nicht, und vielleicht für eine Weile vor Ort damit spielen, um zu sehen, wie es sich anfühlt, bevor Sie es wirklich bereitstellen.

Sobald du dich sicher bist:

• Laden Sie die neueste Version von der Releases -Seite herunter.
• Extrahieren Sie die ZIP -Datei irgendwo in Ihrer Website.
• Fügen Sie das Skript überall in Ihr HTML ein:

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

  Dies setzt voraus, dass Sie die Veröffentlichung in ein Verzeichnis namens deeplinks extrahiert haben - Sie müssen den src ändern, wenn Sie sie woanders hinzufügen. Stellen Sie sicher, dass Sie das type="module" eingeben, es funktioniert sonst nicht! Sie sollten es nur auf Seiten einbeziehen, die sich nicht häufig ändern - insbesondere auf Paginationsseiten, auf denen sich der Inhalt beispielsweise beim Veröffentlichen neuer Beiträge ändert.
• Testen Sie, dass es funktioniert.
• Wenn Sie sich gut fühlen, füllen Sie dieses Formular mit einem Link zu Ihrer Website aus! (Oder senden Sie mir einfach eine E -Mail, wenn Sie Google Formulare nicht mögen)