Maximize the use of caching and other performance optimizations.Improve the quality, speed, and order of search results.# Finally, start a DevDocs container (access docker run -name devdocs -d -p 9292:9292 thibaut/devdocs VisionĭevDocs aims to make reading and searching reference documentation fast, easy and enjoyable. To stay informed about new releases, be sure to watch this repository.Īlternatively, DevDocs may be started as a Docker container:ĭocker build -t thibaut/devdocs. Note: there is currently no update mechanism other than git pull origin main to update the code and thor docs:download -installed to download the latest version of the docs.
DOWNLOAD DEVDOCS INSTALL
To download and install all documentation this project has available, run thor docs:download -all. To update all downloaded documentations, run thor docs:download -installed. You can see the list of available documentations and versions by running thor docs:list. The thor docs:download command is used to download pre-generated documentations from DevDocs's servers (e.g. Once you have these installed, run the following commands:įinally, point your browser at localhost:9292 (the first request will take a few seconds to compile the assets). It's up-to-date and works offline out-of-the-box.ĭevDocs is made of two pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.ĭevDocs requires Ruby 2.7.4, libcurl, and a JavaScript runtime supported by ExecJS (included in OS X and Windows Node.js on Linux).
Unless you wish to contribute to the project, we recommend using the hosted version at devdocs.io. Please reach out to the community on Discord if you would like to join the team! We are currently searching for maintainers DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.ĭevDocs was created by Thibaut Courouble and is operated by freeCodeCamp.
0 kommentar(er)
