Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

navi --tldr not working even with rust client tlrc #902

Closed
TwiggyWan opened this issue Jun 28, 2024 · 6 comments · Fixed by #916
Closed

navi --tldr not working even with rust client tlrc #902

TwiggyWan opened this issue Jun 28, 2024 · 6 comments · Fixed by #916
Labels
bug Something isn't working

Comments

@TwiggyWan
Copy link

TwiggyWan commented Jun 28, 2024

hi
Describe the bug

navi --tldr says :

    
    Note:
    Please make sure you're using a version that supports the --markdown flag.
    If you are already using a supported version you can ignore this message. 
    The tldr client written in C (the default one in Homebrew) doesn't support markdown files, so navi can't use it.
    The client written in Rust is recommended. The one available in npm works, too.

So I installed tlrc, expecting it to work. but it doesnt have a --markdown flag.

To Reproduce
Steps to reproduce the behavior:

brew install navi
brew install tlrc
navi --tldr docker

Expected behavior
According to the hint message navi --tldr should be supported but it is not. Please consider to change the hint text.

Versions:

  • OS: [e.g. macOS, WSL ubuntu, ubuntu] : debian bookworm, navi 2.23.0 & tlrc (v1.9.2 (implementing the tldr client specification v2.2)) installed through homebrew
  • Shell Version [replace this text with the output of sh --version]: GNU bash, version 5.2.15(1)-release (x86_64-pc-linux-gnu)

Additional context
thanks

@TwiggyWan TwiggyWan added the bug Something isn't working label Jun 28, 2024
Copy link

welcome bot commented Jun 28, 2024

Thanks for opening your first issue here! In case you're facing a bug, please update navi to the latest version first. Maybe the bug is already solved! :)

@OlaoluwaM
Copy link

Same issue with v2.23.0

image

@denisidoro
Copy link
Owner

The rust client I tested years ago was tealdeer. I haven't tested tlrc yet.

@vakili
Copy link

vakili commented Aug 1, 2024

The issue also occurs on my system with tealdeer (latest version, 1.6.1). I believe the reason is that navi attempts to pass the --markdown flag to the tldr client, and this flag is not supported. The working flag is --raw, as per the man page of tlrc. This issue is present even when the tealdeer option is set to true in the navi config, which as I understand is supposed to enforce use the --raw flag.

@miyl
Copy link

miyl commented Sep 27, 2024

Regarding tealdeer it was supposedly fixed in #873, where the config option was added, however this commit was added in January this year, while the latest release of navi was December last year, so the fix isn't out yet, sadly.

Well, unless you build your version of navi from the master branch.

Hopefully a new version is soon released.

@TwiggyWan
Copy link
Author

Hi, in that case i'm happy to consider this issue as resolved if the docs make it a bit clearer which tldr client to install, which is what I tried to do with pr #916 .

thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants