Documentation

tags: [ #lem2o, #doc ]

Getting Started

This page covers the installation, initial setup and basic usage of lemmoxide.

Install From The Source

git clone https://codeberg.org/lemmoxide/lemmoxide.git

cd lemmoxide
cargo build --release

Usage

Configuration (config.toml)

User configuration is done by editing ~/.config/lemmoxide/config.toml :

[server]
url = "some lemmy instance"
username = "some_user"
password = "some_password"

User Interface - How Does It Look?

Wide Terminal Layout (content_area.width >= 90)

🐭 lemmoxide v0.1.0 - 🌐(- not connected -)

┌──────────────────────────── Posts (List) ─────────────────────────────┐┌─────────────────────────────────── Posts (Detail) ───────────────────────┐
│ > Post title 1 [42]                                                   ││  Post title 1                                                            │
│   !community1                                                         ││  Community: !community1                                                  │
│                                                                       ││  Comments: 42                                                            │
│   Post title 2 [18]                                                   ││                                                                          │
│   !community2                                                         ││  Markdown body rendered here...                                          │
│                                                                       ││  Link example: https://example.org                                       │
│                                                                       ││  Another paragraph...                                                    │
│                                                                       ││                                                                          │
│                                                                       ││  <EOP>                                                                   │
└───────────────────────────────────────────────────────────────────────┘└──────────────────────────────────────────────────────────────────────────┘

Posts: <count>

Narrow Terminal Layout (content_area.width < 90)

🐭 lemmoxide v0.1.0 - 🌐(- not connected -)

┌──────────────────────────── Posts (List) ────────────────────────────┐
│ > Post title 1 [42]                                                  │
│   !community1                                                        │
│                                                                      │
│   Post title 2 [18]                                                  │
│   !community2                                                        │
└──────────────────────────────────────────────────────────────────────┘
┌──────────────────────────── Posts (Detail) ──────────────────────────┐
│  Post title 1                                                        │
│  Community: !community1                                              │
│  Comments: 42                                                        │
│                                                                      │
│  Markdown body rendered here...                                      │
│  Highlighted links are underlined                                    │
│                                                                      │
│  <EOP>                                                               │
└──────────────────────────────────────────────────────────────────────┘

Posts: <count>

Keybindings

Shortcut Key(s)Purpose
qExit the application
Down or jIf focus is on Post List: select next post
Down or jIf focus is on Post Detail: scroll post content down
Up or kIf focus is on Post List: select previous post
Up or kIf focus is on Post Detail: scroll post content up
Left or hMove focus to Post List pane
Right or lMove focus to Post Detail pane
TabToggle focus between Post List and Post Detail
nIn Post Detail: select next detected link
pIn Post Detail: select previous detected link
oOpen currently selected link in external browser (only when a link is selected)
sCycle sort options
SOpen dialog to select a sort option
tCycle listing types
TOpen dialog to select a listing type
vView post on lemmy instance
VView linked post content directly if available