2020-08-15 22:25:43 +02:00
|
|
|
# qute-gemini
|
|
|
|
|
|
2021-03-05 12:29:00 +01:00
|
|
|
A [qutebrowser](https://qutebrowser.org) userscript that allows viewing
|
|
|
|
|
[Gemini](https://gemini.circumlunar.space) pages. The pages are converted to
|
|
|
|
|
HTML by the script and then displayed in qutebrowser.
|
2020-08-15 22:25:43 +02:00
|
|
|
|
|
|
|
|
The script borrows code from [gcat](https://github.com/aaronjanse/gcat), many
|
|
|
|
|
thanks to its authors!
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2021-03-05 12:29:00 +01:00
|
|
|
1. Copy `qute-gemini` and `qute-gemini-tab` into
|
2020-08-15 22:25:43 +02:00
|
|
|
`~/.local/share/qutebrowser/userscripts/`.
|
|
|
|
|
|
2021-03-05 12:29:00 +01:00
|
|
|
2. Add the following lines to `~/.config/qutebrowser/config.py`
|
2020-08-15 22:25:43 +02:00
|
|
|
|
|
|
|
|
``` python
|
|
|
|
|
config.bind('f', 'hint links userscript qute-gemini')
|
|
|
|
|
config.bind('F', 'hint links userscript qute-gemini-tab')
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The script only processes `gemini://` URLs and opens all other URLs using
|
|
|
|
|
qutebrowser, so it should be safe to replace the default hint keybindings.
|
|
|
|
|
|
2021-03-05 12:29:00 +01:00
|
|
|
3. Re-source the qutebrowser config and visit the
|
|
|
|
|
[Gemini spec homepage](gemini://gemini.circumlunar.space)
|
|
|
|
|
to ensure that everything works.
|
2020-08-15 22:25:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Bugs and ugly stuff
|
|
|
|
|
|
2021-03-05 12:29:00 +01:00
|
|
|
- Visiting `gemini://` URLs by clicking on them does not work, only opening via
|
2020-08-15 22:25:43 +02:00
|
|
|
the keybinding is possible.
|
|
|
|
|
- I couldn't find a way to pass arbitrary arguments to qutebrowser userscripts.
|
|
|
|
|
My solution to being able to open links in the same or a different tab was to
|
|
|
|
|
call the script using a different name.
|
2021-03-05 12:29:00 +01:00
|
|
|
- The Gemini to HTML conversion has several bugs. A notable example is HTML
|
2020-08-15 22:25:43 +02:00
|
|
|
tags in the Gemini text, such as in section 5.5.1
|
|
|
|
|
[here](gemini://gemini.circumlunar.space/docs/specification.gmi). No code
|
2021-03-05 12:29:00 +01:00
|
|
|
tags are put around them when converting to HTML, so they end up being
|
|
|
|
|
interpreted as HTML tags by qutebrowser.
|
|
|
|
|
- Probably tons of usability issues.
|
2020-08-15 22:25:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2021-03-05 11:55:53 +01:00
|
|
|
Copyright 2019 Solderpunk, 2020 Aaron Janse, 2020 petedussin, 2020-2021 Sotiris Papatheodorou
|
|
|
|
|
|
|
|
|
|
This program is Free Software: You can use, study share and improve it at your
|
|
|
|
|
will. Specifically you can redistribute and/or modify it under the terms of the
|
|
|
|
|
[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as
|
|
|
|
|
published by the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
|
|
gcat is distributed under the BSD 2-Clause license.
|
2020-08-15 22:25:43 +02:00
|
|
|
|
