使用dbt docs generate生成文档时如何覆盖默认概览页为自定义内容
dbt自定义文档站点概览页实现方案
该需求可以完全实现,操作方法如下:
- 在dbt项目根目录新建或编辑
README.md文件,所有你想放在概览页的自定义内容都可以写在这个文件中,支持标准Markdown的全部语法规则。 - 打开项目根目录的
dbt_project.yml文件,确认项目配置正常即可,无需额外特殊配置,如果你需要关闭整个项目的文档展示可以调整docs.show参数为false,默认保持true即可。 - 重新执行
dbt docs generate命令,新生成的文档站点默认概览页会自动替换为README.md的内容,原有默认的概览内容会被完全覆盖。
如果你需要针对单个模型、数据源的详情页做自定义内容补充,可以在对应模型目录下编写同名.md文件并在schema.yml中做关联配置,内容也会自动同步到生成的文档站点中。
内容的提问来源于stack exchange,提问作者user961
相关产品推荐
相关产品推荐

