Tldr: Clients which support private pages

Created on 17 Sep 2019  路  10Comments  路  Source: tldr-pages/tldr

Hi all

I tried some tldr clients and noticed that the ones I tried do not support private pages.

With private pages I mean pages for a command or even better just additional parts (examples) to an existing page, which are specific for personal use and not appropriate to be added to the public repo.

I was wondering, are there clients which support such private pages/parts?

clients question

Most helpful comment

Hey guys, I am making a new Python client Phuker/multi-tldr which support private pages. If you prefer Python, you may try it out, and tell me how do you like it.

Maybe someday when it is mature and stable enough, I will create a PR to add it to the community clients list.

锛圫orry for my duplicated comment in #4344)

All 10 comments

Yes, the tldr-node client does.

Hi @halloleo if you don't have any other comments or questions I would say we can close this as it has been answered, is everything clear?

Perhaps someone could put together a feature matrix at some point for the different clients. Another project for the wiki?

Hi @mebeim, sorry for the late response.

@agnivade I just had a look at the node client and I cannot see any mechanics to integrate private pages.

(Are you referring to the --render option? From my understanding this option needs the full path to a pages and therefore this pages will not automatically show up in the normal command search in tldr...)

I am referring to the "repository" key here - https://github.com/tldr-pages/tldr-node-client#configuration. See the last point under that section.

Ah, I see. You can switch completely to another set of pages.

Not really what I had in mind: It means you have to fork the default repo, add your stuff to it and then later regulaly update your fork manually from the base repo. Plus you cannot have sensitive examples in your repo if you cannot look your repo down.

But if that's what it is, then, well, that's what it is...

You could always write your own tool, or fork the existing client and add support @halloleo.

We have a client specification already - perhaps such a feature could be an optional module that clients could support if they wanted to.

Good idea @sbrl. I might get to enhancing the Python client in that way.

Thanks for the link to the client spec. Certainly useful!

Do keep us posted on how it goes, @halloleo!

Hey guys, I am making a new Python client Phuker/multi-tldr which support private pages. If you prefer Python, you may try it out, and tell me how do you like it.

Maybe someday when it is mature and stable enough, I will create a PR to add it to the community clients list.

锛圫orry for my duplicated comment in #4344)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

GabLeRoux picture GabLeRoux  路  3Comments

mikerouxfr picture mikerouxfr  路  3Comments

taki picture taki  路  3Comments

hrai picture hrai  路  3Comments

pascaliske picture pascaliske  路  3Comments