Skip to content

heilaaks/snippy-tldr

Repository files navigation

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