{"id":49888371,"url":"https://github.com/zemse/md-tui","last_synced_at":"2026-05-15T19:34:03.592Z","repository":{"id":355867364,"uuid":"1229985351","full_name":"zemse/md-tui","owner":"zemse","description":"Terminal markdown reader with mouse support, clickable links and task lists, fuzzy search, and a directory browser.","archived":false,"fork":false,"pushed_at":"2026-05-05T17:04:41.000Z","size":66,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-05T17:20:50.339Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zemse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-05T15:09:06.000Z","updated_at":"2026-05-05T17:04:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/zemse/md-tui","commit_stats":null,"previous_names":["zemse/md-tui"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/zemse/md-tui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemse%2Fmd-tui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemse%2Fmd-tui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemse%2Fmd-tui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemse%2Fmd-tui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zemse","download_url":"https://codeload.github.com/zemse/md-tui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zemse%2Fmd-tui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33076228,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-15T11:35:32.926Z","status":"ssl_error","status_checked_at":"2026-05-15T11:35:31.362Z","response_time":103,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-05-15T19:34:02.845Z","updated_at":"2026-05-15T19:34:03.583Z","avatar_url":"https://github.com/zemse.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# md\n\nA terminal markdown reader. Built with Rust + [ratatui](https://ratatui.rs).\n\n## Install\n\n```sh\ncargo install md-tui-rs\n```\n\nOr from a local checkout:\n\n```sh\ncargo install --path .\n```\n\nThe binary is named `md`.\n\n## Use\n\n```sh\nmd                # browse the current directory\nmd README.md      # open a file\nmd docs/          # browse a directory\ncat NOTES.md | md # read from stdin\n```\n\n## Features\n\n- **Mouse-aware** — wheel to scroll, click links to follow, hover for highlight, click `‹ Back` in the header.\n- **Clickable task lists** — click `- [ ]` / `- [x]` to toggle; the file is rewritten in place.\n- **Native text selection** — press `m` to drop mouse capture and drag-select with the terminal.\n- **In-document search** — `/` in Reader, then `n`/`N` to step matches; `T` for fuzzy file search.\n- **Directory browser** — full-screen one-level listing; `Enter`/`→` opens or descends, `Esc`/`←` walks back; gitignore-aware.\n- **Wiki links** — `[[Page]]` / `[[Page|Display]]` resolve relative to the current file or anywhere under the launch root.\n- **Image rendering** — kitty / iTerm2 / sixel / unicode halfblocks via `ratatui-image` when supported.\n- **`$EDITOR` integration** — press `e` to edit the current file; the TUI restores after the editor exits.\n- **Header bar** — current path with a clickable back button.\n- **Proportional scrollbar** — thumb size reflects how much of the document is visible.\n- **History** — `h`/`l` (or `b`/`f`) walk back and forward; cursor and scroll position are remembered.\n- **Themes** — Catppuccin Mocha / Latte; auto-selects from `COLORFGBG`, override with `-s dark|light`.\n- **GitHub-flavored** — tables, strikethrough, footnotes, task lists, code-block syntax highlighting (syntect), heading anchors.\n\n## Keys\n\n| Key            | Action                                                 |\n| -------------- | ------------------------------------------------------ |\n| `j` / `k`      | Scroll down / up                                       |\n| `d` / `u`      | Half page down / up                                    |\n| `g` / `G`      | Top / bottom                                           |\n| `Tab` / `S-Tab`| Next / previous link                                   |\n| `Enter` / `→`  | Open file / enter directory / follow link              |\n| `Esc` / `←`    | Back (parent directory or previous view)               |\n| `/`            | In-doc search (Reader) / fuzzy file search (Browser)   |\n| `n` / `N`      | Next / previous in-doc match                           |\n| `T`            | Fuzzy file search (anywhere)                           |\n| `o`            | Open focused link in system browser                    |\n| `e`            | Edit current file in `$EDITOR`                         |\n| `h` / `l`      | Back / forward in history                              |\n| `m`            | Toggle mouse capture (drag-to-select)                  |\n| `?`            | Help                                                   |\n| `q` / `Ctrl-C` | Quit                                                   |\n\n## Config\n\nOptional `md/config.toml` under your platform config dir\n(`~/.config/md/config.toml` on Linux, `~/Library/Application Support/md/config.toml`\non macOS):\n\n```toml\ntheme = \"dark\"        # \"dark\" | \"light\" | \"auto\"\nwidth = 0             # word-wrap width; 0 = terminal width\nline_numbers = false\n```\n\nCLI flags override the config: `-s dark|light|auto`, `-w 100`, `-l`.\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzemse%2Fmd-tui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzemse%2Fmd-tui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzemse%2Fmd-tui/lists"}