{"id":19368091,"url":"https://nmohnblatt.github.io/zk-jargon-decoder","last_synced_at":"2025-04-23T15:30:23.895Z","repository":{"id":65710107,"uuid":"479423850","full_name":"zkjargon/zkjargon.github.io","owner":"zkjargon","description":"A collection of informal and practical definitions for common jargon found in the zero-knowledge literature.","archived":false,"fork":false,"pushed_at":"2025-02-19T19:13:18.000Z","size":8209,"stargazers_count":97,"open_issues_count":5,"forks_count":16,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-02-19T20:24:42.976Z","etag":null,"topics":["cryptography","educational","zero-knowledge"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zkjargon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-08T14:31:41.000Z","updated_at":"2025-02-19T19:13:22.000Z","dependencies_parsed_at":"2024-08-08T17:00:54.546Z","dependency_job_id":"dabc6306-9633-4e26-9788-36f2ce813fdf","html_url":"https://github.com/zkjargon/zkjargon.github.io","commit_stats":null,"previous_names":["zkjargon/zkjargon.github.io","nmohnblatt/zk-jargon-decoder"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkjargon%2Fzkjargon.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkjargon%2Fzkjargon.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkjargon%2Fzkjargon.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zkjargon%2Fzkjargon.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zkjargon","download_url":"https://codeload.github.com/zkjargon/zkjargon.github.io/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250460204,"owners_count":21434222,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cryptography","educational","zero-knowledge"],"created_at":"2024-11-10T08:05:36.878Z","updated_at":"2025-04-23T15:30:23.887Z","avatar_url":"https://github.com/zkjargon.png","language":"Shell","funding_links":[],"categories":["Articles"],"sub_categories":[],"readme":"# ZK Jargon Decoder\n\nThe ZK Jargon Decoder is an informal glossary for common jargon found in the zero-knowledge literature.\n\nAn updated version of the book is available online at \u003chttps://zkjargon.github.io\u003e.\n\nYou can also run the book locally by following the instructions below:\n\n**Prerequisites**\n\n```shell\ncargo install mdbook mdbook-katex\n```\n\n**Run**\n\n```shell\nmdbook serve --open\n```\n\n## Contributing Translations\n\nWe welcome contributions for translations into different languages. Follow these steps to add a new translation:\n\n1. Ensure you have the required tools installed:\n\n   ```\n   cargo install mdbook mdbook-i18n-helpers\n   ```\n\n2. Generate the POT file:\n\n   ```\n   MDBOOK_OUTPUT='{\"xgettext\": {}}' mdbook build -d po\n   ```\n\n3. Create a new PO file for your language (replace `xx` with your language code):\n\n   ```\n   msginit -i po/messages.pot -l xx -o po/xx.po\n   ```\n\n4. Translate the strings in the newly created `po/xx.po` file. You can use a PO editor like Poedit for this task.\n\n5. To preview your translation, run:\n\n   ```\n   MDBOOK_BOOK__LANGUAGE=xx mdbook serve --open\n   ```\n\n6. Once you're satisfied with your translation, create a pull request with your changes.\n\n7. To build all language versions at once, use the `build_all.sh` script:\n\n```sh\n./build_all.sh\n```\n\nThis script will automatically build the book for all available language translations.\nNote: On Windows, this command will automatically execute the appropriate PowerShell script.\n\n### Translation Guidelines\n\nFor detailed translation guidelines, please refer to our [TRANSLATE.md](TRANSLATE.md) file. Some key points to remember:\n\n- Use a PO editor (like Poedit) to edit `.po` files. Do not edit them by hand.\n- Maintain consistency in terminology throughout the translation.\n- Do not translate code blocks unless necessary.\n- If you're unsure about a translation, leave it in English or add a translator's note.\n\n## License\n\nThis work is shared under a Creative Commons Attribution-ShareAlike 4.0 International license. In brief, this allows others to use this work as long as they give attribution to this project, and share their own work under a similar license.\n\nZK Jargon Decoder © 2022 by ZK Jargon Decoder contributors is licensed under CC BY-SA 4.0. To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/nmohnblatt.github.io%2Fzk-jargon-decoder","html_url":"https://awesome.ecosyste.ms/projects/nmohnblatt.github.io%2Fzk-jargon-decoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/nmohnblatt.github.io%2Fzk-jargon-decoder/lists"}