使用docc预览Swift文档时遇命令缺失及HTML模板目录错误
解决
docc preview预览Swift Book文档的问题 第一步:确保docc可全局调用
将克隆构建后的docC二进制文件复制到全局可访问路径(如/usr/local/bin):
cp /Users/johnekoreh/Desktop/swift-docc/.build/arm64-apple-macosx/release/docc /usr/local/bin/
验证命令是否生效:
docc --version
第二步:指定HTML模板目录
直接通过环境变量指定docC构建生成的模板路径,再运行预览命令:
DOCC_HTML_DIR=/Users/johnekoreh/Desktop/swift-docc/.build/arm64-apple-macosx/share/docc/render docc preview FILE.docc
若想避免每次输入环境变量,可将其写入shell配置文件(如~/.zshrc):
echo 'export DOCC_HTML_DIR="/Users/johnekoreh/Desktop/swift-docc/.build/arm64-apple-macosx/share/docc/render"' >> ~/.zshrc source ~/.zshrc
之后直接执行预览命令即可:
docc preview FILE.docc
补充说明
由于swift-book并非Swift包,无法通过swift run build构建,按上述方式指定模板路径后,即可正常启动本地文档预览。
内容的提问来源于stack exchange,提问作者Ekoreh
相关产品推荐
相关产品推荐

