ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
tldr/scripts
History
Sebastiaan Speck fa91c0c282
scripts/wrong-filename: resolve wrong filenames (#12844) 		2024-05-27 19:38:56 +02:00
..
pdf cleanup: update PDF README 2023-12-24 10:55:30 +05:30
README.md `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) 2024-05-18 06:03:40 +05:30
_common.py `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) 2024-05-18 06:03:40 +05:30
build-index.js build(deps): bump glob from 7.2.0 to 10.2.7 (#10377) 2023-07-06 08:47:20 -07:00
build.sh cleanup: revert back don't build scripts archive step (#11838) 2023-12-26 00:09:17 +05:30
check-pr.sh check-pr: fix typo (#12038) 2024-01-08 20:38:24 +01:00
deploy.sh fix: allow CI to run when PDFs haven't been generated (#12669) 2024-04-25 07:03:17 +02:00
send-to-bot.py send-to-bot: remove once, let the tldr-bot always comment (#11547) 2023-11-20 21:06:02 +01:00
set-alias-page.py `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) 2024-05-18 06:03:40 +05:30
set-more-info-link.py `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) 2024-05-18 06:03:40 +05:30
set-page-title.py `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) 2024-05-18 06:03:40 +05:30
test-requirements.txt `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) 2024-05-18 06:03:40 +05:30
test.sh `scripts/_common.py`: add a shared Python file to move duplicated code (#12755) 2024-05-18 06:03:40 +05:30
update-command.py tooling: add update-command script (#11974) 2024-01-27 23:10:42 +08:00
wrong-filename.sh scripts/wrong-filename: resolve wrong filenames (#12844) 2024-05-27 19:38:56 +02:00

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 ✅ ✅ ✅