336507ac32
* scripts/set-alias-page.py: add language option, fix script --------- Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com> Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com> Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Scripts
The current directory contains useful scripts used/to use with tldr pages.
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.pyandbuild-pdf.shscript 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
pagesdirectory. - build-index.sh script builds the index of available pages.
- check-pr.sh script checks the pages 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 send the build or tests 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.
- test.sh script runs some basic tests on every PR/commit to make sure that the pages are valid and that 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 below table shows the compatibility of user-executable scripts with different platforms.
| Script | Linux | macOS (osx) |
Windows |
|---|---|---|---|
| render.py | ✅ | ✅ | ✅ |
| build-pdf.sh | ✅ | ✅ | ❌ |
| build.sh | ✅ | ✅ | ❌ |
| set-alias-pages.py | ✅ | ✅ | ✅ |
| set-more-info-link.py | ✅ | ✅ | ✅ |
| wrong-filename.sh | ✅ | ❌ | ❌ |
| update-command.py | ✅ | ✅ | ✅ |