1 Star 0 Fork 0

plainheart / echarts-offline-doc-cli

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

echarts-offline-doc-cli

NPM version Auto Deploy NPM Downloads License

Apache ECharts 中文离线文档生成工具

GitHub Pages 预览

示例

开始使用

全局安装

npm i echarts-offline-doc-cli -g

生成离线文档

echarts-offline-doc --build
# 等价于:
echarts-offline-doc -b

# 如果拉取代码速度较慢,可以指定一个快速的代理镜像地址
echarts-offline-doc --build --proxy https://hub.fgit.cf/apache/echarts-doc
# 等价于:
echarts-offline-doc -b -p https://hub.fgit.cf/apache/echarts-doc

# 如果依赖安装速度较慢,可以考虑使用 cnpm
echarts-offline-doc --build --cnpm
# 等价于:
echarts-offline-doc -b -c

# 查看帮助信息
echarts-offline-doc --help
# 等价于:
echarts-offline-doc -h

使用 HTTP Server 查看离线文档

echarts-offline-doc
# 等价于:
echarts-offline-doc --serve
# 等价于:
echarts-offline-doc -s

本地查看离线文档

echarts-offline-doc --local
# 等价于:
echarts-offline-doc -l

从源码构建

# 拉取本项目代码仓库
git clone https://github.com/plainheart/echarts-offline-doc-cli --depth=1

# 安装依赖
npm i

# 构建离线文档
npm run build

# 如果拉取代码速度较慢,可以指定一个快速的代理镜像地址
npm run build -- -- --proxy https://hub.fgit.cf/apache/echarts-doc
# 等价于:
npm run build -- -- -p https://hub.fgit.cf/apache/echarts-doc

# 如果依赖安装速度较慢,可以考虑使用 cnpm
npm run build -- -- --cnpm
# 等价于:
npm run build -- -- -c

# 开启一个 HTTP Server 查看离线文档
npm start
# 等价于:
npm run serve

# 也可以不用开启 HTTP Server,直接打开来查看离线文档
npm run local

从 GitHub Pages 下载离线文档

如果不想麻烦去安装或者手动构建,可以直接从 gh-pages 分支下载定期自动生成和更新的 zip 压缩包,解压后打开根目录下的 index.html 即可。

License

MIT © 2021-2023 plainheart.

MIT License Copyright (c) 2021-2023 Zhongxiang.Wang Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

Apache ECharts 中文离线文档生成工具 展开 收起
JavaScript 等 2 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/plainheart/echarts-offline-doc-cli.git
git@gitee.com:plainheart/echarts-offline-doc-cli.git
plainheart
echarts-offline-doc-cli
echarts-offline-doc-cli
main

搜索帮助