最近在学习 FastAPI,经常需要查阅文档,但是文档每个页面加载都需要1-2秒时间,有时甚至会出现加载失败的情况,因此决定想办法吧文档部署到本地。
经过我分析发现,文档的 markdown 文件位于仓库 https://github.com/fastapi/fastapi 的 目录,同时 目录存放了各国语言的翻译版本, 则是对应编译文档的脚本,编译后的 HTML 文档位于 目录下。
首先 clone 项目到本地:
然后需要安装项目依赖,我使用的是 :
接下来就可以编译了:
编译后会发现项目中出现了一个 目录,这是静态 HTML 了,此时可以通过下面命令启动一个服务来查看文档:
然后在浏览器中访问 就可以看到文档了。
其实当你拿到 site 目录之后,你可以把它部署到任何静态文件服务器上,比如 nginx、caddy、或者前端 http-server 包等。