https://github.com/hardpixel/devdocs-desktop

GTK3 application for DevDocs API documentation browser.
https://github.com/hardpixel/devdocs-desktop

devdocs gtk python webkit

Last synced: about 2 months ago
JSON representation

GTK3 application for DevDocs API documentation browser.

• Host: GitHub
• URL: https://github.com/hardpixel/devdocs-desktop
• Owner: hardpixel
• License: gpl-3.0
• Created: 2016-12-25T00:57:15.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-04-30T19:24:01.000Z (over 1 year ago)
• Last Synced: 2024-08-14T10:15:38.712Z (5 months ago)
• Topics: devdocs, gtk, python, webkit
• Language: Python
• Size: 1.11 MB
• Stars: 126
• Watchers: 9
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
## DevDocs Desktop

![DevDocs](https://github.com/freeCodeCamp/devdocs) desktop application created with GTK3 and Python.

![DevDocs Desktop](https://github.com/hardpixel/devdocs-desktop/raw/master/screenshot.png)

## Command Line

To launch the application from the terminal use `devdocs-desktop [STRING]`.

If a string is provided, the application will open the first available result page.

## Requirements

```

python python-gobject python-dbus webkit2gtk

```

## Installation

Arch Linux: [AUR Package](https://aur.archlinux.org/packages/devdocs-desktop)

Other distros: 

Download the source code as `.tar.gz` or `.zip` and extract. Run in terminal 

```

python3 devdocs_desktop.py

```

Furthermore, you can make this as shortcut as you wish.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/devdocs-desktop.

## License

DevDocs Desktop is available as open source under the terms of the [GPLv3](http://www.gnu.org/licenses/gpl-3.0.en.html)