Le site Web d'Electron a un nouveau moteur de recherche qui fournit des résultats instantanés concernant la documentation des API, les tutoriels, les paquets npm liés à Electron, et plus encore.
L'apprentissage d'une nouvelle technologie ou d'un nouveau framework comme Electron peut être intimidant. Une fois la phase de démarrage rapide dépassée , il peut être difficile d'apprendre les meilleures pratiques ou de trouver les bonnes APIs, ou encore de découvrir les outils qui vous aideront à construire l'application de vos rêves. Notre désir est que le site web d'Electron soit un meilleur outil pour trouver les ressources dont vous avez besoin afin de vous peremettre de construire des applications rapidement et facilement.
Quelle que soit la page où vous vous trouvez sur electronjs.org la nouvelle zone de saisie de recherche est située en haut de la page.
Moteur de recherche
Lorsque nous avons décidé d'ajouter une recherche au site web, nous avons mis en place notre propre moteur de recherche en utilisant GraphQL comme backend. Cela a été un plaisir de travailler avec GraphQL et le moteur de recherche était performant , mais, nous avons rapidement réalisé que ce n'était pas si trivial de construire un moteur de recherche. Les choses comme la recherche par mots multiples ou la détection des fautes de frappe nécessitent beaucoup de travail pour que cela fonctionne correctement. Donc, plutôt que de réinventer la roue, nous avons décidé d'utiliser une solution de recherche existante : Algolia.
Algolia est un service de recherche hébergé qui est devenu rapidement le moteur de recherche favori au sein de projets open source populaires tels que React, Vue, Bootstrap, Yarn et bien d'autres encore.
Voici quelques-unes des fonctionnalités qui ont fait d'Algolia un choix parfaitement adapté au projet Electron :
- InstantSearch.js fournit des résultats au fur et à mesure que vous tapez, et généralement dans la ms qui suit.
- La tolérance aux fautes de frappe signifie que vous obtiendrez toujours des résultats même lorsque vous tapez par exemple
widnow. - La syntaxe de requête avancée autorise
"exact quoted matches"et-exclusion. - Les clients de API sont open source et bien documentés.
- Des analyses sont produites nous disant ce que les gens recherchent le plus, ainsi que leurs recherches qui n'ont pas abouties. Cela nous permettra de mieux comprendre en quoi la documentation d'Electron peut être améliorée.
- Algolia est gratuit pour les projets open source.
Documentation de l'API
Parfois, vous savez ce que ce que vous voulez accomplir, mais sans savoir exactement comment le faire. Electron possède plus de 750 méthodes d'API, événements et propriétés. Aucun humain ne peut se souvenir facilement de tous ces éléments, par contre les ordinateurs sont bons à cet égard. En utilisant les données structurées en JSON des API d'Electron, nous avons indexé toutes ces données dans Algolia, et vous pouvez ainsi, facilement trouver exacterment l'API que vous recherchez.
Vous essayez de redimensionner une fenêtre? Recherchez redimensionner et sautez directement à la méthode dont vous avez besoin.
Tutoriels
Electron a une collection toujours croissante de tutoriels pour compléter sa documentation. Maintenant vous trouverez plus facilement des tutoriels sur un sujet donné, en sus de la documentation de l'API associée.
Vous recherchez les bonnes pratiques en matière de sécurité ? Recherchez sécurité.
Packages npm
Il y a maintenant plus de 700 000 packages dans le registre npm et ce n'est pas toujours facile d'y trouver celui dont vous avez besoin. Pour vous y retrouver plus facilement parmi tous ces modules, nous avons créé electron-npm-packages, une collection des plus de 3400 modules du registre construits spécifiquement pour être utilisés avec Electron.
Les gens de Bibliothèques. o ont créé SourceRank, un système de notation de projets logiciels basé sur une combinaison de facteurs comme le code, la communauté, la documentation et l'utilisation. Nous avons créé un module sourceranks qui inclut le score obtenu par chaque module dans le registre npm, et nous utilisons ces scores pour trier les résultats.
Vous voulez des solutions de rechange aux modules IPC intégrés à Electron? Recherche de is:package ipc.
Applications Electron
Il est facile d'indexer des données avec Algolia, nous avons donc ajouté la liste des applications existantes depuis electron/apps.
Essayez une recherche pour [musique] ou [homebrew].
Filtrage des résultats
Si vous avez déja utilisé la recherche de code de GitHub, vous êtes probablement habitué aux filtres par clé-valeur tels que extension:js ou user:defunkt. Nous avons considéré que puisque cette technique de filtrage est très efficace, et nous vons donc ajouter le mot-clé is: à la recherche d'Electron qui vous permett de filtrer les résultats pour n'afficher qu'un seul type:
Navigation au clavier
Les gens aiment les raccourcis clavier ! La nouvelle recherche peut être utilisée entièrement au clavier:
- / donne le focus au champ de saisie
- esc donne le focus au champ de saisie et le vide
- down se déplace jusqu'au résultat suivant
- up se déplace au résultat précédent ou au champ de saisie
- enter ouvre un résultat
Nous avons également rendu lopen-source es sources du module qui permet cette interaction avec le clavier. Il est conçu pour être utilisé avec Algolia InstantSearch, mais est suffisament générique pour permettre la compatibilité avec différentes implémentations de recherche.
Votre avis nous est nécessaire
Nous voulons avoir de vos nouvelles si vous rencontrez des problèmes avec le nouvel outil de recherche!
La meilleure façon de soumettre vos commentaires est de déposer un problème sur GitHub dans le dépôt approprié :
- electron/electronjs.org: Le site Electron. C'est le meilleur choix si vous ne savez pas où exposer un problème.
- electron/algolia-index est l'endroit où toutes les données Electron interrogeables sont compilées.
- electron/search-with-your-keyboard rend l'interface de recherche navigable par clavier.
- algolia/instantsearch.js est le client côté navigateur qui permet la recherche de type trouvez-dès-que-vous saisissez.
- algolia/algoliasearch-client-javascript est le client Node.js pour le téléchargement de données sur les serveurs d'Algolia.
Merci
Remerciements spéciaux à Emily Jordan et Vanessa Yuen pour avoir produit ces nouvelles fonctionnalités de recherche, à Librairies.io pour la fourniture de scores SourceRank et à l'équipe d'Algolia pour leur aide lors du démarrage. 🍹