prezto icon indicating copy to clipboard operation
prezto copied to clipboard

Add interactive readme command

Open lodagro opened this issue 4 years ago • 5 comments

Description

Feature request: add a new function (maybe named zprezto-readme) which allows easy access to the modules README files.

Expected behavior

For example zprezto-readme git will show the git module README file. If bat is available use bat -p otherwise fall back to cat or more.

lodagro avatar Oct 15 '19 08:10 lodagro

I like this idea, but I don't think I'll have time to develop it any time in the near future.

belak avatar Oct 16 '19 16:10 belak

Alternatively, it may be possible to export these as man pages and add a directory to the $MANPATH

belak avatar Jan 20 '20 16:01 belak

@belak I like the man pages idea, let me see if I can do something about it. Do you propose we have a manpage for each module? Or just the main README?

srijanshetty avatar Feb 17 '20 07:02 srijanshetty

My idea was to have it for each module.

lodagro avatar Feb 19 '20 09:02 lodagro

I think I'd imagine something similar to how git works, where there's a main git man page, but also git-commit for sub-commands. Maybe we could do that for modules?

belak avatar Mar 19 '20 18:03 belak