mirror/tldr-pages.tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-09-08 11:28:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
Page: Minimum specifications for tldr pages command line clients
Pages
Clients Coding projects Datasets, Models and Papers Home Minimum specifications for tldr pages command line clients Project History Season of Docs projects Useful scripts and programs
5 Minimum specifications for tldr pages command line clients
Yakiyo edited this page 2023-09-10 23:57:19 +06:00
Table of Contents

tldr pages are distributed under MIT license, so you are free to implement clients for any platform. There is already a long list of clients.

Architecture

  • The pages should be stored in a pages folder.
  • Within that folder, there should be a subfolder for each supported platform.
  • Commands common for all platforms are listed in the common folder.

Clients should not load pages directly from the GitHub API, which has rate limits. Instead, they should load the page archive and/or page index from the static site https://tldr.sh:

Recommendations

We recommend that clients follow the same standards.

  • It should have installation instructions and setup requirements.
  • It should list supported features.
  • It should follow the full client specification.