Angad Singh Grover a75d875fa6 pacman-f: add alias page; pacman-files: update page (#14858) hai 2 semanas
..
pdf e9750a9922 cleanup: update PDF README hai 11 meses
README.md dff913f486 `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) hai 7 meses
_common.py dff913f486 `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) hai 7 meses
build-index.js 6260eba27c build(deps): bump glob from 7.2.0 to 10.2.7 (#10377) hai 1 ano
build.sh 68306bbf63 cleanup: revert back don't build scripts archive step (#11838) hai 11 meses
check-pr.sh 4cb42adc19 check-pr: add the ability to run with verbose logging (#14577) hai 1 mes
deploy.sh b9941d2ecf fix: allow CI to run when PDFs haven't been generated (#12669) hai 7 meses
send-to-bot.py 80c7a83e8b tldr-bot: fix comment formatting (#13931) hai 2 meses
set-alias-page.py 316e672699 set-alias-page: fix regex hai 1 mes
set-more-info-link.py bf8353aba8 more-info-link: add list of all more-info link templates (#14155) hai 2 meses
set-page-title.py dff913f486 `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) hai 7 meses
test-requirements.txt dff913f486 `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) hai 7 meses
test.sh b421868b4e scripts/*.sh: establish some conventions (#13999) hai 2 meses
update-command.py 561a364e0d tooling: add update-command script (#11974) hai 10 meses
wrong-filename.sh a75d875fa6 pacman-f: add alias page; pacman-files: update page (#14858) hai 2 semanas

README.md

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 and build-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