{"id":28959555,"url":"https://github.com/agoraio-extensions/iris_doc","last_synced_at":"2025-06-24T00:03:01.042Z","repository":{"id":270592485,"uuid":"883554575","full_name":"AgoraIO-Extensions/iris_doc","owner":"AgoraIO-Extensions","description":null,"archived":false,"fork":false,"pushed_at":"2025-05-14T09:49:24.000Z","size":264,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-05-14T10:53:09.502Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgoraIO-Extensions.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}},"created_at":"2024-11-05T07:05:24.000Z","updated_at":"2024-11-05T07:06:47.000Z","dependencies_parsed_at":"2025-01-01T16:40:46.742Z","dependency_job_id":"692fe90c-b785-4a8c-94f1-0845a819a37c","html_url":"https://github.com/AgoraIO-Extensions/iris_doc","commit_stats":null,"previous_names":["agoraio-extensions/iris_doc"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AgoraIO-Extensions/iris_doc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2Firis_doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2Firis_doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2Firis_doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2Firis_doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgoraIO-Extensions","download_url":"https://codeload.github.com/AgoraIO-Extensions/iris_doc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgoraIO-Extensions%2Firis_doc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261577971,"owners_count":23179765,"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":[],"created_at":"2025-06-24T00:02:06.007Z","updated_at":"2025-06-24T00:03:01.037Z","avatar_url":"https://github.com/AgoraIO-Extensions.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# iris_doc\nA CLI tool that fill the dita json data as comments to code from https://github.com/AgoraIO/agora_doc_source.\n\n## Get Started\n### dart\n```\npython3 -m pip install -r requirements.txt\n\npython3 iris_doc.py \\\n        --config=fmt_config/fmt_dart.yaml \\\n        --language=dart \\\n        --template-url=https://github.com/AgoraIO/agora_doc_source/releases/download/main/flutter_ng_json_template_cn.json \\\n        --export-file-path=/Users/exportfile/path/export_file.dart\n```\n\n### ts\nFirst install the eslint\n```\nnpm install eslint\n```\n\n```\npython3 -m pip install -r requirements.txt\n\npython3 iris_doc.py \\\n        --config=fmt_config/fmt_ts.yaml \\\n        --language=ts \\\n        --template-url=https://github.com/AgoraIO/agora_doc_source/releases/download/main/rn_ng_json_template_en.json \\\n        --export-file-path=/Users/exportfile/path/export_file.ts\n```\n\n### c_sharp\nFirst install the clang\n\n```\npython3 -m pip install -r requirements.txt\n\npython3 iris_doc.py \\\n        --config=fmt_config/fmt_c_sharp.yaml \\\n        --language=c_sharp \\\n        --template-url=https://github.com/AgoraIO/agora_doc_source/releases/download/main/unity_ng_doc_template_en.json \\\n        --export-file-path=/Users/exportfile/path\n```\n\n## License\nThe project is under the MIT license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio-extensions%2Firis_doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagoraio-extensions%2Firis_doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagoraio-extensions%2Firis_doc/lists"}