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

核心要點(diǎn)：

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

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

1. 需要[插入編程語(yǔ)言]函數(shù)定義和示例。
2. 谷歌搜索該函數(shù)。
3. 點(diǎn)擊第一個(gè)結(jié)果，如果運(yùn)氣不好，就是w3schools，否則就是你正在使用的語(yǔ)言的在線手冊(cè)。
4. 意識(shí)到你需要另一個(gè)函數(shù)的演示和解釋。
5. 返回谷歌搜索，而不是使用語(yǔ)言網(wǎng)站上的搜索，因?yàn)樗涿畹卦愀馇冶戎匦录虞d標(biāo)簽頁(yè)后的新谷歌搜索還要慢。
6. 重復(fù)以上步驟。

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

DevDocs.io是什么？

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

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

DevDocs.io能做什么？

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

內(nèi)容

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

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

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

開(kāi)源和本地部署

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

DevDocs定期維護(hù)和更新，并提供各種方法來(lái)了解最新的更改：

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

所有這些似乎都來(lái)自同一個(gè)來(lái)源，因此最好只訂閱其中一個(gè)。

其他優(yōu)點(diǎn)

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

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

DevDocs可以作為Firefox和Google Chrome的搜索引擎安裝，以及基本上任何其他支持OpenSearch的瀏覽器和應(yīng)用程序。OpenSearch是一組標(biāo)準(zhǔn)，允許某個(gè)資源將自身標(biāo)識(shí)為搜索引擎。

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

結(jié)論

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

(以下為FAQ部分，已根據(jù)原文進(jìn)行改寫(xiě)和精簡(jiǎn)，并保持原意)

DevDocs.io常見(jiàn)問(wèn)題解答

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

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

• DevDocs.io如何確保其文檔的準(zhǔn)確性？ DevDocs.io直接從官方來(lái)源提取其文檔，確保所提供的信息準(zhǔn)確且最新。該平臺(tái)還允許用戶貢獻(xiàn)更正和更新，進(jìn)一步提高文檔的準(zhǔn)確性。

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

• 如何為DevDocs.io做出貢獻(xiàn)？ 作為一個(gè)開(kāi)源項(xiàng)目，DevDocs.io歡迎用戶的貢獻(xiàn)。您可以通過(guò)報(bào)告錯(cuò)誤、提出改進(jìn)建議甚至編寫(xiě)代碼來(lái)做出貢獻(xiàn)。所有貢獻(xiàn)所需的信息都可以在DevDocs.io的GitHub頁(yè)面上找到。

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

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

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

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

• DevDocs.io用戶是否有社區(qū)或論壇？ 雖然DevDocs.io沒(méi)有專門(mén)的社區(qū)或論壇，但用戶可以通過(guò)該平臺(tái)的GitHub頁(yè)面進(jìn)行互動(dòng)和貢獻(xiàn)。在這里，他們可以報(bào)告問(wèn)題，提出改進(jìn)建議，并與其他用戶和貢獻(xiàn)者進(jìn)行討論。

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

以上是看Devdocs.io的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！