{"id":47712225,"url":"https://github.com/godsarmy/mlkit-markdown-translator-android","last_synced_at":"2026-05-02T01:02:56.418Z","repository":{"id":347174783,"uuid":"1192217107","full_name":"godsarmy/mlkit-markdown-translator-android","owner":"godsarmy","description":"Android lib to leverage mlkit to translate markdown content while keeping original markdown format","archived":false,"fork":false,"pushed_at":"2026-04-20T01:17:15.000Z","size":1390,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-20T03:03:12.764Z","etag":null,"topics":["android","markdown","mlkit","translation"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/godsarmy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-03-26T02:10:33.000Z","updated_at":"2026-04-20T01:17:09.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/godsarmy/mlkit-markdown-translator-android","commit_stats":null,"previous_names":["godsarmy/mlkit-markdown-translator-android"],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/godsarmy/mlkit-markdown-translator-android","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godsarmy%2Fmlkit-markdown-translator-android","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godsarmy%2Fmlkit-markdown-translator-android/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godsarmy%2Fmlkit-markdown-translator-android/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godsarmy%2Fmlkit-markdown-translator-android/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/godsarmy","download_url":"https://codeload.github.com/godsarmy/mlkit-markdown-translator-android/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godsarmy%2Fmlkit-markdown-translator-android/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32163853,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-23T02:19:40.750Z","status":"ssl_error","status_checked_at":"2026-04-23T02:17:55.737Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["android","markdown","mlkit","translation"],"created_at":"2026-04-02T18:39:30.751Z","updated_at":"2026-05-02T01:02:56.391Z","avatar_url":"https://github.com/godsarmy.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ML Kit Markdown Translator\n\n\u003cimg src=\"docs/icon.svg\" alt=\"ML Kit Markdown Translator icon\" width=\"96\" /\u003e\n\n## Example App Screenshot\n\n\u003cimg src=\"screenshot-example.jpg\" alt=\"Screenshot of the example app\" width=\"360\" /\u003e\n\nReusable Android library for translating Markdown content with Google ML Kit while preserving Markdown structure (code blocks, links, headings, lists, and spacing) as much as possible.\n\n## Project status\n\nActive development with versioned releases via Git tags.\n\n## Planned modules\n\n- `library/` — Android library module (core deliverable)\n- `sample/` — Android sample app for manual verification\n- `docs/` — design notes and API documentation\n\n## Build the Example App\n\nFrom repo root:\n\n```bash\n./gradlew :sample:assembleDebug\n```\n\nGenerated APK:\n\n```text\nsample/build/outputs/apk/debug/sample-debug.apk\n```\n\nOptional install to a connected device:\n\n```bash\nadb install -r sample/build/outputs/apk/debug/sample-debug.apk\n```\n\n## API reference\n\nSee [`docs/api.md`](docs/api.md) for the current public API surface.\n\n## Architecture\n\nSee [`docs/architecture.md`](docs/architecture.md) for the markdown translation architecture and pipeline design.\n\n## Installation\n\n### Option A: Local module\n\nIf this repository is part of your multi-module build, use:\n\n```gradle\ndependencies {\n    implementation project(\":library\")\n}\n```\n\n### Option B: JitPack (`1.0.0`)\n\nJitPack page: https://jitpack.io/#godsarmy/mlkit-markdown-translator-android\n\n```gradle\nrepositories {\n    google()\n    mavenCentral()\n    maven { url \"https://jitpack.io\" }\n}\n\ndependencies {\n    implementation \"com.github.godsarmy:mlkit-markdown-translator-android:1.0.0\"\n}\n```\n\nKotlin DSL equivalent:\n\n```kotlin\nrepositories {\n    google()\n    mavenCentral()\n    maven(\"https://jitpack.io\")\n}\n\ndependencies {\n    implementation(\"com.github.godsarmy:mlkit-markdown-translator-android:1.0.0\")\n}\n```\n\n### Version alignment (optional)\n\nThis library defaults to:\n\n- `com.google.mlkit:translate:17.0.3`\n- `com.vladsch.flexmark:flexmark:0.64.8`\n\nIf integrating this repo as a **local module**, override in root `gradle.properties`:\n\n```properties\nmlkitTranslateVersion=17.0.4\nflexmarkVersion=0.64.8\n```\n\nIf integrating via **JitPack/artifact**, pin ML Kit in app dependencies:\n\n```gradle\ndependencies {\n    implementation \"com.github.godsarmy:mlkit-markdown-translator-android:1.0.0\"\n    implementation \"com.google.mlkit:translate:17.0.4\"\n}\n```\n\n## Using from Android app\n\n### 1) Basic translation call\n\n```java\nMlKitMarkdownTranslator translator = new MlKitMarkdownTranslator();\n\ntranslator.translateMarkdown(markdown, \"en\", \"es\", new TranslationCallback() {\n    @Override\n    public void onSuccess(String translatedText) {\n        // update UI / state with translated markdown\n    }\n\n    @Override\n    public void onFailure(Exception error) {\n        // handle translation failure\n    }\n});\n```\n\n### 1.1) Explain markdown structure/chunks\n\n```java\nimport io.github.godsarmy.mlmarkdown.api.ExplainMarkdownChunk;\nimport io.github.godsarmy.mlmarkdown.api.ExplainMarkdownResult;\n\nMlKitMarkdownTranslator translator = new MlKitMarkdownTranslator();\nExplainMarkdownResult explain = translator.explainMarkdown(markdown);\n\n// Useful for debugging chunk boundaries and tokenization behavior.\nfor (ExplainMarkdownChunk chunk : explain.getChunks()) {\n    Log.d(\"MLMD\", \"chunk #\" + chunk.getIndex() + \" raw=\" + chunk.getRawText());\n}\n\nLog.d(\"MLMD\", \"mode=\" + explain.getProcessingMode()\n        + \" tokens=\" + explain.getTotalTokenCount()\n        + \" chunks=\" + explain.getTotalChunkCount());\n```\n\n`explainMarkdown(...)` runs local preparation/chunking diagnostics and does not call the\ntranslation engine.\n\n### 2) Handle missing-model errors\n\n```java\nimport io.github.godsarmy.mlmarkdown.api.TranslationErrorCode;\nimport io.github.godsarmy.mlmarkdown.api.TranslationException;\n\nif (error instanceof TranslationException\n        \u0026\u0026 ((TranslationException) error).getCode() == TranslationErrorCode.MODEL_NOT_DOWNLOADED) {\n    // prompt user to download required language model first\n}\n```\n\n### 3) Manage model lifecycle in app code (native ML Kit)\n\nUse native ML Kit APIs in your app for model download/list/delete:\n\n- `RemoteModelManager`\n- `TranslateRemoteModel`\n- `DownloadConditions`\n\n`translateMarkdown(...)` does not auto-download missing models.\n\n### 4) Recommended app structure\n\n- **Activity/Fragment**: owns UI state and triggers user actions.\n- **ViewModel**: coordinates source/target language + intent handling.\n- **Repository**: wraps `MlKitMarkdownTranslator.translateMarkdown(...)`.\n- **App model manager**: wraps ML Kit model lifecycle APIs.\n\nExample repository-style wrapper:\n\n- `docs/examples/JavaMarkdownTranslationRepositoryExample.java`\n\n### 5) Integration guardrails\n\n- **Android SDK**: library targets `minSdk 24`, `compileSdk 34`.\n- **Permissions**: include internet permission when model downloads are expected:\n\n  ```xml\n  \u003cuses-permission android:name=\"android.permission.INTERNET\" /\u003e\n  ```\n\n- **Threading**: callbacks are async; post UI updates to main thread.\n- **Resource lifecycle**:\n  - create one translator instance per screen/controller scope\n  - call `close()` in `onDestroy()` (or equivalent)\n  - avoid creating new translator instances per click\n- **R8/ProGuard**: no custom keep rules required for current public API surface.\n\n## Limitations (v1)\n\nThis library is designed to preserve Markdown structure during translation, but v1 still has known limits:\n\n- advanced nested Markdown edge cases may not be perfectly preserved\n- raw HTML blocks beyond currently supported patterns may not round-trip cleanly\n- GFM-style pipe tables are supported in AST path; regex fallback may preserve full table blocks without translating each cell\n- reference-style link definitions may be imperfect if tokenization does not fully cover a case\n- translator-driven punctuation drift can still occur in plain text regions\n\nFor production use, validate your own Markdown fixtures with the provided golden-test pattern under\n`library/src/test/resources/fixtures`.\n\n## License\n\nApache License 2.0. See `LICENSE`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodsarmy%2Fmlkit-markdown-translator-android","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgodsarmy%2Fmlkit-markdown-translator-android","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodsarmy%2Fmlkit-markdown-translator-android/lists"}