mirror of
https://github.com/tldr-pages/tldr.git
synced 2024-09-11 03:55:31 +03:00
.. | ||
_common.py | ||
build-index.js | ||
build.sh | ||
check-pr.sh | ||
deploy.sh | ||
README.md | ||
send-to-bot.py | ||
set-alias-page.py | ||
set-more-info-link.py | ||
set-page-title.py | ||
test-requirements.txt | ||
test.sh | ||
update-command.py | ||
wrong-filename.sh |
Scripts
The current directory contains useful scripts used/to use with tldr
pages.
Note
Git and Python must be installed in your system to run/test the scripts locally.
Summary
This section contains a summary of the scripts available in this directory. For more information about each script, please refer to the header of each script.
- pdf directory contains the
render.py
andbuild-pdf.sh
script and related resources to generate a PDF document of tldr-pages for a specific language or platform (or both). - build.sh script builds the ZIP archives of the
pages
directory. - build-index.sh script builds the index of available pages.
- check-pr.sh script checks the page's syntax and performs various checks on the PR.
- deploy.sh script deploys the ZIP and PDF archives to the static website repository.
- send-to-bot.py is a Python script that sends the build or test output to tldr-bot.
- set-alias-page.py is a Python script to generate or update alias pages.
- set-more-info-link.py is a Python script to generate or update more information links across pages.
- set-page-title.py is a Python script to update the title across pages.
- test.sh script runs some basic tests on every PR/commit to ensure the pages are valid and the code is formatted correctly.
- wrong-filename.sh script checks the consistency between the filenames and the page title.
- update-command.py is a Python script to update the common contents of a command example across all languages.
Compatibility
The table below shows the compatibility of user-executable scripts with different platforms:
Script | Linux | macOS (osx ) |
Windows |
---|---|---|---|
render.py | ✅ | ✅ | ✅ |
build-pdf.sh | ✅ | ✅ | ❌ (WSL ✅) |
build.sh | ✅ | ✅ | ❌ (WSL ✅) |
set-alias-pages.py | ✅ | ✅ | ✅ |
set-more-info-link.py | ✅ | ✅ | ✅ |
set-page-title.py | ✅ | ✅ | ✅ |
wrong-filename.sh | ✅ | ❌ | ❌ (WSL ✅) |
update-command.py | ✅ | ✅ | ✅ |