Un regard sur devdocs.io

devdocs.io: outil de documentation du programmeur, dites au revoir aux recherches fastidieuses!

Points de base:

• Devdocs.io est une application Web qui offre un accès rapide à de nombreux manuels de référence de langages et de bibliothèques frontaux. Son interface est efficace et rapide, et il a une fonction de recherche floue en temps réel.
• La plate-forme intègre uniquement le contenu officiel, ignorant les commentaires et les exemples soumis par l'utilisateur. Il est open source et encourage la contribution communautaire via Github. Les utilisateurs peuvent même le déployer localement pour répondre aux besoins spécifiques, tels que l'API système interne de l'entreprise.
• Devdocs.io est entièrement optimisé pour les appareils mobiles et fournit plusieurs façons de le tenir à jour. Il peut être installé comme un plugin pour le texte et les supports sublimes, ainsi que comme moteur de recherche pour Firefox et Google Chrome. Il offre également une variété de raccourcis clavier intuitifs pour une expérience utilisateur fluide.

passez-vous souvent par le processus de codage suivant?

1. nécessite [insérer des définitions de fonctions de programmation] et des exemples de fonction.
2. Google Recherchez cette fonction.
3. Cliquez sur le premier résultat, si vous n'avez pas de chance, ce sont les W3Schools, sinon c'est le manuel en ligne de la langue que vous utilisez.
4. Réalisez que vous avez besoin d'une démonstration et d'une explication d'une autre fonction.
5. Retournez à Google Search au lieu d'utiliser des recherches sur les sites Web de langue, car il est inexplicablement horrible et plus lent qu'une nouvelle recherche Google après le rechargement de l'onglet.
6. Répétez les étapes ci-dessus.

En tant que développeur qui utilise beaucoup de technologie Web, je rencontre souvent cette situation. Il est devenu beaucoup plus difficile que jamais de trouver des définitions techniques des fonctions ou des déclarations - pas en termes de complexité, mais en termes de temps perdu. Ne serait-ce pas génial si nous pouvions avoir tous les documents de développement en un seul endroit, dans une belle interface compatible avec accès hors ligne, et avoir une recherche floue super rapide pour une langue? Devdocs.io a vu le jour.

Qu'est-ce que DevDocs.io?

DevDocs est une application Web conçue pour vous donner un accès rapide aux manuels de référence pour presque toutes les langues et bibliothèques frontales. Il répertorie toutes les API et leur documentation officielle pour une langue sélectionnée donnée, dans un format facile à parcourir et à visualiser sans les menus inutiles et les styles de fromage que les sites Web officiels tels que Php.NET tentent de mettre en œuvre.

Il s'agit d'une application Web open source propulsée par Ajax, avec une mise en évidence de syntaxe, et peut même être utilisée comme extension chromée ou un plug-in pour le texte ou les supports sublimes.

Que peut faire Devdocs.io?

Il regroupe les manuels de référence pour toutes les langues populaires (à condition que leurs manuels soient dans un format facile à accéder et lisible par la machine). Il vous fournit une interface fluide et rapide pour brouiller la recherche de documents dans toutes les langues sélectionnées afin que vous puissiez trouver les informations dont vous avez besoin avec les moindres touches possibles. Vous vous demandez peut-être ce qu'est la recherche floue? Fuzzy Search est une recherche d'une chaîne qui correspond à peu près (pas exactement) ce que vous avez entré. Les éditeurs comme SUBLIME Text et Lighttable utilisent cette méthode dans leurs fenêtres de recherche de commandes - entrant quelque chose comme "SA" vous donnera "Enregistrer sous le nom .." parce que l'entrée correspond à l'abréviation de la commande. La saisie "Delte" fournira des résultats contenant "Delta" et "Delete", et la saisie "BGCP" fournira même "Clip d'arrière-plan". Ce type de recherche permet un réglage super rapide des résultats, et comme ils sont en temps réel, vous pouvez mélanger et faire correspondre instantanément.

Contenu

DevDocs télécharge l'index du manuel de référence pour la langue de votre choix, l'absorbe dans votre cache local, puis en fournit les résultats. Cela signifie que vous devez redémarrer le langage de votre choix sur chaque nouvelle machine, mais cette façon de le faire apporte de bien meilleures améliorations de vitesse que l'ancienne méthode Ajax qui utilise des demandes distantes. Remarque - Actuellement, seul l'index est hors ligne et le résultat réel de votre clic est fourni à partir d'un emplacement distant - par exemple, même s'il est hors ligne, il sera affiché dans les résultats de la recherche, vous avez toujours besoin d'accès Internet pour obtenir le tableau JavaScript documentation.

Il est important de noter que le contenu obtenu est limité au contenu officiel. Cela signifie que les entrées soumises par l'utilisateur (telles que les commentaires et les exemples) seront ignorées.

Vous pouvez ajouter "php" avant la requête de recherche et appuyer sur onglet ou Space Bar (sur mobile) à une gamme de langues spécifique (par exemple, PHP uniquement) en ajoutant "PHP PHP "Avant la recherche de recherche et appuyer sur

ou

SpaceBar (sur mobile) (seulement).) Recherchez les devdocs. Cela bascule le mode de recherche sur "les langues sélectionnées uniquement". Pour quitter ce mode, juste un arrière-pas.

Open source et déploiement local Devdocs sont open source et encourage la communauté à contribuer de diverses manières. Tout d'abord, il est situé sur GitHub et invite les utilisateurs à soumettre des questions et à améliorer le code, comme tout bon projet open source. Deuxièmement, les DevDocs peuvent être facilement déployés localement, vous pouvez donc exécuter ou héberger votre propre version. Par exemple, l'adapter à l'API du système interne de l'entreprise est très facile. Enfin et surtout, DevDocs utilise Trello pour collecter les commentaires des utilisateurs sur la langue qu'ils souhaitent. Trello est une liste de tâches en équipe très efficace qui prend en charge une variété de conseils d'information où les gens peuvent collaborer, discuter et voter (sujet). DevDocs utilisent ces cartes pour collecter des votes pour les intégrations dans chaque langue. Pour participer, consultez ici.

Devdocs sont régulièrement entretenus et mis à jour et offrent diverses façons de suivre les derniers modifications:

• Si vous l'ouvrez après la date de mise à jour, le site Web lui-même apparaîtra avec les dernières modifications.
• Il y a une newsletter.
• Avoir un compte Twitter.
• Il y a même une liste de diffusion.
• Il y a un dernier journal de changement.

Tout cela semble provenir de la même source, il est donc préférable de s'abonner à un seul d'entre eux.

Autres avantages

DevDocs est entièrement optimisé pour les appareils mobiles et est très réactif. Il s'ouvre très rapidement et fonctionne exactement de la même manière que sur un appareil mobile que sur un appareil de bureau. Il est construit d'une manière idéale pour un site Web - une expérience fluide, rapide et cohérente sur chaque appareil. Thibaut Courouble fait un excellent travail.

Comme mentionné précédemment, l'application peut être installée en tant que plugin pour le texte et les supports sublimes - ce qui signifie que vous pouvez rechercher l'API requise directement à partir de l'éditeur. Plus de plugins arrivent bientôt, et le plus notable est le plugin de produit JetBrains. L'application est également transportée vers une version hors ligne indépendante zéro autonome.

Devdocs peuvent être installés en tant que moteur de recherche pour Firefox et Google Chrome, ainsi que essentiellement tout autre navigateur et application qui prend en charge OpenEnsEarch. OpenSearch est un ensemble de normes qui permettent à une ressource de s'identifier comme un moteur de recherche.

propose également une variété de raccourcis clavier, qui sont tous très intuitifs et très utiles, offrant une expérience vraiment fluide.

Conclusion

Si vous n'avez pas entendu parler de DevDocs avant de lire cet article, je vous recommande fortement de l'essayer. Le réseau a besoin de toute urgence de ressources très faciles à utiliser, veuillez donc le conseiller pour aider la communauté à trouver de meilleures solutions aux problèmes auxquels ils sont confrontés. Si vous pouvez contribuer, DevDocs est sur Gittip et prend en charge les dons PayPal - mais sans doute la meilleure façon d'aider est de l'utiliser, d'en parler aux autres, et surtout, en contribuant au projet sur Github l'améliorer.

(Ce qui suit est la partie FAQ, qui a été réécrite et rationalisée en fonction du texte d'origine, et l'intention d'origine est maintenue)

devdocs.io faq

• En quoi Devdocs.io est-il différent des autres plates-formes de documents? Devdocs.io se distingue par sa simplicité, son interface rapide et conviviale. Il intègre plusieurs documents d'API dans une interface rapide, commandée et consultable. Contrairement à d'autres plates-formes, DevDocs.io permet aux utilisateurs de télécharger des documents pour une utilisation hors ligne, accessible même sans connexion Internet. Il prend également en charge les raccourcis clavier pour une navigation facile.

• Devdocs.io est-il gratuit? Oui, DevDocs.io est entièrement libre à utiliser. Il s'agit d'un projet open source, ce qui signifie qu'il est non seulement gratuit, mais les utilisateurs peuvent également participer à son développement. Cela en fait une plate-forme axée sur la communauté qui évolue en fonction des besoins et des commentaires des utilisateurs.

• Comment Devdocs.io assure-t-il la précision de sa documentation? Devdocs.io extrait ses documents directement des sources officielles, garantissant que les informations fournies sont exactes et à jour. La plate-forme permet également aux utilisateurs de contribuer des corrections et des mises à jour pour améliorer encore la précision des documents.

• Puis-je utiliser DevDocs.io Offline? Oui, l'une des principales caractéristiques de DevDocs.io est sa capacité à travailler hors ligne. Les utilisateurs peuvent télécharger les documents dont ils ont besoin et y accéder à tout moment, n'importe où sans connexion Internet. Cela fait de devdocs.io une ressource fiable, en particulier pour les développeurs qui ne peuvent pas toujours se connecter à Internet.

• Comment contribuer à DevDocs.io? En tant que projet open source, Devdocs.io accueille les contributions des utilisateurs. Vous pouvez contribuer en signalant des bogues, en faisant des suggestions d'améliorations et même en écrivant du code. Toutes les informations requises pour les contributions peuvent être trouvées sur la page GitHub de DevDocs.io.

• Devdocs.io prend en charge les appareils mobiles? Oui, Devdocs.io est entièrement réactif et fonctionne bien sur les appareils mobiles. Cela signifie que vous pouvez accéder aux documents requis à partir de votre smartphone ou tablette, ce qui en fait un outil polyvalent pour les développeurs mobiles.

• À quelle fréquence les documents sont-ils mis à jour sur devdocs.io? Devdocs.io s'efforce de garder sa documentation aussi à jour que possible. La fréquence de mise à jour dépend de la source du document. Par exemple, si la documentation officielle est mise à jour, DevDocs.io reflétera ces modifications dès que possible.

• Puis-je personnaliser l'interface de devdocs.io? Oui, DevDocs.io permet aux utilisateurs de personnaliser l'interface en fonction de leurs préférences. Vous pouvez choisir les documents que vous souhaitez afficher, ajuster la disposition et basculer entre les thèmes clairs et sombres.

• DevDocs.io prend-il en charge tous les langages de programmation? Devdocs.io prend en charge une variété de langages et de technologies de programmation, mais il peut ne pas couvrir tous les langages. La plate-forme se concentre sur les langues et technologies les plus couramment utilisées dans l'industrie.

• Les utilisateurs Devdocs.io ont une communauté ou un forum? Bien que Devdocs.io ne disposait pas d'une communauté ou d'un forum dédié, les utilisateurs peuvent interagir et contribuer via la page GitHub de la plate-forme. Ici, ils peuvent signaler les problèmes, faire des suggestions d'améliorations et discuter avec d'autres utilisateurs et contributeurs.

Tous les liens d'image sont laissés tels quels.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!