{"id":15347772,"url":"https://github.com/plainheart/echarts-offline-doc-cli","last_synced_at":"2025-04-15T02:37:09.482Z","repository":{"id":150740376,"uuid":"335860005","full_name":"plainheart/echarts-offline-doc-cli","owner":"plainheart","description":"Apache ECharts 中文离线文档生成工具","archived":false,"fork":false,"pushed_at":"2025-04-11T00:59:40.000Z","size":63621,"stargazers_count":9,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T01:41:15.837Z","etag":null,"topics":["echarts","echarts-cli","echarts-doc","offline-doc"],"latest_commit_sha":null,"homepage":"https://plainheart.github.io/echarts-offline-doc-cli","language":"JavaScript","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/plainheart.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}},"created_at":"2021-02-04T06:25:54.000Z","updated_at":"2024-12-21T06:06:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"44408563-d02c-4b8c-b7a4-a48cf0646d3e","html_url":"https://github.com/plainheart/echarts-offline-doc-cli","commit_stats":{"total_commits":29,"total_committers":1,"mean_commits":29.0,"dds":0.0,"last_synced_commit":"a1d1f7ee94563ddef8b23221733e12071ad48c08"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plainheart%2Fecharts-offline-doc-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plainheart%2Fecharts-offline-doc-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plainheart%2Fecharts-offline-doc-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/plainheart%2Fecharts-offline-doc-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/plainheart","download_url":"https://codeload.github.com/plainheart/echarts-offline-doc-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248995103,"owners_count":21195497,"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":["echarts","echarts-cli","echarts-doc","offline-doc"],"created_at":"2024-10-01T11:39:34.154Z","updated_at":"2025-04-15T02:37:09.135Z","avatar_url":"https://github.com/plainheart.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# echarts-offline-doc-cli\n[![NPM version](https://img.shields.io/npm/v/echarts-offline-doc-cli.svg?style=flat)](https://www.npmjs.org/package/echarts-offline-doc-cli)\n[![Auto Deploy](https://github.com/plainheart/echarts-offline-doc-cli/actions/workflows/deploy.yaml/badge.svg)](https://github.com/plainheart/echarts-offline-doc-cli/actions/workflows/deploy.yaml)\n[![NPM Downloads](https://img.shields.io/npm/dm/echarts-offline-doc-cli.svg)](https://npmcharts.com/compare/echarts-offline-doc-cli?minimal=true)\n[![License](https://img.shields.io/npm/l/echarts-offline-doc-cli.svg)](https://github.com/plainheart/echarts-offline-doc-cli/blob/main/LICENSE)\n\nApache ECharts 中文离线文档生成工具\n\n[GitHub Pages 预览](https://plainheart.github.io/echarts-offline-doc-cli)\n\n![示例](https://user-images.githubusercontent.com/26999792/229869304-4a782121-4324-4e68-9f3d-a956d0c60ee6.png)\n\n# 开始使用\n\n## 全局安装\n\n```sh\nnpm i echarts-offline-doc-cli -g\n```\n\n### 生成离线文档\n\n```sh\necharts-offline-doc --build\n# 等价于：\necharts-offline-doc -b\n\n# 如果拉取代码速度较慢，可以指定一个快速的代理镜像地址\necharts-offline-doc --build --proxy https://521github.com/apache/echarts-doc\n# 等价于：\necharts-offline-doc -b -p https://521github.com/apache/echarts-doc\n\n# 如果依赖安装速度较慢，可以考虑使用 cnpm\necharts-offline-doc --build --cnpm\n# 等价于：\necharts-offline-doc -b -c\n\n# 查看帮助信息\necharts-offline-doc --help\n# 等价于：\necharts-offline-doc -h\n```\n\n### 使用 HTTP Server 查看离线文档\n\n```sh\necharts-offline-doc\n# 等价于：\necharts-offline-doc --serve\n# 等价于：\necharts-offline-doc -s\n```\n\n### 本地查看离线文档\n\n```sh\necharts-offline-doc --local\n# 等价于：\necharts-offline-doc -l\n```\n\n## 从源码构建\n\n```sh\n# 拉取本项目代码仓库\ngit clone https://github.com/plainheart/echarts-offline-doc-cli --depth=1\n\n# 安装依赖\nnpm i\n\n# 构建离线文档\nnpm run build\n\n# 如果拉取代码速度较慢，可以指定一个快速的代理镜像地址\nnpm run build -- -- --proxy https://521github.com/apache/echarts-doc\n# 等价于：\nnpm run build -- -- -p https://521github.com/apache/echarts-doc\n\n# 如果依赖安装速度较慢，可以考虑使用 cnpm\nnpm run build -- -- --cnpm\n# 等价于：\nnpm run build -- -- -c\n\n# 开启一个 HTTP Server 查看离线文档\nnpm start\n# 等价于：\nnpm run serve\n\n# 也可以不用开启 HTTP Server，直接打开来查看离线文档\nnpm run local\n```\n\n## 从 GitHub Pages 下载离线文档\n\n如果不想麻烦去安装或者手动构建，可以直接从 [**gh-pages**](https://github.com/plainheart/echarts-offline-doc-cli/archive/gh-pages.zip) 分支下载定期自动生成和更新的 zip 压缩包，解压后打开根目录下的 `index.html` 即可。\n\n# License\n\nMIT \u0026copy; 2021-2024 [plainheart](https://github.com/plainheart).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplainheart%2Fecharts-offline-doc-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplainheart%2Fecharts-offline-doc-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplainheart%2Fecharts-offline-doc-cli/lists"}