Skip to main content

Snippy plugin to import tldr man pages.

Project description

badge-pypiv badge-pys badge-pyv badge-cov badge-docs badge-build badge-black

Snippy-tldr

Snippy plugin to import tldr man pages.

Installation

To install, run:

pip install snippy-tldr --user

Usage

To import one tldr page from GitHub, run:

snippy import --plugin tldr --file https://github.com/tldr-pages/tldr/blob/master/pages/linux/alpine.md

To import all English translated tldr pages for Linux from GitHub, run:

snippy import --plugin tldr

To import all tldr pages from one platform from GitHub, run:

snippy import --plugin tldr --file https://github.com/tldr-pages/tldr/tree/master/pages/osx

To import all Chinese translated tldr pages from GitHub, run:

snippy import --plugin tldr --file https://github.com/tldr-pages/tldr/tree/master/pages.zh

To import one tldr page from local file system, run:

snippy import --plugin tldr --file ./tldr/pages/linux/apk.md

To import all Linux platform tldr pages from a local file system, run:

snippy import --plugin tldr --file ./tldr/pages/linux

To import all platforms tldr pages from a local file system, run:

snippy import --plugin tldr --file ./tldr/pages

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snippy-tldr-0.2.0.tar.gz (10.5 kB view hashes)

Uploaded source

Built Distribution

snippy_tldr-0.2.0-py3-none-any.whl (13.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page