Ein Blick auf devdocs.io

devdocs.io: Programmierer -Dokumentationstool, verabschieden Sie sich von mühsamen Suchanfragen!

Kernpunkte:

• devdocs.io ist eine Webanwendung, die einen schnellen Zugriff auf zahlreiche Front-End-Sprachen und Bibliotheksreferenzhandbücher bietet. Die Schnittstelle ist effizient und schnell und verfügt über eine Echtzeit-Fuzzy-Suchfunktion.
• Die Plattform integriert nur offizielle Inhalte und ignoriert benutzerfreundliche Kommentare und Beispiele. Es ist Open Source und fördert den Community -Beitrag durch Github. Benutzer können es sogar lokal für bestimmte Anforderungen einsetzen, z. B. die interne System -API des Unternehmens.
• devdocs.io ist für mobile Geräte vollständig optimiert und bietet mehrere Möglichkeiten, es auf dem neuesten Stand zu halten. Es kann als Plugin für sublime Text und Klammern sowie als Suchmaschine für Firefox und Google Chrome installiert werden. Es bietet auch eine Vielzahl von intuitiven Tastaturverknüpfungen für eine reibungslose Benutzererfahrung.

durchlaufen Sie oft den folgenden Codierungsprozess?

1. erfordert Funktionsdefinitionen und Beispiele für die Programmiersprache.
2. Google -Suche nach dieser Funktion.
3. Klicken Sie auf das erste Ergebnis. Wenn Sie kein Glück haben, sind es W3schools, ansonsten ist es das Online -Handbuch der Sprache, die Sie verwenden.
4. Erkennen Sie, dass Sie eine Demonstration und Erklärung einer anderen Funktion benötigen.
5. kehren Sie zur Google -Suche zurück, anstatt Suchvorgänge auf Sprachwebsites zu verwenden, da sie nach dem Nachladen der Registerkarte unerklärlicherweise schrecklich und langsamer ist als eine neue Google -Suche.
6. Wiederholen Sie die obigen Schritte.

Als Entwickler, der viel Web -Technologie verwendet, begegne ich diese Situation oft. Es ist viel schwieriger denn je geworden, technische Definitionen von Funktionen oder Aussagen zu finden - nicht in Bezug auf die Komplexität, sondern in Bezug auf die Zeitverschwendung. Wäre es nicht großartig, wenn wir alle Entwicklungsdokumente an einem Ort in einer schönen, offline-Zugriffs-fähigen Oberfläche haben und eine super schnelle Fuzzy-Suche nach einer Sprache haben könnten? Devdocs.io entstand.

Was ist devdocs.io?

devdocs ist eine Webanwendung, mit der Sie schnelle Zugriff auf Referenzhandbücher für fast alle Front-End-Sprachen und -Bibliotheken ermöglichen. Es listet alle APIs und ihre offizielle Dokumentation für eine bestimmte ausgewählte Sprache in einem leicht zu durchsteigenden und anzeigenen Format ohne die unnötigen Menüs und kitschigen Stile auf, die offizielle Websites wie Php.net implementieren möchten.

Dies ist eine Open-Source-Webanwendung von AJAX mit Syntax-Hervorhebung und kann sogar als Chrome-Erweiterung oder Plug-In für erhabenen Text oder Klammern verwendet werden.

Was kann Devdocs.io tun?

IT aggregiert Referenzhandbücher für alle beliebten Sprachen (vorausgesetzt, ihre Handbücher befinden sich in einem leicht zugänglichen und maschinenlesbaren Format). Es bietet Ihnen eine reibungslose und schnelle Schnittstelle, um die Suche nach Dokumenten in allen ausgewählten Sprachen zu verwischen, damit Sie die von Ihnen benötigten Informationen mit den geringsten Schlüssel finden können. Sie fragen sich vielleicht, was Fuzzy -Suche ist? Fuzzy -Suche ist eine Suche nach einer Zeichenfolge, die grob (nicht genau) dem entspricht, was Sie eingegeben haben. Editoren wie Sublime Text und LightTable verwenden diese Methode in ihren Befehlssuchfenstern. Wenn Sie so etwas wie "SA" eingeben, erhalten Sie "Speichern als ..", weil die Eingabe mit der Abkürzung des Befehls übereinstimmt. Das Eingeben von "Delte" liefert Ergebnisse, die "Delta" und "Löschen" enthalten, und die Eingabe von "BGCP" bietet sogar "Hintergrundclip". Diese Art der Suche ermöglicht eine superschnelle Feinabstimmung der Ergebnisse, und da sie Echtzeit sind, können Sie sich sofort mischen und anpassen.

Inhalt

devdocs lädt den Referenzhandbuch für die Sprache Ihrer Wahl herunter, übernimmt ihn in Ihren lokalen Cache und liefert dann die Ergebnisse daraus. Dies bedeutet, dass Sie die Sprache Ihrer Wahl auf jeder neuen Maschine erneut herunterladen müssen, aber diese Art und Weise bringt sie viel bessere Geschwindigkeitsverbesserungen als die alte AJAX-Methode, die Remote-Anforderungen verwendet. HINWEIS - Derzeit ist nur der Index offline und das tatsächliche Ergebnis Ihres Klicks wird von einem Remote -Standort aus bereitgestellt. Auch wenn es offline ist, wird er in den Suchergebnissen angezeigt, um das JavaScript -Array noch zu erhalten Dokumentation.

Es ist wichtig zu beachten, dass der erhaltene Inhalt auf offizielle Inhalte beschränkt ist. Dies bedeutet, dass die vom Benutzer eingereichten Einträge (z. B. Kommentare und Beispiele) ignoriert werden.

Sie können "PHP" vor der Suchabfrage hinzufügen und Registerkarte oder Space Balk (auf Mobilgeräte) zu einem bestimmten Sprachbereich (z. B. nur Php) drücken, indem Sie "PHP addieren "Vor der Suchabfrage und dem Drücken von

oder

leertal (nur auf Mobilgeräten) (nur).) Suchen Sie nach DeGdocs. Dadurch wechselt der Suchmodus in "nur ausgewählte Sprachen". Um diesen Modus zu verlassen, nur Rückraum.

Open Source und Lokale Bereitstellung devdocs sind Open Source und ermutigen die Community, auf verschiedene Weise einen Beitrag zu leisten. Erstens befindet es sich auf Github und lädt Benutzer ein, Fragen einzureichen und den Code zu verbessern, genau wie jedes gute Open -Source -Projekt. Zweitens können DEGDOCs einfach lokal bereitgestellt werden, sodass Sie Ihre eigene Version ausführen oder hosten können. Beispielsweise ist es sehr einfach, es an die API des internen Systems des Unternehmens anzupassen. Last but not least verwendet Devdocs Trello, um Benutzer -Feedback zu der gewünschten Sprache zu sammeln. Trello ist eine sehr effiziente teambasierte Aufgabenliste, die eine Vielzahl von Informationsgremien unterstützt, in denen Menschen zusammenarbeiten, diskutieren und abstimmen können (Thema). DEGDOCs verwenden diese Karten, um Stimmen für Integrationen in jede Sprache zu sammeln. Um teilzunehmen, schauen Sie sich hier an.

devdocs werden regelmäßig gepflegt und aktualisiert und bieten verschiedene Möglichkeiten, um mit den neuesten Änderungen Schritt zu halten:

• Wenn Sie es nach dem Update -Datum öffnen, wird die Website selbst mit den neuesten Änderungen angezeigt.
• Es gibt einen Newsletter.
• einen Twitter -Konto haben.
• Es gibt sogar eine Mailingliste.
• Es gibt ein neuestes Änderungsprotokoll.

all dies scheinen aus derselben Quelle zu stammen, daher ist es besser, nur einen von ihnen zu abonnieren.

Andere Vorteile

devdocs ist für mobile Geräte vollständig optimiert und reagiert sehr. Es öffnet sich sehr schnell und funktioniert genauso wie auf einem mobilen Gerät wie auf einem Desktop -Gerät. Es ist auf eine Weise integriert, die ideal für eine Website ist - eine reibungslose, schnelle und konsistente Erfahrung auf jedem Gerät. Thibaut Courouble macht einen tollen Job.

Wie bereits erwähnt, kann die Anwendung als Plugin für sublime Text und Klammern installiert werden - was bedeutet, dass Sie vom Editor direkt nach der erforderlichen API suchen können. In Kürze werden weitere Plugins stattfinden, und das bemerkenswerteste ist das Jetbrains -Produkt -Plugin. Die App wird auch auf eine eigenständige Offline-Version von Null konfigurierbar portiert.

devdocs können als Suchmaschine für Firefox und Google Chrome sowie als jeder andere Browser und jede App, die OpenSearch unterstützt, installiert werden. OpenSearch ist eine Reihe von Standards, die es einer Ressource ermöglichen, sich als Suchmaschine zu identifizieren.

bietet auch eine Vielzahl von Tastaturverknüpfungen, die alle sehr intuitiv und sehr nützlich sind und ein wirklich reibungsloses Erlebnis bieten.

Schlussfolgerung

Wenn Sie vor dem Lesen dieses Artikels noch nie von Devdocs gehört haben, empfehle ich Ihnen dringend, es zu versuchen. Das Netzwerk benötigt dringend so benutzerfreundliche Ressourcen. Raten Sie es daher mit, um der Community bessere Lösungen für die Probleme zu finden, mit denen sie konfrontiert sind. Wenn Sie einen Beitrag leisten können, ist DeGdocs auf Gittip und unterstützt PayPal -Spenden - aber der beste Weg, es zu helfen, besteht darin, es zu nutzen, anderen davon zu erzählen und vor allem, indem Sie zu dem Projekt zu GitHub beitragen, es zu verbessern.

(Folgendes ist der FAQ

devdocs.io faq

• Wie unterscheidet sich devdocs.io von anderen Dokumentplattformen?

  devdocs.io fällt nach seiner einfachen, schnellen und benutzerfreundlichen Schnittstelle auf. Es integriert mehrere API -Dokumente in eine schnelle, geordnete und durchsuchbare Schnittstelle. Im Gegensatz zu anderen Plattformen können Benutzer von DeGdocs.io Dokumente für die Offline -Verwendung herunterladen, die auch ohne Internetverbindung zugänglich sind. Es unterstützt auch Tastaturverknüpfungen für die einfache Navigation.

• Ist devdocs.io kostenlos zu bedienen? Ja, devdocs.io ist völlig kostenlos zu verwenden. Dies ist ein Open -Source -Projekt, was bedeutet, dass es nicht nur kostenlos ist, sondern auch Benutzer an seiner Entwicklung teilnehmen können. Dies macht es zu einer Community-gesteuerten Plattform, die sich basierend auf den Benutzerbedürfnissen und dem Feedback entwickelt.

• Wie sorgt Devdocs.io für die Genauigkeit seiner Dokumentation? devdocs.io extrahiert seine Dokumente direkt aus offiziellen Quellen, um sicherzustellen, dass die bereitgestellten Informationen genau und aktuell sind. Mit der Plattform können Benutzer auch Korrekturen und Aktualisierungen beibehalten, um die Genauigkeit von Dokumenten weiter zu verbessern.

• Kann ich Devdocs.io offline verwenden? Ja, eines der Hauptmerkmale von devdocs.io ist die Fähigkeit, offline zu arbeiten. Benutzer können die benötigten Dokumente herunterladen und jederzeit und überall ohne Internetverbindung auf sie zugreifen. Dies macht Devdocs.io zu einer zuverlässigen Ressource, insbesondere für Entwickler, die möglicherweise nicht immer in der Lage sind, sich immer mit dem Internet zu verbinden.

• Wie kann man zu devdocs.io beitragen? Als Open -Source -Projekt begrüßt Devdocs.io die Beiträge der Benutzer. Sie können einen Beitrag leisten, indem Sie Fehler melden, Vorschläge für Verbesserungen machen und sogar Code schreiben. Alle für Beiträge erforderlichen Informationen finden Sie auf der Github -Seite von devdocs.io.

• devdocs.io unterstützt mobile Geräte? Ja, Devdocs.io ist voll und ganz reagiert und funktioniert gut auf mobilen Geräten. Dies bedeutet, dass Sie auf die erforderlichen Dokumente von Ihrem Smartphone oder Tablet zugreifen können, was es zu einem vielseitigen Tool für mobile Entwickler macht.

• Wie oft werden Dokumente auf devdocs.io aktualisiert? devdocs.io bemüht sich, seine Dokumentation so aktuell wie möglich zu halten. Die Häufigkeit des Updates hängt von der Quelle des Dokuments ab. Wenn die offizielle Dokumentation beispielsweise aktualisiert wird, spiegelt Devdocs.io diese Änderungen so bald wie möglich wider.

• Kann ich die Schnittstelle von devdocs.io anpassen? Ja, DeDocs.io ermöglicht Benutzern, die Schnittstelle entsprechend ihren Vorlieben anzupassen. Sie können auswählen, welche Dokumente Sie anzeigen, das Layout einstellen und zwischen hellen und dunklen Themen wechseln möchten.

• unterstützt Devdocs.io alle Programmiersprachen? devdocs.io unterstützt eine Vielzahl von Programmiersprachen und -technologien, deckt jedoch möglicherweise nicht alle Sprachen ab. Die Plattform konzentriert sich auf die am häufigsten verwendeten Sprachen und Technologien in der Branche.

• devdocs.io -Benutzer haben eine Community oder ein Forum? Obwohl devdocs.io keine dedizierte Community oder Forum hat, können Benutzer interagieren und über die Github -Seite der Plattform beitragen. Hier können sie Probleme melden, Vorschläge für Verbesserungen machen und mit anderen Benutzern und Mitwirkenden diskutieren.

Alle Bildlinks bleiben wie sie sind.

Das obige ist der detaillierte Inhalt vonEin Blick auf devdocs.io. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!