DevDocs.io：程序員的文檔神器，告別繁瑣搜索！

核心要點：

• DevDocs.io是一個網(wǎng)絡應用，提供快速訪問眾多前端語言和庫的參考手冊。其界面高效快捷，並具備實時模糊搜索功能。
• 平臺僅整合官方內(nèi)容，忽略用戶提交的評論和示例。它是開源的，並通過GitHub鼓勵社區(qū)貢獻。用戶甚至可以將其部署到本地以適應特定需求，例如公司的內(nèi)部系統(tǒng)API。
• DevDocs.io針對移動設備進行了全面優(yōu)化，並提供多種保持更新的方法。它可以作為Sublime Text和Brackets的插件，以及Firefox和Google Chrome的搜索引擎安裝。它還提供各種直觀的鍵盤快捷鍵，以提供流暢的用戶體驗。

你是否經(jīng)常經(jīng)歷以下編碼過程？

1. 需要[插入編程語言]函數(shù)定義和示例。
2. 谷歌搜索該函數(shù)。
3. 點擊第一個結果，如果運氣不好，就是w3schools，否則就是你正在使用的語言的在線手冊。
4. 意識到你需要另一個函數(shù)的演示和解釋。
5. 返回谷歌搜索，而不是使用語言網(wǎng)站上的搜索，因為它莫名其妙地糟糕且比重新加載標籤頁後的新谷歌搜索還要慢。
6. 重複以上步驟。

作為一名大量使用Web技術的開發(fā)者，我經(jīng)常遇到這種情況。僅僅查找函數(shù)或語句的技術定義已經(jīng)變得比以往任何時候都困難得多——不是在復雜性方面，而是在浪費的時間方面。如果我們能在一個地方擁有所有開發(fā)文檔，在一個漂亮、支持離線訪問的界面中，並具有超快的模糊搜索功能，用於任何語言，那不是很棒嗎？ DevDocs.io應運而生。

DevDocs.io是什麼？

DevDocs是一個網(wǎng)絡應用，旨在讓您快速訪問幾乎所有前端語言和庫的參考手冊。它列出了給定所選語言的所有API及其官方文檔，採用易於瀏覽和查看的格式，無需官方網(wǎng)站（如php.net）試圖實現(xiàn)的那些不必要的菜單和俗氣的樣式。

這是一個使用Ajax驅(qū)動的開源網(wǎng)絡應用，具有語法高亮顯示功能，甚至可以作為Chrome擴展程序或Sublime Text或Brackets的插件使用。

DevDocs.io能做什麼？

它聚合了所有流行語言的參考手冊（前提是它們的手冊具有易於訪問和機器可讀的格式）。它為您提供了一個流暢快捷的界面，用於模糊搜索所有所選語言的文檔，以便盡可能用最少的按鍵找到所需信息。您可能想知道什麼是模糊搜索？模糊搜索是搜索與您輸入的內(nèi)容大致（並非完全）匹配的字符串。 Sublime Text和LightTable等編輯器在其命令搜索窗口中使用這種方法——輸入類似“sa”的內(nèi)容將為您提供“Save As..”，因為輸入與命令的縮寫匹配。輸入“delte”將提供包含“delta”和“delete”的結果，輸入“bgcp”甚至會提供“background clip”。這種類型的搜索允許對結果進行超快的微調(diào)，並且由於它們是實時的，因此您可以即時混合和匹配。

內(nèi)容

DevDocs下載您選擇的語言的參考手冊索引，將其吸收到您的本地緩存中，然後從中提供結果。這意味著您必須在每臺新機器上重新下載您選擇的語言，但是這種操作方式帶來的速度提升遠優(yōu)於使用遠程請求的舊式Ajax方法。請注意——目前，只有索引是離線的，您點擊的實際結果是從遠程位置提供的——例如，即使在離線狀態(tài)下它也會顯示在搜索結果中，您仍然需要互聯(lián)網(wǎng)訪問才能獲取JavaScript數(shù)組的文檔。

重要的是要注意，獲取的內(nèi)容僅限於官方內(nèi)容。這意味著用戶提交的條目（如評論和示例）將被忽略。

您可以通過在搜索查詢前添加“php”並按Tab或空格鍵（在移動設備上）來在特定語言範圍內(nèi)（例如，僅限PHP ）搜索DevDocs。這會將搜索模式切換為“僅限所選語言”。要退出此模式，只需退格即可。

開源和本地部署

DevDocs是開源的，並鼓勵社區(qū)以多種方式貢獻。首先，它位於GitHub上，並邀請用戶提交問題和改進代碼，就像任何優(yōu)秀的開源項目一樣。其次，DevDocs可以輕鬆地部署到本地，因此您可以運行或託管您自己的版本。例如，將其適應公司內(nèi)部系統(tǒng)的API非常容易。最後但並非最不重要的一點是，DevDocs使用Trello收集用戶對所需語言的反饋。 Trello是一個非常高效的基於團隊的任務列表，支持各種信息看板，人們可以在其中協(xié)作、討論和投票（主題）。 DevDocs使用這些卡片來收集對各個語言集成的投票。要參與，請查看此處。

DevDocs定期維護和更新，並提供各種方法來了解最新的更改：

• 如果你在更新日期之後將其打開，網(wǎng)站本身會彈出一個包含最新更改的彈出窗口。
• 有一個新聞通訊。
• 有一個Twitter帳戶。
• 甚至還有一個郵件列表。
• 有一個最新的變更日誌。

所有這些似乎都來自同一個來源，因此最好只訂閱其中一個。

其他優(yōu)點

DevDocs針對移動設備進行了全面優(yōu)化，並且具有高度響應能力。它打開速度很快，在移動設備上的工作方式與在桌面設備上完全相同。它的構建方式是網(wǎng)站的理想構建方式——在每臺設備上都能獲得流暢、快速且一致的體驗。 Thibaut Courouble確實做得非常出色。

如前所述，該應用程序可以作為Sublime Text和Brackets的插件安裝——這意味著您可以直接從編輯器中搜索所需的API。更多插件即將推出，最值得注意的是JetBrains產(chǎn)品插件。該應用程序還正在移植到一個獨立的零配置可下載離線版本。

DevDocs可以作為Firefox和Google Chrome的搜索引擎安裝，以及基本上任何其他支持OpenSearch的瀏覽器和應用程序。 OpenSearch是一組標準，允許某個資源將自身標識為搜索引擎。

還提供各種鍵盤快捷鍵，所有這些快捷鍵都非常直觀且非常有用，提供了真正流暢的體驗。

結論

如果您在閱讀本文之前沒有聽說過DevDocs，我強烈建議您嘗試一下。網(wǎng)絡迫切需要這種高度易用的資源，因此請廣而告之，幫助社區(qū)找到更好的解決方案來解決他們面臨的問題。如果您能夠貢獻，DevDocs位於GitTip上並支持PayPal捐贈——但可以說，最好的幫助方式是使用它，告訴其他人關於它，最重要的是，通過在GitHub上為該項目做出貢獻來改進它。

(以下為FAQ部分，已根據(jù)原文進行改寫和精簡，並保持原意)

DevDocs.io常見問題解答

• DevDocs.io與其他文檔平臺有何不同？ DevDocs.io以其簡潔、快速和用戶友好的界面而脫穎而出。它在一個快速、有序且可搜索的界面中整合了多個API文檔。與其他平臺不同，DevDocs.io允許用戶下載文檔以供離線使用，即使沒有互聯(lián)網(wǎng)連接也能訪問。它還支持鍵盤快捷鍵，方便導航。

• DevDocs.io是否免費使用？ 是的，DevDocs.io完全免費使用。這是一個開源項目，這意味著它不僅免費，而且用戶還可以參與其開發(fā)。這使其成為一個社區(qū)驅(qū)動的平臺，它會根據(jù)用戶的需求和反饋不斷發(fā)展。

• DevDocs.io如何確保其文檔的準確性？ DevDocs.io直接從官方來源提取其文檔，確保所提供的信息準確且最新。該平臺還允許用戶貢獻更正和更新，進一步提高文檔的準確性。

• 我可以在離線狀態(tài)下使用DevDocs.io嗎？ 是的，DevDocs.io的主要功能之一是其離線工作能力。用戶可以下載他們需要的文檔，隨時隨地訪問，無需互聯(lián)網(wǎng)連接。這使得DevDocs.io成為一個可靠的資源，尤其適合那些可能無法始終連接互聯(lián)網(wǎng)的開發(fā)者。

• 如何為DevDocs.io做出貢獻？ 作為一個開源項目，DevDocs.io歡迎用戶的貢獻。您可以通過報告錯誤、提出改進建議甚至編寫代碼來做出貢獻。所有貢獻所需的信息都可以在DevDocs.io的GitHub頁面上找到。

• DevDocs.io是否支持移動設備？ 是的，DevDocs.io完全響應式，並且在移動設備上運行良好。這意味著您可以從智能手機或平板電腦訪問所需的文檔，使其成為移動開發(fā)者的多功能工具。

• DevDocs.io上的文檔更新頻率如何？ DevDocs.io努力使其文檔盡可能最新。更新頻率取決於文檔的來源。例如，如果官方文檔更新了，DevDocs.io將盡快反映這些更改。

• 我可以自定義DevDocs.io的界面嗎？ 是的，DevDocs.io允許用戶根據(jù)自己的喜好自定義界面。您可以選擇要顯示哪些文檔，調(diào)整佈局，並在淺色和深色主題之間切換。

• DevDocs.io是否支持所有編程語言？ DevDocs.io支持各種編程語言和技術，但它可能並非涵蓋所有語言。該平臺專注於業(yè)界最常用的語言和技術。

• DevDocs.io用戶是否有社區(qū)或論壇？ 雖然DevDocs.io沒有專門的社區(qū)或論壇，但用戶可以通過該平臺的GitHub頁面進行互動和貢獻。在這裡，他們可以報告問題，提出改進建議，並與其他用戶和貢獻者進行討論。

所有圖片鏈接均保留原樣。

以上是看Devdocs.io的詳細內(nèi)容。更多資訊請關注PHP中文網(wǎng)其他相關文章！