Skip to content

Client specification v2.1: Escaping placeholder syntax and automatic platform detection
Compare
Choose a tag to compare
@kbdharun kbdharun released this 30 Nov 18:08
· 1079 commits to main since this release
v2.1
This tag was signed with the committer’s verified signature.
kbdharun K.B.Dharun Krishna
GPG key ID: 0CFDE7E6FAC14AF8
Learn about vigilant mode.
862f4c9
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Calling all maintainers of both clients and tldr alike!

Since the previous v2.0 release, substantial work has been going on behind the scenes to improve tldr, spanning from new platform additions to adding l10n support for tldr book.

With this minor release, we are introducing a newer version of client specification with multiple fixes to existing sections.

Changelog 📜

  • Add requirement to support escaping the placeholder syntax in certain pages (#10730) (thanks @acuteenvy)
  • Add suggestion to detect new platforms added to the relevant pages directory automatically (#11523) (thanks @kbdharun)

Updates

Platform additions: BSD 💻

We have added support for FreeBSD, NetBSD and OpenBSD platforms to the pages directory. Currently, it contains a small subset of package manager commands. If you use any BSD platform-specific commands, we suggest creating a PR to add them to the subdirectories. (thanks @mrusme, @acuteenvy)

PDF changes

Tldr book is now available in your language 🎉

We have added support for generating tldr book PDFs for translations in our CI with a new build-pdfscript (#10969). The default font of the pages was updated to Noto Sans to support additional languages.

The PDF files contain rendered tldr pages from your pages.<locale> directory sorted platform-wise. They are available here and are also visible on our website at https://tldr.sh/assets/tldr-book-<locale>.pdf.

Note

Tldr book PDFs will not be available in a few languages due to rendering issues upon generation.

Platform-specific PDF creation

We have added support to create platform-specific PDF pages in the render.py script. (#11195) (thanks @kbdharun)

General Updates

  • There have been numerous improvements throughout our test suite and action workflows. (thanks to @sebastiaanspeck)
  • We have added a symlink for pages directory to pages.en. (#11139) (thanks @acuteenvy)

For more updates, check out the tracker issue.

Last month we had a successful hacktoberfest, with more than 400+ PRs merged from dozens of contributors.

Thanks to all the contributors and maintainers for their contributions.

Contributors

mrusme, sebastiaanspeck, and 2 other contributors
Assets 73