How tldr-pages/tldr works
tldr-pages is a community-maintained corpus of concise, practical command examples, organized by operating system and language. The main user journey is to look up a command in a client and get its relevant help page. Contributors create or revise Markdown pages; translation directories hold localized versions, and repository scripts assist with common edits and synchronization. The PDF renderer offers a separate way to consume the corpus. The README documents client usage and PDF support; sampled source confirms editing helpers and PDF rendering, but not client internals.
Main entry points: pages.fr Localized pages · pages English pages · _common.py Shared helpers · set-page-title.py Title editor
Components 14
Page corpus
- English pages
pages - Platform pages
pages/common
Translations
- Localized pages
pages.fr
Contribution tools
- Title editor
scripts/set-page-title.py - Alias editor
scripts/set-alias-page.py - See-also editor
scripts/set-see-also.py - Info-link editor
scripts/set-more-info-link.py - Example updater
scripts/update-command.py - Shared helpers
scripts/_common.py
Consumption
- tldr clients
- PDF renderer
scripts/pdf/render.py - PDF book
Other components
- Contributors
- Command-line users
Connections 25
- Contributors → English pages: write pages
- Contributors → Localized pages: translate pages
- Command-line users → tldr clients: request help
- tldr clients → English pages: look up
- tldr clients → Platform pages: look up
- English pages → tldr clients: serve examples
- Platform pages → tldr clients: serve examples
- Contributors → Title editor: edit title
- Contributors → Alias editor: edit alias
- Contributors → See-also editor: edit references
- Contributors → Info-link editor: edit link
- Contributors → Example updater: update examples
- Title editor → Shared helpers: use
- Alias editor → Shared helpers: use
- See-also editor → Shared helpers: use
- Info-link editor → Shared helpers: use
- Title editor → Localized pages: update translations
- Alias editor → Localized pages: update translations
- See-also editor → Localized pages: update translations
- Info-link editor → Localized pages: update translations
- Example updater → English pages: update examples
- Example updater → Localized pages: update examples
- Contributors → PDF renderer: request export
- PDF renderer → English pages: read pages
- PDF renderer → PDF book: render PDF