Skip to content

Conversation

@piekstra
Copy link
Contributor

[12]

Add document viewer mode for viewing README.md and CHANGELOG.md files from installed plugins.

Also resolves #5 (README viewer) since both features share the same implementation.

Summary

  • Add ? key binding to view plugin README
  • Add C key binding to view plugin CHANGELOG
  • Scrollable document view with vim-style navigation (j/k, pgup/pgdn, g for top)
  • Uses glamour for markdown rendering
  • Supports multiple filename variants (README.md, Readme.md, CHANGELOG.md, HISTORY.md, etc.)
  • Unified document viewer infrastructure that can be extended for other doc types

Key bindings in document view

  • j/↓ - Scroll down
  • k/↑ - Scroll up
  • PgDn/Ctrl+d - Page down
  • PgUp/Ctrl+u - Page up
  • g - Go to top
  • q/Esc/?/C - Close viewer

Test plan

  • Select an installed plugin and press ? to view README
  • Verify README renders with markdown formatting
  • Press C to view CHANGELOG (if plugin has one)
  • Test scrolling with various key bindings
  • Press Esc or q to close viewer

Add document viewer mode that can display either README.md or CHANGELOG.md
from installed plugins.

- Press ? to view README
- Press C to view CHANGELOG
- Scrollable view with vim-style navigation
- Uses glamour for markdown rendering
- Supports multiple filename variants (README.md, Readme.md, etc.)

[12]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Plugin README viewer

2 participants