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 3.2.1, 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. Table of Contents: Quick Start Vision App Scraper Commands Contributing Documentation Related Projects License Questions? Quick Start Please reach out to the community on Discord if you would like to join the team! We are currently searching for maintainers If you would like to see a donation link for the application here, please include one in the AppStream data.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. You can specify the URL to a nicer one by shipping an AppStream metainfo file. The screenshot for devdocs-desktop has been automatically taken during a fully automated test. There is an online tool that makes it easy to make one. Improve this entry by shipping an AppStream metainfo file inside the AppImage in the usr/share/metainfo directory. Tools like appimagetool and linuxdeployqt can do this for you easily. zsync file so that it can be updated using AppImageUpdate. Please consider to add update information to the devdocs-desktop AppImage and ship a. Pro Tips for further enhancing the devdocs-desktop AppImage Great! Here are some ideas on how to make it even better. Thanks for distributing devdocs-desktop in the AppImage format for all common Linux distributions. If you would like to have the executable bit set automatically, and would like to see devdocs-desktop and other AppImages integrated into the system (menus, icons, file type associations, etc.), then you may want to check the optional appimaged daemon. If you would like to update to a new version, simply download the new devdocs-desktop AppImage. This is entirely optional and currently needs to be configured by the user. If you want to restrict what devdocs-desktop can do on your system, you can run the AppImage in a sandbox like Firejail. Then double-click the AppImage in the file manager to open it. Use at your own risk!ĭownload the devdocs-desktop AppImage and make it executable using your file manager or by entering the following commands in a terminal: Follow these instructions only if you trust the developer of the software. This is a Linux security feature.īehold! AppImages are usually not verified by others. However, they need to be marked as executable before they can be run. Unlike other applications, AppImages do not need to be installed before they can be used. Running devdocs-desktop on Linux without installation Most AppImages run on recent versions of Arch Linux, CentOS, Debian, Fedora, openSUSE, Red Hat, Ubuntu, and other common desktop distributions. No system libraries or system preferences are altered. Download an application, make it executable, and run! No need to install. Awesome!ĪppImages are single-file applications that run on most Linux distributions. Devdocs-desktop is available as an AppImage which means "one app = one file", which you can download and run on your Linux system while you don't need a package manager and nothing gets changed in your system.
0 Comments
Leave a Reply. |