Developer’s gripe: Constantly switching between multiple API documents, bookmarks in the browser for various language-related interface documentation.

I stumbled across DevDocs[1], an open source project on Github, which is a comprehensive web site for all developing-related documents, with search, offline access, mobile version support, dark themes, keyboard shortcuts, and more.

Access: devdocs. IO /

What you need to know before you visit:

1. Open preference[1] Settings, check the list of documents you want to access, and set themes

2. You can even skip the mouse and use the keyboard keys to see the shortcut description [2]3. Support fuzzy search, for example, “BGCP” can search for “background-clip” 4. 5. Use your browser’s address bar to search for a specific document, as it is embedded in most browsers. 6.DevDocs supports offline access on mobile and can be installed in Google Chrome

Because it is open source and can be installed locally, the open source application consists of two parts: Ruby is responsible for generating metadata and documentation, and Javascript is responsible for building the app website.

DevDocs requires a Ruby 2.6.x environment, the libcurl library, and a Javascript runtime supported by ExecJS. Once installed, run the following command:

git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
gem install bundler
bundle install
bundle exec thor docs:download --default
bundle exec rackup
Copy the code

Finally, access localhost:9292 in the browser. [4] The first access is slow and static code is compiled.

Or save the trouble of environment installation, directly use Docker to install, the command is as follows:

# First, build the image
git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
docker build -t thibaut/devdocs .

# Finally, start a DevDocs container (access http://localhost:9292)
docker run --name devdocs -d -p 9292:9292 thibaut/devdocs
Copy the code

If you have a good idea and know how to program, you can submit code to open source.

In addition, the following are some projects developed by developers based on open source porting, which have made many IDE plug-ins, such as devdocs for VSCode [5], Atom Plugin [6], Sublime Text Plugin [7], etc.

The References [1] DevDocs: github.com/freeCodeCam… [2] preference: devdocs. IO/Settings [3] shortcut: devdocs. IO /help#shortc… [4] localhost: 9292: http://localhost:9292/ [5] devdocs for VS Code: marketplace.visualstudio.com/items?itemN… [6] Atom plugin: Atom. IO/packages/DE… [7] Sublime does Text plugin: sublime.wbond.net/packages/De…

For more articles by the author, focus on space programming of the public