An open API service indexing awesome lists of open source software.

https://github.com/localizethedocs/highlightjs-docs-l10n

Localization of The Highlight.js Documentation
https://github.com/localizethedocs/highlightjs-docs-l10n

crowdin highlightjs javascript sphinx syntax-highlighting translation

Last synced: 17 days ago
JSON representation

Localization of The Highlight.js Documentation

Awesome Lists containing this project

README

          


Localization of The Highlight.js Documentation


Switch Languages


Table of Contents

Introduction



Zulip Chat


GitHub Stars


GitHub Forks


GitHub Contributors


GitHub Repo Size


GitHub Open Issues


GitHub Open Pull Requests


License: BSD-3-Clause


License: CC-BY-SA-4.0

The goal of this project is to translate The Highlight.js Documentation into multiple languages. Translations are contributed via the Crowdin platform, automatically synchronized with the GitHub repository, and can be previewed on GitHub Pages.

> [!NOTE]
> The translation is unofficial and community-driven. If you find any inaccuracies, always refer to the official documentation or the source repository of the upstream project for the most reliable information.



Project Links






Preview


highlightjs-docs-l10n





Crowdin


highlightjs-docs-l10n





GitHub


highlightjs-docs-l10n





AtomGit


highlightjs-docs-l10n




GitFlic


highlightjs-docs-l10n





Branch Structure



Branch

Description





main


Store CMake scripts and GitHub workflows for the infrastructure.




l10n


Store .pot and .po files generated from the upstream project.




pages


Store the built documentation deployed to GitHub Pages.




po/${VERSION}


Store version-specific .po files for reuse by the upstream project.





GitHub Workflows



Status

Description






ci-sphinx-build-docs



Build documents by Sphinx and upload build artifacts.





ci-sphinx-update-pot



Update .pot files by Sphinx with gettext builder.





ci-gettext-update-po



Update .po files from .pot files by Gettext toolkit.





ci-gettext-compendium



Update .po files from the compendium by Gettext toolkit.





ci-gettext-statistics



Update statistics information of .po files by Gettext toolkit.





ci-crowdin-upload-pot



Upload .pot files to Crowdin by its CLI tool.





ci-crowdin-download-po



Download .po files from Crowdin by its CLI tool.





ci-crowdin-update-readme



Update README translations by Crowdin CLI tool.





ci-deploy-pages



Download and deploy build artifacts to pages branch.





ci-deploy-po-version



Deploy .po files to po/${VERSION} branch.





ci-update-contributors



Update contributors .svg files to static branch.





ci-update-license-year



Update the copyright year in LICENSE to the current year.





ci-update-submodule



Update each of the submodules to their latest commit.



Progress of Translations



Locale



English Name

Native Name





Translated

Proofread








zh_CN



Simplified Chinese

简体中文





zh-CN translation

zh-CN proofreading






zh_TW



Traditional Chinese

繁體中文





zh-TW translation

zh-TW proofreading






Preview Translations

You can preview translations in GitHub Pages:



Language

GitHub Pages






en_US


https://projects.localizethedocs.org/highlightjs-docs-l10n/en-us





zh_CN


https://projects.localizethedocs.org/highlightjs-docs-l10n/zh-cn





zh_TW


https://projects.localizethedocs.org/highlightjs-docs-l10n/zh-tw



Alternatively, you can preview translations locally by running the following commands:

```bash
# Please make sure the following prerequisites are installed:
# CMake (3.25~), Git, Conda, Gettext
LANGUAGE=en_US
VERSION=latest
git clone --recurse-submodule https://github.com/localizethedocs/highlightjs-docs-l10n.git
cd highlightjs-docs-l10n
cmake --preset ${LANGUAGE} -DVERSION=${VERSION}
cmake --build out/build/${LANGUAGE}
```

You can switch to other available languages and versions by the flyout navigation menu.

Maintainers

This project is currently maintained by:



Name

GitHub Username





Haowei Hsu

@hwhsu1231


Support this Project

You can contribute and support this project by doing any of the following:


  • Star the project on GitHub or other mirrors.

  • Submit issues on GitHub if you found any bug.

  • Submit pull requests on GitHub if you know how to fix the bug.

  • Contribute your translations on Crowdin.

  • Consider becoming a sponsor if you love this kind of l10n projects.

It will facilitate the creation and ongoing maintenance of l10n projects for open-source documentation.

Financial Sponsors

You can sponsor the projects through the following platforms:




Patreon

Afdian






Patreon




Afdian



Maintenance of the projects is made possible by the generous support of our sponsors:


Localize The Docs

Code Contributors


GitHub Contributors SVG

Translation Contributors


Crowdin Contributors SVG

Licenses

All original and translated text in the .pot and.po files stored in the l10n branch is made available under the same license as the upstream project.

All CMake script files (e.g., CMakeLists.txt, CMakePresets.json, and cmake/\*\*/\* files), GitHub workflow files (e.g., .github/workflows/\*.yml files), and configuration files (e.g., versions.json, languages.json, crowdin.yml, and so on) of this project are licensed under 3-Clause BSD license. See LICENSE-BSD for details.

All document files (e.g., README.md) of this project are licensed under Creative Commons Attribution-ShareAlike 4.0 International license. See LICENSE-CC for details.


CC BY SA 4.0