A Look at DevDocs.io

DevDocs.io: Programmer's documentation tool, say goodbye to tedious searches!

Core points:

• DevDocs.io is a web application that provides quick access to numerous front-end languages ​​and libraries reference manuals. Its interface is efficient and fast, and it has real-time fuzzy search function.
• The platform only integrates official content, ignoring user-submitted comments and examples. It is open source and encourages community contribution through GitHub. Users can even deploy it locally to suit specific needs, such as the company's internal system API.
• DevDocs.io is fully optimized for mobile devices and provides multiple ways to keep it updated. It can be installed as a plugin for Sublime Text and Brackets, as well as a search engine for Firefox and Google Chrome. It also offers a variety of intuitive keyboard shortcuts for a smooth user experience.

Do you often go through the following coding process?

1. Requires [insert programming language] function definitions and examples.
2. Google search for this function.
3. Click on the first result, if you are not lucky, it is w3schools, otherwise it is the online manual of the language you are using.
4. Realize that you need a demonstration and explanation of another function.
5. Return to Google search instead of using searches on language websites, because it is inexplicably awful and slower than a new Google search after reloading the tab.
6. Repeat the above steps.

As a developer who uses a lot of web technology, I often encounter this situation. It has become much more difficult than ever to find technical definitions of functions or statements—not in terms of complexity, but in terms of wasted time. Wouldn't it be great if we could have all the development documents in one place, in a nice, offline access-enabled interface, and have super fast fuzzy search for any language? DevDocs.io came into being.

What is DevDocs.io?

DevDocs is a web application designed to give you quick access to reference manuals for almost all front-end languages ​​and libraries. It lists all APIs and their official documentation for a given selected language, in an easy to browse and view format without the unnecessary menus and cheesy styles that official websites such as php.net are trying to implement.

This is an open source web application powered by Ajax, with syntax highlighting, and can even be used as a Chrome extension or a plug-in for Sublime Text or Brackets.

What can DevDocs.io do?

It aggregates reference manuals for all popular languages ​​(provided that their manuals are in an easy to access and machine-readable format). It provides you with a smooth and quick interface for blurring the search for documents in all selected languages ​​so that you can find the information you need with the least keys possible. You might be wondering what is fuzzy search? Fuzzy search is a search for a string that roughly (not exactly) matches what you entered. Editors like Sublime Text and LightTable use this method in their command search windows - entering something like "sa" will give you "Save As.." because the input matches the abbreviation of the command. Entering "delte" will provide results containing "delta" and "delete", and entering "bgcp" will even provide "background clip". This type of search allows for super fast fine-tuning of results, and since they are real-time, you can mix and match instantly.

Content

DevDocs downloads the reference manual index for the language of your choice, absorbs it into your local cache, and then provides the results from it. This means you have to re-download the language of your choice on each new machine, but this way of doing it brings much better speed improvements than the old Ajax method that uses remote requests. Note – Currently, only the index is offline and the actual result of your click is provided from a remote location – for example, even if it is offline it will be displayed in the search results, you still need internet access to get the JavaScript array documentation.

It is important to note that the content obtained is limited to official content. This means that the entries submitted by the user (such as comments and examples) will be ignored.

You can add "php" before the search query and press Tab or Space bar (on mobile) to a specific language range (e.g., PHP only) by adding "php" before the search query and pressing

or

spacebar (on mobile) (only). ) Search for DevDocs. This switches the search mode to "Selected Languages ​​Only". To exit this mode, just backspace.

Open source and local deployment DevDocs are open source and encourages the community to contribute in a variety of ways. First, it is located on GitHub and invites users to submit questions and improve code, just like any good open source project. Second, DevDocs can be easily deployed locally, so you can run or host your own version. For example, adapting it to the API of the company's internal system is very easy. Last but not least, DevDocs uses Trello to collect user feedback on the language they want. Trello is a very efficient team-based task list that supports a variety of information boards where people can collaborate, discuss and vote (topic). DevDocs use these cards to collect votes for integrations in each language. To participate, check out here.

DevDocs are regularly maintained and updated and offer various ways to keep up with the latest changes:

• If you open it after the update date, the website itself will pop up with the latest changes.
• There is a newsletter.
• Have a Twitter account.
• There is even a mailing list.
• There is a latest change log.

All of these seem to come from the same source, so it's better to subscribe to only one of them.

Other advantages

DevDocs is fully optimized for mobile devices and is highly responsive. It opens very quickly and works exactly the same way it does on a mobile device as it does on a desktop device. It is built in a way that is ideal for a website – a smooth, fast and consistent experience on every device. Thibaut Courouble does a great job.

As mentioned earlier, the application can be installed as a plugin for Sublime Text and Brackets—which means you can search for the required API directly from the editor. More plugins are coming soon, and the most notable one is the JetBrains product plugin. The app is also being ported to a standalone zero-configurable offline version.

DevDocs can be installed as a search engine for Firefox and Google Chrome, as well as basically any other browser and app that supports OpenSearch. OpenSearch is a set of standards that allow a resource to identify itself as a search engine.

also offers a variety of keyboard shortcuts, all of which are very intuitive and very useful, providing a truly smooth experience.

Conclusion

If you haven't heard of DevDocs before reading this article, I highly recommend you give it a try. The network urgently needs such highly easy-to-use resources, so please advise it to help the community find better solutions to the problems they face. If you can contribute, DevDocs is on GitTip and supports PayPal donations – but arguably the best way to help is to use it, tell others about it, and most importantly, by contributing to the project on GitHub Improve it.

(The following is the FAQ part, which has been rewritten and streamlined according to the original text, and the original intention is maintained)

DevDocs.io FAQ

• How is DevDocs.io different from other document platforms? DevDocs.io stands out for its simplicity, fast and user-friendly interface. It integrates multiple API documents in a fast, ordered and searchable interface. Unlike other platforms, DevDocs.io allows users to download documents for offline use, accessible even without an internet connection. It also supports keyboard shortcuts for easy navigation.

• Is DevDocs.io free to use? Yes, DevDocs.io is completely free to use. This is an open source project, which means it is not only free, but users can also participate in its development. This makes it a community-driven platform that evolves based on user needs and feedback.

• How does DevDocs.io ensure the accuracy of its documentation? DevDocs.io extracts its documents directly from official sources, ensuring that the information provided is accurate and up-to-date. The platform also allows users to contribute corrections and updates to further improve the accuracy of documents.

• Can I use DevDocs.io offline? Yes, one of the main features of DevDocs.io is its ability to work offline. Users can download the documents they need and access them anytime, anywhere without an internet connection. This makes DevDocs.io a reliable resource, especially for developers who may not be able to always connect to the internet.

• How to contribute to DevDocs.io? As an open source project, DevDocs.io welcomes users' contributions. You can contribute by reporting bugs, making suggestions for improvements, and even writing code. All the information required for contributions can be found on the GitHub page of DevDocs.io.

• DevDocs.io supports mobile devices? Yes, DevDocs.io is fully responsive and works well on mobile devices. This means you can access the required documents from your smartphone or tablet, making it a versatile tool for mobile developers.

• How often do documents are updated on DevDocs.io? DevDocs.io strives to keep its documentation as up-to-date as possible. The frequency of update depends on the source of the document. For example, if the official documentation is updated, DevDocs.io will reflect these changes as soon as possible.

• Can I customize the interface of DevDocs.io? Yes, DevDocs.io allows users to customize the interface according to their preferences. You can choose which documents you want to display, adjust the layout, and switch between light and dark themes.

• Does DevDocs.io support all programming languages? DevDocs.io supports a variety of programming languages ​​and technologies, but it may not cover all languages. The platform focuses on the most commonly used languages ​​and technologies in the industry.

• DevDocs.io users have a community or forum? Although DevDocs.io does not have a dedicated community or forum, users can interact and contribute through the platform's GitHub page. Here they can report issues, make suggestions for improvements, and discuss with other users and contributors.

All image links are left as is.

The above is the detailed content of A Look at DevDocs.io. For more information, please follow other related articles on the PHP Chinese website!