mirror of
https://github.com/tldr-pages/tldr.git
synced 2024-08-16 23:40:43 +03:00
Harmonize project name (lowercase tldr, no semicolon, hyphen-separated)
This commit is contained in:
parent
a5eca83cca
commit
37634b36f7
2
.github/ISSUE_TEMPLATE.md
vendored
2
.github/ISSUE_TEMPLATE.md
vendored
@ -3,7 +3,7 @@ Thank you for reporting an issue! Please review the following notes before submi
|
||||
|
||||
Most issues on this repo are requests for new commands. If it's the case, make sure to use the standard title ("page request: <command name>"), and include a link to a web page about the command, and if possible, to an existing source of example-style documentation.
|
||||
|
||||
If your issue is with a particular client of tldr, please raise the issue in the repo for that client. For example, if you are using the node client, you would report the issue here: https://github.com/tldr-pages/tldr-node-client/issues
|
||||
If your issue is with a particular client of tldr-pages, please raise the issue in the repo for that client. For example, if you are using the node client, you would report the issue here: https://github.com/tldr-pages/tldr-node-client/issues
|
||||
|
||||
If you have a general question or are not sure whether to open an issue, please feel free to ask in our Gitter channel: https://gitter.im/tldr-pages/tldr
|
||||
-->
|
||||
|
2
.gitignore
vendored
2
.gitignore
vendored
@ -17,4 +17,4 @@ index.json
|
||||
|
||||
# Generated PDF pages
|
||||
scripts/pdf/*.html
|
||||
scripts/pdf/tldr.pdf
|
||||
scripts/pdf/tldr-pages.pdf
|
||||
|
@ -1,4 +1,4 @@
|
||||
# tldr pages client specification
|
||||
# tldr-pages client specification
|
||||
|
||||
**Current Specification Version:** 1.2
|
||||
|
||||
|
@ -146,7 +146,7 @@ using one of the template messages below as a base.
|
||||
1. Open an issue with the following message template (edit it as appropriate):
|
||||
|
||||
```
|
||||
Hi, @username! You've been an active tldr-pages org member for over 6 months.
|
||||
Hi, @username! You've been an active tldr-pages organization member for over 6 months.
|
||||
Thanks for sticking around this far and helping out!
|
||||
According to [COMMUNITY-ROLES.md](https://github.com/tldr-pages/tldr/blob/master/COMMUNITY-ROLES.md), you're now eligible for becoming an owner in the organization.
|
||||
|
||||
|
@ -130,7 +130,8 @@ Examples:
|
||||
|
||||
## Licensing
|
||||
|
||||
`tldr` is licensed under a [Creative Commons Attribution 4.0 International License](LICENSE.md). The contents of the `scripts/` directory are licensed under the [MIT license](LICENSE.md).
|
||||
This repository is licensed under the [Creative Commons Attribution 4.0 International License](LICENSE.md).
|
||||
The contents of the `scripts/` directory are licensed under the [MIT license](LICENSE.md).
|
||||
|
||||
Any contributions to this project are governed by the
|
||||
[Contributor License Agreement](https://cla-assistant.io/tldr-pages/tldr).
|
||||
|
@ -1,4 +1,4 @@
|
||||
Copyright © 2014—present the [TLDR team](https://github.com/orgs/tldr-pages/people) and [contributors](https://github.com/tldr-pages/tldr/graphs/contributors).
|
||||
Copyright © 2014—present the [tldr-pages team](https://github.com/orgs/tldr-pages/people) and [contributors](https://github.com/tldr-pages/tldr/graphs/contributors).
|
||||
|
||||
### This work is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).
|
||||
|
||||
|
@ -25,7 +25,7 @@ A collection of simplified and community-driven man pages.
|
||||
Install it with `npm install -g tldr`
|
||||
or [try the web client](http://tldr.ostera.io).
|
||||
|
||||
## What is tldr?
|
||||
## What is tldr-pages?
|
||||
|
||||
New to the command-line world? Or just a little rusty?
|
||||
Or perhaps you can't always remember the arguments to `lsof`, or `tar`?
|
||||
@ -43,7 +43,7 @@ Surely people could benefit from simplified man pages
|
||||
focused on practical examples.
|
||||
How about:
|
||||
|
||||
![tldr screenshot](images/screenshot.png)
|
||||
![screenshot of the tldr-node-client displaying the tldr page for the tar command](images/screenshot.png)
|
||||
|
||||
This repository is just that: an ever-growing collection of examples
|
||||
for the most common UNIX, Linux, macOS, SunOS and Windows commands.
|
||||
@ -126,7 +126,7 @@ You can access these pages on your computer using one of the following clients:
|
||||
- [tldr.ooops.me](https://tldr.ooops.me): web client with multilingual support
|
||||
|
||||
There is also a comprehensive
|
||||
[list of clients in our Wiki](https://github.com/tldr-pages/tldr/wiki/TLDR-clients).
|
||||
[list of clients in our Wiki](https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients).
|
||||
|
||||
## Contributing
|
||||
|
||||
|
@ -1,10 +1,10 @@
|
||||
Most people submit pull requests to the tldr project
|
||||
Most people submit pull requests to the tldr-pages project
|
||||
[using GitHub's web interface][pr-howto].
|
||||
|
||||
If you prefer, you can do most of the process using the command line instead.
|
||||
The overall process should look somewhat like this:
|
||||
|
||||
1. Fork the tldr repository on the GitHub web interface.
|
||||
1. Fork the tldr-pages/tldr repository on the GitHub web interface.
|
||||
|
||||
2. Clone your fork locally:
|
||||
`git clone https://github.com/{{your_username}}/tldr.git && cd tldr`
|
||||
|
@ -41,7 +41,7 @@ as a guideline for current and future maintainers.
|
||||
Keep in mind that
|
||||
[every form of contribution](https://github.com/kentcdodds/all-contributors)
|
||||
(pull request, feature request, bug report, etc.)
|
||||
is a voluntary gift of time offered to the tldr project
|
||||
is a voluntary gift of time offered to the tldr-pages project
|
||||
by someone who cares about it,
|
||||
so make sure it's clear that that we don't take it for granted.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Style guide
|
||||
|
||||
This page lists specific formatting instructions for tldr pages.
|
||||
This page lists specific formatting instructions for `tldr` pages.
|
||||
|
||||
## Layout
|
||||
|
||||
@ -34,7 +34,7 @@ tldrl -f {{page.md}}
|
||||
For other ways to use `tldrl`, such as linting an entire directory, check out (what else!)
|
||||
[`tldr tldrl`](https://github.com/tldr-pages/tldr/blob/master/pages/common/tldrl.md)
|
||||
|
||||
If you're using the Node.js client of `tldr`, you can preview a page locally using the `-f` flag (aka `--render`):
|
||||
If you're using the Node.js client of tldr-pages, you can preview a page locally using the `-f` flag (aka `--render`):
|
||||
|
||||
```
|
||||
tldr -f {{page.md}}
|
||||
|
Binary file not shown.
Before Width: | Height: | Size: 83 KiB After Width: | Height: | Size: 88 KiB |
@ -29,14 +29,14 @@
|
||||
</text>
|
||||
</g>
|
||||
<g fill="#7ebfb7" font-family="Sometype Mono, monospace">
|
||||
<text x="840" y="520" font-size="340" font-weight="bold" transform="scale(1, 0.9)">
|
||||
TL;DR
|
||||
<text x="840" y="480" font-size="170" font-weight="bold" transform="scale(1, 0.9)">
|
||||
tldr-pages
|
||||
</text>
|
||||
<text font-size="62" font-weight="500">
|
||||
<tspan x="860" y="620">
|
||||
<tspan x="860" y="580">
|
||||
A collection of simplified,
|
||||
</tspan>
|
||||
<tspan x="860" y="710">
|
||||
<tspan x="860" y="670">
|
||||
community-driven man pages.
|
||||
</tspan>
|
||||
</text>
|
||||
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 1.5 KiB |
@ -12,7 +12,7 @@
|
||||
},
|
||||
"scripts": {
|
||||
"lint-markdown": "markdownlint pages*/**/*.md",
|
||||
"lint-tldr": "tldr-lint ./pages",
|
||||
"lint-tldr-pages": "tldr-lint ./pages",
|
||||
"test": "bash scripts/test.sh",
|
||||
"build-index": "node ./scripts/build-index.js > index.json"
|
||||
},
|
||||
|
@ -1,6 +1,6 @@
|
||||
# tldr
|
||||
|
||||
> Command-line client for tldr pages.
|
||||
> Command-line client for tldr-pages.
|
||||
> Displays simplified and community-driven man pages.
|
||||
> More information: <https://tldr.sh>.
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# tldrl
|
||||
|
||||
> Lint and format TLDR pages.
|
||||
> Lint and format `tldr` pages.
|
||||
> More information: <https://github.com/tldr-pages/tldr-lint>.
|
||||
|
||||
- Lint all pages:
|
||||
|
@ -1,6 +1,6 @@
|
||||
# pdf
|
||||
|
||||
This directory contains the script and related resources to generate a PDF copy of tldr pages.
|
||||
This directory contains the script and related resources to generate a PDF document with all the `tldr` pages.
|
||||
|
||||
## Preview
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
# A Python script to generate a single PDF document with all the tldr pages. It works by generating
|
||||
# A Python script to generate a single PDF document with all the `tldr` pages. It works by generating
|
||||
# intermediate HTML files from existing md files using Python-markdown, applying desired formatting
|
||||
# through CSS, and finally rendering them as PDF. There is no LaTeX dependency for generating the PDF.
|
||||
|
||||
@ -92,11 +92,11 @@ def main(loc, colorscheme):
|
||||
for p in doc.pages:
|
||||
ap.append(p)
|
||||
|
||||
# Writing the PDF to disk, preserving metadata of first tldr page
|
||||
group[2].copy(ap).write_pdf('tldr.pdf')
|
||||
# Writing the PDF to disk, preserving metadata of first `tldr` page
|
||||
group[2].copy(ap).write_pdf('tldr-pages.pdf')
|
||||
|
||||
if os.path.exists("tldr.pdf"):
|
||||
print("\nCreated tldr.pdf in the current directory!\n")
|
||||
if os.path.exists("tldr-pages.pdf"):
|
||||
print("\nCreated tldr-pages.pdf in the current directory!\n")
|
||||
|
||||
# Removing unnecessary intermediate files
|
||||
try:
|
||||
@ -114,7 +114,7 @@ if __name__ == "__main__":
|
||||
|
||||
# Parsing the arguments
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("dir_path", help = "Path to tldr 'pages' directory")
|
||||
parser.add_argument("dir_path", help = "Path to the 'pages' directory")
|
||||
parser.add_argument("-c", choices=["solarized-light", "solarized-dark"], help="Color scheme of the PDF")
|
||||
args = parser.parse_args()
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user