https://github.com/rodaine/lobster-keys
Keybindings userscript for lobste.rs
https://github.com/rodaine/lobster-keys
keybindings userscript
Last synced: about 1 month ago
JSON representation
Keybindings userscript for lobste.rs
- Host: GitHub
- URL: https://github.com/rodaine/lobster-keys
- Owner: rodaine
- License: mit
- Created: 2019-05-25T21:17:58.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T17:09:42.000Z (over 1 year ago)
- Last Synced: 2025-03-21T00:37:07.876Z (over 1 year ago)
- Topics: keybindings, userscript
- Language: TypeScript
- Size: 303 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lobster Keys
_A userscript providing keybindings for [lobste.rs](https://lobste.rs)_
## Installation
[Userscripts][userscript] can be easily managed on all major browsers with extensions like [TamperMonkey][TamperMonkey].
### GreasyFork
1. Navigate to [Lobster Keys][GreasyFork] on Greasy Fork
1. Click the `Install This Script` button
1. Follow the instructions from your UserScript manager to complete the process.
### Manually
1. Navigate to [the user script](/dist/lobster-keys.js)
1. Copy the full source of the script
1. Create a new script in your manager, paste the source, and save.
## Key Bindings
On all pages with a story list (the homepage, recent, saved, search, etc.), the following keybindings are enabled:
### Page Actions
| Key | Action |
| --- | ------ |
| `[` | Open Previous Page |
| `]` | Open Next Page |
| `J` | Select Next Story |
| `K` | Select Previous Story |
### Story Actions
> Only apply with a story selected
| Key | Action |
| --- | ------ |
| `Enter` | Open Story URL |
| `A` | Open Author/Poster Profile |
| `C` | Open Comments |
| `D` | Open Domain Search |
| `F` | Open Flag Dropdown |
| `H` | Toggle Hide |
| `S` | Toggle Save |
| `U` | Toggle Upvote |
## Development
```sh
# bootstrap
npm install
# tests
npm run test
# build
npm run build
# watch mode
npm run build -- -w
```
[GreasyFork]: https://greasyfork.org/en/scripts/383557-lobster-keys
[TamperMonkey]: https://www.tampermonkey.net/
[userscript]: https://en.wikipedia.org/wiki/Userscript