tldr-pages / tldr-pages.github.io

The website for the tldr pages project

tldr-pages.github.io

This repository holds the website for the tldr project, hosted at https://tldr.sh/.

Credits

The style of the website is the Solo theme, available under the MIT License.

tldr-pages.github.io's Issues

Add version number or date stamp to title page of PDF

Help easily identify what version of the PDF you have.

How to deploy the newest "reactive web client for tldr-pages" (`tldr.jsx-fork`) on https://tldr.sh?

In order to get tldr-pages/tldr.jsx-fork@e2ef532. 😊

Use tldr-bot for the archive/index updating commits

Since updating the assets is an automated process, it would be nicer if the commits (like this one for example) showed up as authored by tldr-bot. I'm not sure if we had discussed this before, but I couldn't find any discussion in this repo so I figured I'd open an issue even if just to have the decision on the record for posterity.

Live demo iframe is infinitely embeddable within itself

The iframe that runs the live demo (which starts off with the tar command) can be embedded within itself infinitely:

To reproduce:

1. Load http://tldr.sh
2. Scroll down to the tar example iframe
3. Type a command that doesn't exist into the iframe's input (e.g. asdf). The iframe now shows "Oops! Command not found!"
4. Clear the input. The iframe now shows "Salamat datang!" and explains tldr.
5. Scroll a bit down to find "Read more and join the tldr wagon at tldr-pages.github.io" and click the tldr-pages.github.io link.
6. The original URL, http://tldr.sh, now loads inside the iframe, which generates a new tar example iframe.
7. Repeat ad infinitum

Python TLDR client

There is link to lord63/tldr.py repository on TLDR webpage.
However I have found newer Python client at https://github.com/tldr-pages: tldr-pages/tldr-python-client.

The installation instruction on the TLDR webpage refers to lord63/tldr.py repository:

pip install tldr.py

The installation instruction for tldr-pages/tldr-python-client is pip install tldr.

Which one is the official TLDR Python client?

Update the PDF version?

Latest pdf version is 4 years old?

Add dark theme

The website cloud have a dark theme. I'd like to work on this issue

Verify tldr.sh domain in Organization Settings

@agnivade If possible, can you verify the https://tldr.sh domain at https://github.com/organizations/tldr-pages/settings/domains, it will give a txt record along with value which you can add to the Cloudflare DNS configuration.

Once, verified it will look like this on the org page.

Fallback for no JavaScript

The website currently lacks a fallback mechanism or informative content to notify users of the essential requirement of JavaScript for loading the live demo iframe.

In the absence of JavaScript, it currently displays an empty iframe without providing guidance.

Participate in Hacktoberfest

Hacktoberfest is starting soon and I think that the website of this project would
benefit from it a lot. We would just have to add the 'Hacktoberfest' tag and
wait for the pull requests.

The main repository of this project already participates in it and it would make sense for the website of it too.

Go Client command doesn't work

The command provided is go get -u github.com/isacikgoz/tldr, but it does not seem to be working. But the command provided in the client repo (https://github.com/isacikgoz/tldr) is working: go get github.com/isacikgoz/tldr/cmd/tldr

Drop Jekyll?

If I understand correctly, this is a single-page website. Do we really benefit from having the whole Jekyll harness behind it? What would we lose if we moved to a simple html+css (and perhaps some javascript, though I don't see any used at the moment) site?

tldr-bash-client

I've just completed heavy modifications of Ray Lee's original bash client. Added style customization, download pages archive, render local pages, and display markdown.
Would you like to include this in the list of clients? I am willing to field any issues arising. Here's my repo:
https://github.com/pepa65/tldr-bash-client

Auto-update assets/tldr-book.pdf

Related: #21
It seems the issue has already been opened there, but was never made official.

Add web client

tldr

powered by Golang + Vue.js.

Single-page Application

Formatting of displayed commands in web client

Some pages contain references to other commands/pages that are formatted in-line with quotation marks (to give them shellscript font from what I can tell).

But currently the web page puts each of these in a new line rather than displaying it in-line as done in the Github repo browser.
For instance, the zsh page:

http://www.ostera.io/tldr.jsx/#/zsh?_k=ftortv

https://github.com/tldr-pages/tldr/blob/master/pages/common/zsh.md

Verifying domain for fosstodon.org

Now that we have a fediverse account on fosstodon.org, we need to verify the domain.

To do this, we simply need to add this to the <head> of this site:

<link href="https://fosstodon.org/@tldr_pages" rel="me" /> 

I'm on mobile right now, but I'll open a PR to do this later today.

Ref https://fosstodon.org/@benjaminhollon/109662875520985105

Update the website theme?

We're currently using the Solo theme, which was deprecated in 2017 in favor of Duo by the same author.

Are we planning on updating to a new theme, like Duo, anytime soon? Or will we just keep Solo?

Requesting access to the "tldr.sh" domain on Cloudflare

Hi @agnivade,

I would like to request access to the Cloudflare dashboard for the "tldr.sh" domain.

To perform the following changes currently or in the future:

• We recently moved a maintainer's Rust client to Org (to make it official in the near future), before the transfer it had support for a rendered manpage on GitHub pages. However since we use the custom domain, this would require manual configuring to work. [Present]
  • Since GitHub doesn't have the same manpage rendering as GitLab, it is better to have it rendered on a webpage instead. So I am eventually planning to add support for it across our clients. So that would require configuring additional CNAMEs too. [Future/Proposal]
• If other maintainers agree, in the near future I plan on inviting the maintainer/developer of TldrProgress to our Org and transfer the repo here (to make it official) we could provide it under the domain https://l10n.tldr.sh` or something similar. (My proposal is that we could offer an API at maybe https://api.tldr.sh on top of this tool so that the client can display a message on translated pages if it is outdated)

---

I initially thought of sending a mail directly to you personally but thought it would be better to ask it publicly for better transparency and for the future maintainers to know who has access to the site in case of an issue.

---

Update: https://tldr.sh/tlrc/ works so other changes can be done similarly too, so I am closing this issue as a separate CNAME configuration wouldn't be necessary.

The site references a clients wiki page that doesn't exist

The site references https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients, which directs you to create a new page.

From the site:

There are more clients listed in the tldr clients wiki page.

why are commands like ss in the pages folder, but not searchable by the chome app?

There are pages in https://github.com/tldr-pages/tldr/blob/master/pages/linux/ that are not searchable by https://tldr.ostera.io/ or able to be found via the chrome app tldr-chrome

Include live demo?

It would be awesome to include a live demo of the tldr right into the site.

@Ostera would it be possible to make tldr.js embeddable, perhaps only in this specific domain?