tldr pages — develop community simplified manual pages (man pages simplified). The authors of the project decided to bring in the console concise documentation contains only basic information. The collection of simplified manual pages presents the team with a brief description of their purpose and examples of the most frequent use of the requested utilities/commands.
The project tldr pages is an alternative to the man, info and –help (-h), exempting only the quick guide with the most useful information, a kind of set of tips or cheat sheets, which is not a full replacement of the official documentation to applications. To gain access to the pages of tldr , you need a client (client for tldr), has many clients from the community with a different set of functionality and are written in all popular languages, one of these customers is tldr-node-client (Node.js client).
Client tldr-node-client is recommended for use by the sponsors tldr pages, as it is the most full featured and flexible. To configure the client configuration file (~/.tldrrc), create it out for yourself. For a start, as a basic structure, you can use the contents of the file config.json from repository, making changes according to your needs by setting up a detailed documentation.
tldr-node-client supports changing the color theme, “default” client is used the “simple” theme, there are also preconfigured themes. A private topic is created in the section “themes” of the configuration file, it must be remembered that the choice of colors and effects is limited. Local database manual pages (~/.tldr/cache) is updated manually, to speed the data indexed by the file format JSON (~/.tldr/cache/index.json).
License: MLT (The MIT License)