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

Clients which support private pages #3269

Closed
halloleo opened this issue Sep 17, 2019 · 10 comments
Closed

Clients which support private pages #3269

halloleo opened this issue Sep 17, 2019 · 10 comments
Labels
clients Issues pertaining to a particular client or the clients as whole. question Questions related to tldr-pages.

Comments

@halloleo
Copy link

halloleo commented Sep 17, 2019

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?

@agnivade
Copy link
Member

Yes, the tldr-node client does.

@mebeim mebeim added the clients Issues pertaining to a particular client or the clients as whole. label Sep 21, 2019
@mebeim
Copy link
Member

mebeim commented Oct 2, 2019

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?

@mebeim mebeim added the question Questions related to tldr-pages. label Oct 2, 2019
@sbrl
Copy link
Member

sbrl commented Oct 2, 2019

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

@halloleo
Copy link
Author

halloleo commented Oct 3, 2019

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...)

@agnivade
Copy link
Member

agnivade commented Oct 3, 2019

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

@halloleo
Copy link
Author

halloleo commented Oct 4, 2019

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...

@halloleo halloleo closed this as completed Oct 4, 2019
@sbrl
Copy link
Member

sbrl commented Oct 4, 2019

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.

@halloleo
Copy link
Author

halloleo commented Oct 5, 2019

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

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

@sbrl
Copy link
Member

sbrl commented Oct 5, 2019

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

@Phuker
Copy link
Contributor

Phuker commented Oct 14, 2020

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.

(Sorry for my duplicated comment in #4344)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clients Issues pertaining to a particular client or the clients as whole. question Questions related to tldr-pages.
Projects
None yet
Development

No branches or pull requests

5 participants